mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-23 15:19:35 +02:00
54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
# db-vendo-client
|
||
|
||
**A client for the new "vendo" bahn.de APIs, a drop-in replacement for [hafas-client](https://github.com/public-transport/hafas-client/).**
|
||
|
||
|
||
[](https://github.com/sponsors/derhuerst)
|
||
|
||
This is a very early version. What works:
|
||
|
||
* `journeys()`, `refreshJourney()` including prices
|
||
* `locations()`, `nearby()`
|
||
* `departures()`, `arrivals()` boards
|
||
|
||
What doesn't work (yet, see TODO's scattered around the code):
|
||
|
||
* `journeys()` details like scheduledDays, stop/station groups, some line details ...
|
||
* `journeys()` uses different tripIds compared to departure and arrival boards...
|
||
* certain stop details like products for `locations()` and geopositions and remarks for boards
|
||
* some query options/filters (e.g. direction for boards)
|
||
* all other endpoints
|
||
|
||
Feel free to report anything that you stumble upon via Issues or create a PR :)
|
||
|
||
Also consult the relevant **[documentation](https://github.com/public-transport/hafas-client/blob/main/docs/readme.md)** of [hafas-client](https://github.com/public-transport/hafas-client/) (but beware of the limited functionality of db-vendo-client).
|
||
|
||
|
||
## Background
|
||
|
||
After DB has switched to the new "vendo" platform for bahn.de and DB Navigator, the old [HAFAS](https://de.wikipedia.org/wiki/HAFAS) API (see [hafas-client](https://github.com/public-transport/hafas-client/)) seems to become less and less reliable (server unreachable, missing prices, etc.) This project aims to enable easy switching to the new APIs. However, not all information will be available from the new APIs.
|
||
|
||
Actually, db-vendo-client is a wrapper around multiple different APIs, currently the bahn.de API for route planning and the regio-guide RIS API for boards. See some [notes about the various new APIs at DB](docs/db-apis.md).
|
||
|
||
Strictly speaking, permission is necessary to use this library with the DB APIs.
|
||
|
||
## Usage
|
||
|
||
See an example in [api.js](api.js). It shows how you can use `db-vendo-client` together with `hafas-rest-api` in order to run a [FPTF](https://github.com/public-transport/friendly-public-transport-format) API server. The [Dockerfile](Dockerfile) serves this API.
|
||
|
||
There are [community-maintained TypeScript typings available as `@types/hafas-client`](https://www.npmjs.com/package/@types/hafas-client).
|
||
|
||
## Related Projects
|
||
|
||
- [hafas-client](https://github.com/public-transport/hafas-client/) – including further related projects
|
||
- [hafas-rest-api](https://github.com/public-transport/hafas-rest-api/) – expose a hafas-client or db-vendo-client instance as a REST API
|
||
- [db-rest](https://github.com/derhuerst/db-rest/) – for the legacy DB HAFAS endpoint
|
||
- [`*.transport.rest`](https://transport.rest/) – Public APIs wrapping some HAFAS endpoints.
|
||
|
||
## Contributing
|
||
|
||
If you **have a question**, **found a bug** or want to **propose a feature**, please [open an Issue](https://github.com/public-transport/db-vendo-client/issues).
|
||
|
||
This project needs help! Check the [list of "help wanted" Issues](https://github.com/public-transport/db-vendo-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
|
||
|
||
If you're contributing code, please read the [contribution guidelines](contributing.md).
|