db-rest/docs/readme.md
Johannes 3941e5f4ea
readme: explain differences in realtime data between DB app and db-rest 📝
Co-Authored-By: Jannis R <mail@jannisr.de>
2024-03-19 13:41:27 +01:00

2.1 KiB

v6.db.transport.rest documentation

v6.db.transport.rest is a REST API for the public transportation system in Germany.

API status

Because it wraps an API of Deutsche Bahn, it includes most of the long-distance and regional traffic, as well as some international trains and local buses. Essentially, it returns whatever data the DB Navigator app shows*, including realtime delays and disruptions.

When comparing results from this API to what the DB Navigator app shows there might be occasional differences due to them utilizing different, not 100% identical backends.

Why use this API?

Realtime Data

This API returns realtime data whenever it is upstream. The API for DB's mobile app provides it.

Note: Different endpoints might remove realtime data like delays and cancellations at different times, i.e. after a journey's arrival.

No API Key

You can just use the API without authentication. There's a rate limit of 100 requests/minute set up.

CORS

This API has CORS enabled, so you can query it from any webpage.

Caching-friendly

This API sends ETag & Cache-Control headers, allowing clients cache responses properly.