refresh-journey.md

refreshJourney(refreshToken, [opt])

refreshToken must be a string, taken from journey.refreshToken.

With opt, you can override the default options, which look like this:

{
	stopovers: false, // return stations on the way?
	polylines: false, // return a shape for each leg?
	tickets: false, // return tickets? only available with some profiles
	subStops: true, // parse & expose sub-stops of stations?
	entrances: true, // parse & expose entrances of stops/stations?
	remarks: true, // parse & expose hints & warnings?
	language: 'en' // language to get results in
}

Response

As an example, we're going to use the VBB profile:

const createClient = require('hafas-client')
const vbbProfile = require('hafas-client/p/vbb')

const userAgent = 'link-to-your-project-or-email' // adapt this to your project!
const client = createClient(vbbProfile, userAgent)

// Hauptbahnhof to Heinrich-Heine-Str.
client.journeys('900000003201', '900000100008', {results: 1})
.then(([journey]) => {
	// later, fetch up-to-date info on the journey
	client.refreshJourney(journey.refreshToken, {stopovers: true, remarks: true})
	.then(console.log)
	.catch(console.error)
})
.catch(console.error)

refreshJourney() will return a single Friendly Public Transport Format v2 draft journey, in the same format as with journeys().