db-vendo-client/readme.md

db-vendo-client

A client for the new "vendo" bahn.de APIs, a drop-in replacement for hafas-client.

This is a very early version. What works:

• rudimentary /journeys including lowest prices

What doesn't work (yet):

• /journeys details like scheduledDays, stop/station groups, tickets, some line details (see TODO's scattered around the code)...
• all other endpoints

Also consult the relevant documentation of 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 api (see 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.

Strictly speaking, permission is necessary to use this library with the bahn.de APIs.

Usage

See an example in api.js. It shows how you can use db-vendo-client together with hafas-rest-api in order to run a FPTF API server.

There are community-maintained TypeScript typings available as @types/hafas-client.

API

API documentation

Related Projects

• hafas-client – including further related projects
• db-rest – for the legacy DB HAFAS endpoint
• *.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.

This project needs help! Check the list of "help wanted" Issues.

If you're contributing code, please read the contribution guidelines.