Skip to content

index.md

Latest commit

 

History

History
344 lines (227 loc) · 12.1 KB

index.md

File metadata and controls

344 lines (227 loc) · 12.1 KB

Berlin & Brandenburg Public Transport API

Deprecated. Please use the latest version of this API.

The public endpoint is 3.vbb.transport.rest. This API returns data in the Friendly Public Transport Format 1.2.1. Use vbb-client@3 to talk to this API from JavaScript.

all routes

GET /stops?query=…

Passes all parameters into vbb-stations-autocomplete.

  • query: Required.
  • completion: true/false – Default is true
  • fuzzy: true/false – Default is false

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/stops?query=jungfernheide'
# note the typo
curl 'https://3.vbb.transport.rest/stops?query=mehrigndamm&fuzzy=true'

GET /stops

Passes all parameters into vbb-stations.

  • id: Filter by ID.
  • name: Filter by name.
  • coordinates.latitude: Filter by latitude.
  • coordinates.longitude: Filter by longitude.
  • weight: Filter by weight.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/stops?weight=60'

GET /stops/all

Dumps full.json from vbb-stations.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/stops/all'

GET /stops/nearby

Output from hafas.nearby(…).

  • latitude: Required.
  • longitude: Required.
  • results: How many stops/stations shall be shown? Default: 8.
  • distance: Maximum distance in meters. Default: null.
  • stops: Show stops/stations around. Default: true.
  • poi: Show points of interest around. Default: false.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/stops/nearby?latitude=52.52725&longitude=13.4123'

GET /stops/:id

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/stops/900000013102'

GET /stops/:id/departures

Returns departures at a stop/station. Output from require('vbb-hafas').departures(…).

Note: As stated in the Friendly Public Transport Format 1.2.1, the returned departure and arrival times include the current delay.

  • when: A UNIX timestamp or anything parsable by parse-messy-time. Default: now.
  • direction: Stop/station ID with a direction. Default: null.
  • duration: Show departures for the next n minutes. Default: 10.

Content-Type: application/json

examples

# at U Kottbusser Tor, in direction U Görlitzer Bahnhof
curl 'https://3.vbb.transport.rest/stops/900000013102/departures?direction=900000014101'
# at U Kottbusser Tor, without direction
curl 'https://3.vbb.transport.rest/stops/900000013102/departures?when=tomorrow%206pm&results=3'

GET /lines

Passes all parameters into vbb-lines:

Content-Type: application/x-ndjson

examples

curl 'https://3.vbb.transport.rest/lines?operator=796&variants=true'

GET /lines/:id

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/lines/531'

GET /shapes/:id

Content-Type: application/json

Output from require('vbb-shapes')(id).

examples

curl 'https://3.vbb.transport.rest/shapes/1269'

GET /journeys

Output from require('vbb-hafas').journeys(…). Start location and end location must be either in stop format or in POI/address format (you can mix them).

Note: As stated in the Friendly Public Transport Format 1.2.1, the returned departure and arrival times include the current delay.

stop format

  • from: Required. stop/station ID (e.g. 900000023201).
  • to: Required. stop/station ID (e.g. 900000023201).

POI format

  • from.latitude/to.latitude: Required. Latitude (e.g. 52.543333).
  • from.longitude/to.longitude: Required. Longitude (e.g. 13.351686).
  • from.name/to.name: Name of the locality (e.g. Atze Musiktheater).
  • from.id/to.id: Required. POI ID (e.g. 9980720).

address format

  • from.latitude/to.latitude: Required. Latitude (e.g. 52.543333).
  • from.longitude/to.longitude: Required. Longitude (e.g. 13.351686).
  • from.address/to.address: Required. Address (e.g. Voltastr. 17).

other parameters

  • arrival: A UNIX timestamp or anything parsable by parse-messy-time. Default: now.

  • departure: A UNIX timestamp or anything parsable by parse-messy-time. Default: now.

  • results: Maximum number of results. Default: 5.

  • via: stop/station ID. Default: null.

  • passedStations: Return stops/stations on the way? Default: false.

  • transfers: Maximum number of transfers. Default: 5.

  • transferTime: Minimum time in minutes for a single transfer. Default: 0.

  • accessibility: Possible values: partial, complete. Default: none.

  • bike: Return only bike-friendly journeys. Default: false.

  • tickets: Return information about available tickets. Default: false.

  • transferInfo: Try to add transfer information from vbb-change-positions to journey legs? more details Default: false.

  • suburban: Include S-Bahn trains? Default: true.

  • subway: Include U-Bahn trains? Default: true.

  • tram: Include trams? Default: true.

  • bus: Include buses? Default: true.

  • ferry: Include ferries? Default: true.

  • express: Include IC/ICE/EC trains? Default: true.

  • regional: Include RE/RB/ODEG trains? Default: true.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/journeys?from=900000017104&to=900000017101'
curl 'https://3.vbb.transport.rest/journeys?from=900000023201&to.id=900980720&to.name=ATZE%20Musiktheater&to.latitude=52.543333&to.longitude=13.351686'
curl 'https://3.vbb.transport.rest/journeys?from=900000023201&to.latitude=52.540673&to.longitude=13.386673&to.address=13355%20Berlin-Gesundbrunnen%2C%20Voltastr.%2017%22'
curl 'https://3.vbb.transport.rest/journeys?from=…&to=…&results=3&bus=false&tickets=true'

GET /trips/:id

Output from require('hafas-client').trip(…).

  • lineName: Required. Line name of the part's mode of transport, e.g. RE7.
  • when: A UNIX timestamp or anything parsable by parse-messy-time. Default: now.

Content-Type: application/json

examples

# This won't work, get a new trip ID from a journey leg first.
curl 'https://3.vbb.transport.rest/trips/1|32082|1|86|26062017?lineName=RE7'

GET /trips/:id

Output from hafas.trip(…).

  • lineName: Required. Line name of the part's mode of transport, e.g. RE7.
  • stopovers: Return stations on the way? Default: true.
  • remarks: Parse & expose hints & warnings? Default: true.
  • polyline: Return a shape for the trip? Default: false.
  • language: Language of the results. Default: en.

Content-Type: application/json

examples

curl 'https://your-api-endpoint/trips/1|32082|1|86|26062017?lineName=RE7'

GET /locations

Output from require('hafas-client').locations(…).

  • query: Required. (e.g. Alexanderplatz)
  • results: How many stops/stations shall be shown? Default: 10.
  • stops: Show stops/stations? Default: true.
  • poi: Show points of interest? Default: true.
  • addresses: Show addresses? Default: true.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/locations?query=Alexanderplatz'
curl 'https://3.vbb.transport.rest/locations?query=Pestalozzistra%C3%9Fe%2082%2C%20Berlin&poi=false&stops=false'

GET /radar

Output from hafas.radar(…).

  • north: Required. Northern latitude.
  • west: Required. Western longtidue.
  • south: Required. Southern latitude.
  • east: Required. Eastern longtidue.
  • results: How many vehicles shall be shown? Default: 256.
  • duration: Compute frames for how many seconds? Default: 30.
  • frames: Number of frames to compute. Default: 3.

Content-Type: application/json

examples

curl 'https://3.vbb.transport.rest/radar?north=52.52411&west=13.41002&south=52.51942&east=13.41709'

GET /maps/:type

Redirects to PDF public transport maps. type may be one of these:

type Description
bvg Day, Berlin ABC, S-Bahn & U-Bahn
bvg-tram Day & Night, Berlin ABC, Trams
bvg-night Night, Berlin ABC, S-Bahn & U-Bahn
bvg-refugees Day, Berlin-ABC, S-Bahn & U-Bahn, Translations
vbb Day, Berlin & Brandenburg, RE & RB trains
brb Day, Brandenburg an der Havel
cb Day & Night, Cottbus
cb-night Night, Cottbus
ff Day, Frankfurt Oder
p Day, Potsdam
p-night Night, Potsdam

examples

curl -L -o bvg-tram-map.pdf 'https://3.vbb.transport.rest/maps/bvg-tram'

GET /logos/:type

Serves the logos from derhuers/vbb-logos#v2.

examples

curl -L -o tram.svg 'https://3.vbb.transport.rest/logos/tram.svg'
⚡