db-vendo-client/docs/readme.md

API documentation

• journeys(from, to, [opt]) – get journeys between locations
• refreshJourney(refreshToken, [opt]) – fetch up-to-date/more details of a journey
• trip(id, lineName, [opt]) – get details for a trip
• 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
• stop(id, [opt]) – get details about a stop/station
• nearby(location, [opt]) – show stations & POIs around
• radar(north, west, south, east, [opt]) – find all vehicles currently in a certain area
• reachableFrom(address, [opt]) – get all stations reachable from an address within n minutes

Migrating from an old hafas-client version

• 2 → 3 migration guide
• 3 → 4 migration guide

Throttling requests

There's opt-in support for throttling requests to the endpoint.

const withThrottling = require('hafas-client/throttle')
const createClient = require('hafas-client')
const dbProfile = require('hafas-client/p/db')

// create a throttled HAFAS client with Deutsche Bahn profile
const createThrottledClient = withThrottling(createClient)
const client = createThrottledClient(dbProfile, 'my-awesome-program')

// Berlin Jungfernheide to München Hbf
client.journeys('8011167', '8000261', {results: 1})
.then(console.log)
.catch(console.error)

You can pass custom values for the nr of requests (limit) per interval into withThrottling:

// 2 requests per second
const createThrottledClient = withThrottling(createClient, 2, 1000)
const client = createThrottledClient(dbProfile, 'my-awesome-program')

Retrying failed requests

There's opt-in support for retrying failed requests to the endpoint.

const withRetrying = require('hafas-client/retry')
const createClient = require('hafas-client')
const dbProfile = require('hafas-client/p/db')

// create a client with Deutsche Bahn profile that will retry on HAFAS errors
const createRetryingClient = withRetrying(createClient)
const client = createRetryingClient(dbProfile, 'my-awesome-program')

// Berlin Jungfernheide to München Hbf
client.journeys('8011167', '8000261', {results: 1})
.then(console.log)
.catch(console.error)

You can pass custom options into withRetrying. They will be passed into retry.

// retry 2 times, after 10 seconds & 30 seconds
const createRetryingClient = withRetrying(createClient, {
	retries: 2,
	minTimeout: 10 * 1000,
	factor: 3
})
const client = createRetryingClient(dbProfile, 'my-awesome-program')

Writing a profile

Check the guide.

General documentation for mgate.exe APIs

hafas-mgate-api.md