QuavernQuavsit

Documentation

Reference for the Quavsit API: authentication, networks, every endpoint, streams, itineraries, errors, limits and data licences.

Base URL: https://api.quavern.net/v1

  1. 01Getting startedQuavsit is a read-only HTTP API for French public transport: lines, stops, next departures, vehicle positions, service alerts, places and journeys, for several networks behind one data model. Every answer says whether it is realtime or sche
  2. 02AuthenticationEvery request except GET /health and GET /status carries a personal key in the Authorization header.
  3. 03NetworksQuavsit launches with eight French networks. Each is exposed under a short slug that prefixes every identifier of that network. What is realtime, what is scheduled, and what is missing depends on what the operator publishes; the table below
  4. 04ConceptsThis page defines the words used everywhere else: identifiers, stops versus areas, freshness, units, the response envelope, and time handling.
  5. 05EndpointsBase URL https://api.quavern.net/v1. All routes are GET. JSON examples are illustrative: ids, names and times are plausible, not live data. Each route costs 1 unit unless stated otherwise.
  6. 06StreamsTwo endpoints push updates over server-sent events (SSE) instead of being polled: departures at a stop and vehicles on a line. Streams need a plan with the streams entitlement (every paid plan, including Pay as you go); on Free they answer
  7. 07JourneysGET /journeys returns up to six itineraries between two points. It costs 5 units per call and results are cached for 60 seconds for identical queries.
  8. 08Places/places is the search box behind the web app: one query, stops and addresses in one list. It is also how /journeys resolves free text.
  9. 09ErrorsEvery error is {"error": {"code", "reason", "message", "details"?}} with the real HTTP status. reason is the stable slug to branch on; code (QVST1-3404 style) is the support reference to quote; message is English text for humans and may cha
  10. 10Limits and pricingQuavsit is metered in units. Plans differ in the units included each month, the number of requests allowed per minute, the number of keys, access to streams and the price of extra units.
  11. 11Data licencesQuavsit redistributes open data published by the operators and transport authorities named below. Their licences apply to what you build with the API. Every response carries the applicable credits in meta.attribution; display them wherever
  12. 12ChangelogChanges to the API contract are listed here. Additions are backwards compatible; removals are announced at least 90 days ahead and appear here first.