diff --git a/readme.md b/readme.md index ab1f93a2..115d97bc 100644 --- a/readme.md +++ b/readme.md @@ -8,12 +8,19 @@ This is a very early version. What works: * rudimentary `/journeys` including lowest prices +* `/locations`, `/locations/nearby` +* `/departures`, `/arrivals` (requires a DB API Key for RIS::Boards, maybe you find one somewhere ;) -What doesn't work (yet): +What doesn't work (yet, see TODO's scattered around the code): -* `/journeys` details like scheduledDays, stop/station groups, tickets, some line details (see TODO's scattered around the code)... +* `/journeys` details like scheduledDays, stop/station groups, tickets, some line details ... +* `/journeys` uses different tripIds compared to departure and arrival boards... +* certain stop details like products for `/locations` and geopositions for departures and arrivals +* some query options like BahnCards etc. * all other endpoints +Feel free report anything that you stumble upon via Issues or create a PR :) + Also consult the relevant **[documentation](https://github.com/public-transport/hafas-rest-api/docs/readme.md)** of [hafas-client](https://github.com/public-transport/hafas-client/) (but beware of the limited functionality of db-vendo-client). @@ -29,6 +36,7 @@ See an example in [api.js](api.js). It shows how you can use `db-vendo-client` t There are [community-maintained TypeScript typings available as `@types/hafas-client`](https://www.npmjs.com/package/@types/hafas-client). +For the `/departures` and `/arrivals` endpoints, `DB_API_KEY` and `DB_CLIENT_ID` environment variables for RIS::Boards have to be set. ## API