From 3941e5f4ea1761074b2c95c78867dc623ed6a754 Mon Sep 17 00:00:00 2001 From: Johannes <57864468+JohannesGandhi@users.noreply.github.com> Date: Thu, 29 Feb 2024 20:37:21 +0100 Subject: [PATCH] =?UTF-8?q?readme:=20explain=20differences=20in=20realtime?= =?UTF-8?q?=20data=20between=20DB=20app=20and=20db-rest=20=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Jannis R --- docs/readme.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index daf37f6..e3cd56c 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -4,17 +4,21 @@ [![API status](https://badgen.net/uptime-robot/status/m793274556-25c5e9bbab0297d91cda7134)](https://stats.uptimerobot.com/57wNLs39M/793274556) -Because it wraps [an API](https://github.com/public-transport/hafas-client/blob/6/readme.md#background) of [Deutsche Bahn](https://de.wikipedia.org/wiki/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](https://www.bahn.de/p/view/service/mobile/db-navigator.shtml) shows, **including realtime delays and disruptions**. +Because it wraps [an API](https://github.com/public-transport/hafas-client/blob/6/readme.md#background) of [Deutsche Bahn](https://de.wikipedia.org/wiki/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](https://www.bahn.de/p/view/service/mobile/db-navigator.shtml) 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.* - [Getting Started](getting-started.md) -- [API documentation](api.md) -- [OpenAPI playground](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.db.transport.rest%2F.well-known%2Fservice-desc%0A) +- [API documentation](api.md) (run `npm run build` to generate) +- [OpenAPI playground with API documentation](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.db.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 DB's mobile app](https://github.com/public-transport/hafas-client/blob/6/p/db/readme.md), provides it. +This API returns realtime data whenever it is upstream. The [API for DB's mobile app](https://github.com/public-transport/hafas-client/blob/6/p/db/readme.md) 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