Philipp Partosch 46a936d7de added all files to project | 2 years ago | |
---|---|---|
.. | ||
arrivals.md | 2 years ago | |
changelog.md | 2 years ago | |
departures.md | 2 years ago | |
hafas-mgate-api.md | 2 years ago | |
journeys-from-trip.md | 2 years ago | |
journeys.md | 2 years ago | |
lines.md | 2 years ago | |
locations.md | 2 years ago | |
migrating-to-5.md | 2 years ago | |
nearby.md | 2 years ago | |
profile-boilerplate.js | 2 years ago | |
radar.md | 2 years ago | |
reachable-from.md | 2 years ago | |
readme.md | 2 years ago | |
refresh-journey.md | 2 years ago | |
remarks.md | 2 years ago | |
server-info.md | 2 years ago | |
stop.md | 2 years ago | |
trip.md | 2 years ago | |
trips-by-name.md | 2 years ago | |
writing-a-profile.md | 2 years ago |
journeys(from, to, [opt])
– get journeys between locationsrefreshJourney(refreshToken, [opt])
– fetch up-to-date/more details of a journey
journeysFromTrip(tripId, previousStopover, to, [opt])
– get journeys from a trip to a locationtrip(id, lineName, [opt])
– get details for a triptripsByName(lineNameOrFahrtNr, [opt])
– get all trips matching a namedepartures(station, [opt])
– query the next departures at a stationarrivals(station, [opt])
– query the next arrivals at a stationlocations(query, [opt])
– find stations, POIs and addressesstop(id, [opt])
– get details about a stop/stationnearby(location, [opt])
– show stations & POIs aroundradar(north, west, south, east, [opt])
– find all vehicles currently in a certain areareachableFrom(address, [opt])
– get all stations reachable from an address within n
minutesremarks([opt])
– get all remarkslines(query, [opt])
– get all lines matching a nameserverInfo([opt])
– fetch meta information from HAFAShafas-client
versionThere’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')
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')
Check the guide.
mgate.exe
APIs