Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 4.51 KB

readme.md

File metadata and controls

68 lines (44 loc) · 4.51 KB
Raw

db-vendo-client

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

ISC-licensed support Jannis via GitHub Sponsors

This is a very early version. What works:

  • journeys(), refreshJourney() including tickets
  • locations(), nearby()
  • departures(), arrivals() boards
  • trip()

What doesn't work (yet, see TODO's scattered around the code):

  • journeys() details like scheduledDays, stop/station groups, some line details ...
  • loadFactor and other details in boards
  • certain stop details like products for locations() and geopositions and remarks for boards – this can be remedied by turning on enrichStations in the options, enriching location info with db-hafas-stations.
  • some query options/filters (e.g. routingMode for journeys, direction for boards)
  • all other endpoints (tripsByName(), radar(), journeysFromTrip(), reachableFrom(), remarks(), lines(), stop(), station())

Depending on the configured profile, db-vendo-client will use multiple different DB APIs that offer varying functionality, so choose wisely:

db Profile dbnav Profile
no API key required ✅ ✅
max duration boards 12h 1h
remarks not for boards ✅
cancelled trips not contained in boards contained with cancelled flag
tickets only for refreshJourney() only for refreshJourney(), mutually exclusive with polylines
polylines only for trip() only for refreshJourney()/trip(), mutually exclusive with tickets
trip ids used HAFAS trip ids for journeys, RIS trip ids for boards HAFAS trip ids
assumed backend API stability less stable more stable

Feel free to report anything that you stumble upon via Issues or create a PR :)

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"/"movas" 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.

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 for the db profile and the DB Navigator API for the dbnav profile. See some notes about the various new APIs at DB.

Strictly speaking, permission is necessary to use this library with the DB 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. The Dockerfile serves this API.

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

Related Projects

  • hafas-client – including further related projects
  • hafas-rest-api – expose a hafas-client or db-vendo-client instance as a REST API
  • 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.