readme.md

hafas-client

A client for HAFAS public transport APIs. Sort of like public-transport-enabler, but with a smaller scope. It contains customisations for the following transport networks:

HAFAS endpoint	wrapper library	docs	example code	source code
Deutsche Bahn (DB)	db-hafas	docs	example code	src
Berlin & Brandenburg public transport (VBB)	vbb-hafas	docs	example code	src
Österreichische Bundesbahnen (ÖBB)	oebb-hafas	docs	example code	src
Nahverkehr Sachsen-Anhalt (NASA)/INSA	insa-hafas	docs	example code	src
Nahverkehrsverbund Schleswig-Holstein (NAH.SH)	nahsh-hafas	docs	example code	src

Background

There's a company called HaCon that sells a public transport management system called HAFAS. It is used by companies all over Europe to serve routing and departure information for apps. All those endpoints are similar, with the same terms and API routes, but have slightly different options, filters and sets of enabled features.

hafas-client contains all logic for communicating with these, as well as serialising from and parsing to Friendly Public Transport Format (FPTF) 1.0.1. Endpoint-specific customisations (called profiles here) increase the quality of the returned data.

Installing

npm install hafas-client

API

API documentation

Usage

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

// create a client with Deutsche Bahn profile
const client = createClient(dbProfile)

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

The returned Promise will resolve with an array of one FPTF journey.

[ {
	legs: [ {
		id: '1|100067|48|81|17122017',
		origin: {
			type: 'station',
			id: '8089100',
			name: 'Berlin Jungfernheide (S)',
			location: {
				type: 'location',
				latitude: 52.530291,
				longitude: 13.299451
			},
			products: { /* … */ }
		},
		departure: '2017-12-17T17:05:00.000+01:00',
		departurePlatform: '5',
		destination: {
			type: 'station',
			id: '8089118',
			name: 'Berlin Beusselstraße',
			location: { /* … */ },
			products: { /* … */ }
		},
		arrival: '2017-12-17T17:08:00.000+01:00',
		arrivalPlatform: '1',
		line: {
			type: 'line',
			id: '41172',
			name: 'S 41',
			public: true,
			mode: 'train',
			product: 'suburban',
			class: 16,
			productCode: 4,
			operator: {
				type: 'operator',
				id: 's-bahn-berlin-gmbh',
				name: 'S-Bahn Berlin GmbH'
			}
		},
		direction: 'Ringbahn ->'
	}, /* … */ {
		origin: {
			type: 'station',
			id: '730749',
			name: 'Berlin Hauptbahnhof (S+U), Berlin',
			location: {
				type: 'location',
				latitude: 52.526461,
				longitude: 13.369378
			},
			products: { /* … */ }
		},
		departure: '2017-12-17T17:25:00.000+01:00',
		destination: {
			type: 'station',
			id: '8098160',
			name: 'Berlin Hbf (tief)',
			location: { /* … */ },
			products: { /* … */ }
		},
		arrival: '2017-12-17T17:33:00.000+01:00',
		mode: 'walking',
		public: true
	}, {
		id: '1|70906|0|81|17122017',
		origin: {
			type: 'station',
			id: '8098160',
			name: 'Berlin Hbf (tief)',
			location: { /* … */ },
			products: { /* … */ }
		},
		departure: '2017-12-17T17:37:00.000+01:00',
		departurePlatform: '1',
		destination: {
			type: 'station',
			id: '8000261',
			name: 'München Hbf',
			location: { /* … */ },
			products: { /* … */ }
		},
		arrival: '2017-12-17T22:45:00.000+01:00',
		arrivalPlatform: '13',
		line: { /* … */ },
		direction: 'München Hbf'
	} ],
	origin: {
		type: 'station',
		id: '8089100',
		name: 'Berlin Jungfernheide (S)',
		location: { /* … */ },
		products: { /* … */ }
	},
	departure: '2017-12-17T17:05:00.000+01:00',
	destination: {
		type: 'station',
		id: '8000261',
		name: 'München Hbf',
		location: { /* … */ },
		products: { /* … */ }
	},
	arrival: '2017-12-17T22:45:00.000+01:00',
	price: {
		amount: null,
		hint: 'No pricing information available.'
	}
} ]

Related

• public-transport-enabler – Unleash public transport data in your Java project.
• Friendly Public Transport Format – A format for APIs, libraries and datasets containing and working with public transport data.
• db-hafas – JavaScript client for the DB HAFAS API.
• vbb-hafas – JavaScript client for Berlin & Brandenburg public transport HAFAS API.
• hafas-departures-in-direction – Pass in a HAFAS client, get departures in a certain direction.
• hafas-collect-departures-at – Utility to collect departures, using any HAFAS client.
• hafas-discover-stations – Pass in a HAFAS client, discover stations by querying departures.
• hafas-rest-api – Expose a HAFAS client via an HTTP REST API.
• List of european long-distance transport operators, available API endpoints, GTFS feeds and client modules.
• Collection of european transport JavaScript modules.

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.