db-vendo-client/docs/readme.md

14 lines
672 B
Markdown
Raw Normal View History

# API documentation
- [`journeys(from, to, [opt])`](journeys.md) get journeys between locations
- [`journeyLeg(ref, lineName, [opt])`](journey-leg.md) get details for a leg of a journey
- [`departures(station, [opt])`](departures.md) query the next departures at a station
- [`locations(query, [opt])`](locations.md) find stations, POIs and addresses
2018-06-04 19:01:09 +02:00
- [`station(id)`](station.md) get details about a station
- [`nearby(location, [opt])`](nearby.md) show stations & POIs around
- [`radar(north, west, south, east, [opt])`](radar.md) find all vehicles currently in a certain area
2018-03-14 22:52:36 +01:00
## Writing a profile
Check [the guide](writing-a-profile.md).