https://github.com/derhuerst/bvg-rest

An HTTP API for Berlin & Brandenburg public transport.
https://github.com/derhuerst/bvg-rest

api berlin bvg public-transport

Last synced: 3 days ago
JSON representation

An HTTP API for Berlin & Brandenburg public transport.

• Host: GitHub
• URL: https://github.com/derhuerst/bvg-rest
• Owner: derhuerst
• License: isc
• Created: 2018-08-01T21:35:56.000Z (over 6 years ago)
• Default Branch: 6
• Last Pushed: 2024-11-16T01:28:23.000Z (about 2 months ago)
• Last Synced: 2024-12-24T03:08:38.736Z (10 days ago)
• Topics: api, berlin, bvg, public-transport
• Language: JavaScript
• Homepage: https://v6.bvg.transport.rest/
• Size: 160 KB
• Stars: 88
• Watchers: 5
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: docs/readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# `v6.bvg.transport.rest` documentation

[`v6.bvg.transport.rest`](https://v6.bvg.transport.rest/) is a [REST API](https://restfulapi.net) for the [Berlin](https://en.wikipedia.org/wiki/Berlin) public transportation system, [BVG](https://en.wikipedia.org/wiki/Berliner_Verkehrsbetriebe).

[![API status](https://badgen.net/uptime-robot/status/m793274554-6cf10d741ce5352cc2a6d65f)](https://stats.uptimerobot.com/57wNLs39M/793274554)

Because it wraps [a BVG API](https://github.com/public-transport/hafas-client/blob/6/readme.md#background) of BVG, it **includes all local traffic of Berlin & Brandenburg, as well as some long-distance trains running in the area**. Essentially, it returns whatever data the [BVG app](https://www.bvg.de/en/tickets-tariffs/all-apps/fahrinfo-app) shows, **including realtime delays and disruptions**.

- [Getting Started](getting-started.md)

- [API documentation](api.md)

- [OpenAPI playground](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.bvg.transport.rest%2F.well-known%2Fservice-desc%0A)

## Why use this API?

### Realtime Data

This API returns realtime data whenever its upstream, the [API for BVG's mobile app](https://github.com/public-transport/hafas-client/blob/33d7d30acf235c54887c6459a15fe581982c6a19/p/bvg/readme.md), provides it.

### No API Key

You can just use the API without authentication. There's a [rate limit](https://apisyouwonthate.com/blog/what-is-api-rate-limiting-all-about) of 100 requests/minute set up.

### CORS

This API has [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) enabled, so you can query it from any webpage.

### Caching-friendly

This API sends [`ETag`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) & [`Cache-Control`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) headers, allowing clients cache responses properly.