mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 07:09:35 +02:00

History

Jannis R d3815f80d7 arrivals/departures: parse & expose platforms ✨		2018-06-27 17:19:49 +02:00
..
arrivals.md	query arrivals ✨, docs 📝	2018-06-26 18:13:41 +02:00
changelog.md	arrivals/departures: parse & expose platforms ✨	2018-06-27 17:19:49 +02:00
departures.md	journey leg, departure, movement: journeyId -> tripId 💥	2018-06-26 18:13:41 +02:00
journey-leg.md	opt.passedStations -> opt.stopovers 💥	2018-06-19 08:23:49 +02:00
journeys.md	journeys: startWithWalking with default true ✨	2018-06-25 18:34:10 +02:00
locations.md	minor docs improvements	2018-01-05 15:01:32 +01:00
migrating-to-3.md	add todos, migrating to 3.x guide, related repos 📝	2018-06-27 11:49:57 +02:00
nearby.md	minor docs improvements	2018-01-05 15:01:32 +01:00
profile-boilerplate.js	add simple profile boilerplate	2018-03-24 18:18:34 +01:00
radar.md	docs for new polyline format 📝	2018-05-24 10:26:24 +02:00
readme.md	query arrivals ✨, docs 📝	2018-06-26 18:13:41 +02:00
station.md	adapt docs to 3c9c5cb 📝	2018-06-10 14:47:29 +02:00
writing-a-profile.md	merge refactor-parse-fns into next	2018-06-26 13:07:06 +02:00

API documentation

journeys(from, to, [opt]) – get journeys between locations
journeyLeg(ref, lineName, [opt]) – get details for a leg of a journey
departures(station, [opt]) – query the next departures at a station
arrivals(station, [opt]) – query the next arrivals at a station
locations(query, [opt]) – find stations, POIs and addresses
station(id) – get details about a station
nearby(location, [opt]) – show stations & POIs around
radar(north, west, south, east, [opt]) – find all vehicles currently in a certain area

Writing a profile