v5.bvg.transport.rest
API documentation๐v5.bvg.transport.rest
is a REST API. Data is being returned as JSON.
You can just use the API without authentication. There's a rate limit of 100 request/minute (burst 200 requests/minute) set up.
Note: The examples snippets in this documentation uses the url-encode
CLI tool of the url-decode-encode-cli
package for URL-encoding.
Note: These routes only wrap hafas-client@5
methods, check their docs for more details.
GET /stops/nearby
GET /stops/reachable-from
GET /stops/:id
GET /stops/:id/departures
GET /stops/:id/arrivals
GET /journeys
GET /trips/:id
GET /locations
GET /radar
GET /journeys/:ref
GET /stops
GET /locations
๐Uses hafasClient.locations()
to find stops/stations, POIs and addresses matching query
.
parameter | description | type | default value |
---|---|---|---|
query | Required. | string | โ |
fuzzy | Find more than exact matches? | boolean | true |
results | How many stations shall be shown? | integer | 10 |
stops | Show stops/stations? | boolean | true |
addresses | Show points of interest? | boolean | true |
poi | Show addresses? | boolean | true |
linesOfStops | Parse & return lines of each stop/station? | boolean | false |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
curl 'https://v5.bvg.transport.rest/locations?query=alexanderplatz&results=1' -s | jq
[
{
"type": "stop",
"id": "900000100003",
"name": "S+U Alexanderplatz",
"location": {
"type": "location",
"id": "900100003",
"latitude": 52.521508,
"longitude": 13.411267
},
"products": {
"suburban": true,
"subway": false,
"tram": false,
// โฆ
}
}
]
GET /stops
๐Uses vbb-stations-autocomplete@4
to find stops/stations matching query
. If you don't pass query
, it will just return all stops from vbb-stations@7
.
parameter | description | type | default value |
---|---|---|---|
query | Filter by name, e.g. mehringd with completion=true , or mehringdamm with completion=false . | string | โ |
results | How many stops/stations? | number | 5 |
fuzzy | Find other than exact matches? | boolean | false |
completion | Search by prefix? | boolean | true |
todo
GET /stops/nearby
๐Uses hafasClient.nearby()
to find stops/stations close to the given geolocation.
parameter | description | type | default value |
---|---|---|---|
latitude | Required. | number | โ |
longitude | Required. | number | โ |
results | maximum number of results | integer | 8 |
distance | maximum walking distance in meters | integer | โ |
stops | Return stops/stations? | boolean | true |
poi | Return points of interest? | boolean | false |
linesOfStops | Parse & expose lines at each stop/station? | boolean | false |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
curl 'https://v5.bvg.transport.rest/stops/nearby?latitude=52.52725&longitude=13.4123' -s | jq
[
{
"type": "stop",
"id": "900000100016",
"name": "U Rosa-Luxemburg-Platz",
"location": {
"type": "location",
"id": "900100016",
"latitude": 52.528187,
"longitude": 13.410405
},
"products": { /* โฆ */ },
"distance": 165
},
// โฆ
{
"type": "stop",
"id": "900000110005",
"name": "U Senefelderplatz",
"location": { /* โฆ */ },
"products": { /* โฆ */ },
"distance": 597
},
// โฆ
]
GET /stops/reachable-from
๐Uses hafasClient.reachableFrom()
to find stops/stations reachable within a certain time from an address.
parameter | description | type | default value |
---|---|---|---|
latitude | Required. | number | โ |
longitude | Required. | number | โ |
address | Required. | string | โ |
when | Date & time to compute the reachability for. See date/time parameters. | date+time | now |
maxTransfers | Maximum number of transfers. | integer | 5 |
maxDuration | Maximum travel duration, in minutes. | integer | infinite |
language | Language of the results. | string | en |
suburban | Include S-Bahn (S)? | boolean | true |
subway | Include U-Bahn (U)? | boolean | true |
tram | Include Tram (T)? | boolean | true |
bus | Include Bus (B)? | boolean | true |
ferry | Include Fรคhre (F)? | boolean | true |
express | Include IC/ICE (E)? | boolean | true |
regional | Include RB/RE (R)? | boolean | true |
pretty | Pretty-print JSON responses? | boolean | true |
curl 'https://v5.bvg.transport.rest/stops/reachable-from?latitude=52.52446&longitude=13.40812&address=10178+Berlin-Mitte,+Mรผnzstr.+12' -s | jq
[
{
"duration": 4,
"stations": [
{
"type": "stop",
"id": "900000100051",
"name": "U Weinmeisterstr.",
"location": { /* โฆ */ },
"products": { /* โฆ */ },
}
]
},
// โฆ
{
"duration": 7,
"stations": [
{
"type": "stop",
"id": "900000007110",
"name": "U Bernauer Str.",
"location": { /* โฆ */ },
"products": { /* โฆ */ }
},
{
"type": "stop",
"id": "900000100004",
"name": "S+U Jannowitzbrรผcke",
"location": { /* โฆ */ },
"products": { /* โฆ */ }
},
// โฆ
]
},
// โฆ
]
GET /stops/:id
๐Uses hafasClient.stop()
to find a stop/station by ID.
parameter | description | type | default value |
---|---|---|---|
linesOfStops | Parse & expose lines at each stop/station? | boolean | false |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
curl 'https://v5.bvg.transport.rest/stops/900000017101' -s | jq
{
"type": "stop",
"id": "900000017101",
"name": "U Mehringdamm",
"location": {
"type": "location",
"id": "900017101",
"latitude": 52.49357,
"longitude": 13.388138
},
"products": { /* โฆ */ },
}
GET /stops/:id/departures
๐Uses hafasClient.departures()
to get departures at a stop/station.
parameter | description | type | default value |
---|---|---|---|
when | Date & time to get departures for. See date/time parameters. | date+time | now |
direction | Filter departures by direction. | string | ย |
duration | Show departures for how many minutes? | integer | 10 |
results | Max. number of departures. | integer | *whatever HAFAS wants |
linesOfStops | Parse & return lines of each stop/station? | boolean | false |
remarks | Parse & return hints & warnings? | boolean | true |
language | Language of the results. | string | en |
suburban | Include S-Bahn (S)? | boolean | true |
subway | Include U-Bahn (U)? | boolean | true |
tram | Include Tram (T)? | boolean | true |
bus | Include Bus (B)? | boolean | true |
ferry | Include Fรคhre (F)? | boolean | true |
express | Include IC/ICE (E)? | boolean | true |
regional | Include RB/RE (R)? | boolean | true |
pretty | Pretty-print JSON responses? | boolean | true |
# at U Kottbusser Tor, in direction U Gรถrlitzer Bahnhof
curl 'https://v5.bvg.transport.rest/stops/900000013102/departures?direction=900000014101&duration=10' -s | jq
[
{
"tripId": "1|61154|54|86|29042020",
"direction": "Ersatz S+U Warschauer Str.",
"line": {
"type": "line",
"id": "u1",
"name": "U1",
"mode": "bus",
"product": "bus",
// โฆ
},
"when": "2020-04-29T19:31:00+02:00",
"plannedWhen": "2020-04-29T19:30:00+02:00",
"delay": 60,
"platform": null,
"plannedPlatform": null,
"stop": {
"type": "stop",
"id": "900000013102",
"name": "U Kottbusser Tor",
"location": { /* โฆ */ },
"products": { /* โฆ */ },
// โฆ
},
"remarks": [ /* โฆ */ ],
},
// โฆ
]
GET /stops/:id/arrivals
๐Works like /stops/:id/departures
, except that it uses hafasClient.arrivals()
to arrivals at a stop/station.
parameter | description | type | default value |
---|---|---|---|
when | Date & time to get departures for. See date/time parameters. | date+time | now |
direction | Filter departures by direction. | string | ย |
duration | Show departures for how many minutes? | integer | 10 |
results | Max. number of departures. | integer | whatever HAFAS wants |
linesOfStops | Parse & return lines of each stop/station? | boolean | false |
remarks | Parse & return hints & warnings? | boolean | true |
language | Language of the results. | string | en |
suburban | Include S-Bahn (S)? | boolean | true |
subway | Include U-Bahn (U)? | boolean | true |
tram | Include Tram (T)? | boolean | true |
bus | Include Bus (B)? | boolean | true |
ferry | Include Fรคhre (F)? | boolean | true |
express | Include IC/ICE (E)? | boolean | true |
regional | Include RB/RE (R)? | boolean | true |
pretty | Pretty-print JSON responses? | boolean | true |
# at U Kottbusser Tor, 10 minutes
curl 'https://v5.bvg.transport.rest/stops/900000013102/arrivals?duration=10' -s | jq
GET /journeys
๐Uses hafasClient.journeys()
to find journeys from A (from
) to B (to
).
from
(A), to
(B), and the optional via
must each have one of these formats:
from=900000017101
for U Mehringdamm)from.id=900980720&from.latitude=52.54333&from.longitude=13.35167
for ATZE Musiktheater)from.latitude=52.543333&from.longitude=13.351686&from.address=Voltastr.+17
for Voltastr. 17)Given a response, you can also fetch more journeys matching the same criteria. Instead of from*
, to*
& departure
/arrival
, pass earlierRef
from the first response as earlierThan
to get journeys "before", or laterRef
as laterThan
to get journeys "after".
Check the hafasClient.journeys()
docs for more details.
parameter | description | type | default value |
---|---|---|---|
departure | Compute journeys departing at this date/time. Mutually exclusive with arrival . See date/time parameters. | date+time | now |
arrival | Compute journeys arriving at this date/time. Mutually exclusive with departure . See date/time parameters. | date+time | now |
earlierThan | Compute journeys "before" an ealierRef . | string | ย |
laterThan | Compute journeys "after" an laterRef . | string | ย |
results | Max. number of journeys. | integer | 3 |
stopovers | Fetch & parse stopovers on the way? | boolean | false |
transfers | Maximum number of transfers. | integer | let HAFAS decide |
transferTime | Minimum time in minutes for a single transfer. | integer | 0 |
accessibility | partial or complete . | string | not accessible |
bike | Compute only bike-friendly journeys? | boolean | false |
startWithWalking | Consider walking to nearby stations at the beginning of a journey? | boolean | true |
walkingSpeed | slow , normal or fast . | string | normal |
tickets | Return information about available tickets? | boolean | false |
polylines | Fetch & parse a shape for each journey leg? | boolean | false |
remarks | Parse & return hints & warnings? | boolean | true |
scheduledDays | Parse & return dates each journey is valid on? | boolean | false |
language | Language of the results. | string | en |
suburban | Include S-Bahn (S)? | boolean | true |
subway | Include U-Bahn (U)? | boolean | true |
tram | Include Tram (T)? | boolean | true |
bus | Include Bus (B)? | boolean | true |
ferry | Include Fรคhre (F)? | boolean | true |
express | Include IC/ICE (E)? | boolean | true |
regional | Include RB/RE (R)? | boolean | true |
pretty | Pretty-print JSON responses? | boolean | true |
# stop/station to POI
curl 'https://v5.bvg.transport.rest/journeys?from=900000023201&to.id=900980720&to.name=ATZE+Musiktheater&to.latitude=52.54333&to.longitude=13.35167' -s | jq
# without buses, with ticket info
curl 'https://v5.bvg.transport.rest/journeys?from=โฆ&to=โฆ&bus=false&tickets=true' -s | jq
GET /journeys/:ref
๐Uses hafasClient.refreshJourney()
to "refresh" a journey, using its refreshToken
.
The journey will be the same (equal from
, to
, via
, date/time & vehicles used), but you can get up-to-date realtime data, like delays & cancellations.
parameter | description | type | default value |
---|---|---|---|
stopovers | Fetch & parse stopovers on the way? | boolean | false |
tickets | Return information about available tickets? | boolean | false |
polylines | Fetch & parse a shape for each journey leg? | boolean | false |
remarks | Parse & return hints & warnings? | boolean | true |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
# get the refreshToken of a journey
journey=$(curl 'https://v5.bvg.transport.rest/journeys?from=โฆ&to=โฆ&results=1' -s | jq '.journeys[0]')
refresh_token=$(echo $journey | jq -r '.refreshToken')
# refresh the journey
curl "https://v5.bvg.transport.rest/journeys/$(echo $refresh_token | url-encode)" -s | jq
GET /trips/:id
๐Uses hafasClient.trip()
to fetch a trip by ID.
A trip is a specific vehicle, stopping at a series of stops at specific points in time. Departures, arrivals & journey legs reference trips by their ID.
parameter | description | type | default value |
---|---|---|---|
lineName | Required. Line name of the part's mode of transport, e.g. RE7 . | string | โ |
stopovers | Fetch & parse stopovers on the way? | boolean | true |
remarks | Parse & return hints & warnings? | boolean | true |
polyline | Fetch & parse the geographic shape of the trip? | boolean | false |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
# get the trip ID of a journey leg
journey=$(curl 'https://v5.bvg.transport.rest/journeys?from=โฆ&to=โฆ&results=1' -s | jq '.journeys[0]')
journey_leg=$(echo $journey | jq -r '.legs[0]')
trip_id=$(echo $journey_leg | jq -r '.tripId')
# fetch the trip
curl "https://v5.bvg.transport.rest/trips/$(echo $trip_id | url-encode)" -s | jq
GET /radar
๐Uses hafasClient.radar()
to find all vehicles currently in an area, as well as their movements.
parameter | description | type | default value |
---|---|---|---|
north | Required. Northern latitude. | number | โ |
west | Required. Western longitude. | number | โ |
south | Required. Southern latitude. | number | โ |
east | Required. Eastern longitude. | number | โ |
results | Max. number of vehicles. | integer | 256 |
duration | Compute frames for the next n seconds. | integer | 30 |
frames | Number of frames to compute. | integer | 3 |
polylines | Fetch & parse a geographic shape for the movement of each vehicle? | boolean | true |
language | Language of the results. | string | en |
pretty | Pretty-print JSON responses? | boolean | true |
bbox='north=52.52411&west=13.41002&south=52.51942&east=13.41709'
curl "https://v5.bvg.transport.rest/radar?$bbox&results=10" -s | jq
Possible formats:
parse-human-relative-time
can parse (e.g. tomorrow 2pm
)2020-04-26T22:43+02:00
)1587933780
)