db-vendo-client/docs

API documentation

• journeys(from, to, [opt]) – get journeys between locations
• refreshJourney(refreshToken, [opt]) – fetch up-to-date/more details of a journey
• journeysFromTrip(tripId, previousStopover, to, [opt]) – get journeys from a trip to a location
• trip(id, lineName, [opt]) – get details for a trip
• tripsByName(lineNameOrFahrtNr, [opt]) – get all trips matching a name
• 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
• remarks([opt]) – get all remarks
• lines(query, [opt]) – get all lines matching a name
• serverInfo([opt]) – fetch meta information from HAFAS

Migrating from an old hafas-client version

• 4 → 5 migration guide

Throttling requests

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

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

// create a throttled HAFAS client with Deutsche Bahn profile
const client = createClient(withThrottling(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 throttledDbProfile = withThrottling(dbProfile, 2, 1000)
const client = createClient(throttledDbProfile, 'my-awesome-program')

Retrying failed requests

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

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

// create a client with Deutsche Bahn profile that will retry on HAFAS errors
const client = createClient(withRetrying(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 retryingDbProfile = withRetrying(dbProfile, {
	retries: 2,
	minTimeout: 10 * 1000,
	factor: 3
})
const client = createClient(retryingDbProfile, 'my-awesome-program')

Logging requests

You can use profile.logRequest and profile.logResponse to process the raw Fetch Request and Response, respectively.

As an example, we can implement a custom logger:

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

const logRequest = (ctx, fetchRequest) => {
	// ctx looks just like with the other profile.* hooks:
	const {profile, opt} = ctx

	console.debug(fetchRequest.headers, fetchRequest.body + '')
}

// create a client with Deutsche Bahn profile that debug-logs
const client = createClient({
	...dbProfile,
	logRequest,
	logResponse,
}, 'my-awesome-program')

// logRequest output:
{
	accept: 'application/json',
	'accept-encoding': 'gzip, br, deflate',
	'content-type': 'application/json',
	connection: 'keep-alive',
	'user-agent': 'hafas842c51-clie842c51nt debug C842c51LI'
} {"lang":"de","svcReqL":[{"cfg":{"polyEnc":"GPA"},"meth":"LocMatch",…
// logResponse output:
{
	'content-encoding': 'gzip',
	'content-length': '1010',
	'content-type': 'application/json; charset=utf-8',
	date: 'Thu, 06 Oct 2022 12:31:09 GMT',
	server: 'Apache',
	vary: 'User-Agent'
} {"ver":"1.45","lang":"deu","id":"sb42zgck4mxtxm4s","err":"OK","graph"…

The default profile.logRequest console.errors the request body, if you have set $DEBUG to hafas-client. Likewise, profile.logResponse console.errors the response body.

Writing a profile

Check the guide.

General documentation for mgate.exe APIs

hafas-mgate-api.md