Skip to content
JavaScript client for HAFAS public transport APIs.
JavaScript
Branch: master
Clone or download
Latest commit 3c7c1c3 Aug 16, 2019

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
Berlin public transport (BVG) bvg-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
Austin, Texas (CMTA/CapMetro) - docs example code src
S-Bahn München - docs example code src
Saarfahrplan/VGS (Saarland) - docs example code src
Société Nationale des Chemins de Fer Luxembourgeois (CFL) - docs example code src
Hamburg public transport (HVV) - docs example code src
Nordhessischer Verkehrsverbund (NVV) (Hesse) - docs example code src

There are also client libraries that use the library, but contain their own customisations:

HAFAS endpoint library
Betriebsstellen & disturbances in the German rail network db-netz-hafas

npm version build status ISC-licensed chat on gitter support me on Patreon

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.2.0. Endpoint-specific customisations (called profiles here) increase the quality of the returned data.

Installing

npm install hafas-client

with react-native

hafas-client as well its dependencies use Node-builtin modules and Node globals. To be able to use it within react-native, follow the instructions at node-libs-react-native.

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, 'my-awesome-program')

// 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 object with an array journeys that contains one FPTF journey.

{
	journeys: [ {
		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+01:00',
			departurePlatform: '5',
			destination: {
				type: 'station',
				id: '8089118',
				name: 'Berlin Beusselstraße',
				location: { /**/ },
				products: { /**/ }
			},
			arrival: '2017-12-17T17:08:00+01:00',
			arrivalPlatform: '1',
			line: {
				type: 'line',
				id: '41172',
				name: 'S 41',
				public: true,
				mode: 'train',
				product: 'suburban',
				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+01:00',
			destination: {
				type: 'station',
				id: '8098160',
				name: 'Berlin Hbf (tief)',
				location: { /**/ },
				products: { /**/ }
			},
			arrival: '2017-12-17T17:33:00+01:00',
			public: true,
			walking: true
		}, {
			id: '1|70906|0|81|17122017',
			origin: {
				type: 'station',
				id: '8098160',
				name: 'Berlin Hbf (tief)',
				location: { /**/ },
				products: { /**/ }
			},
			departure: '2017-12-17T17:37:00+01:00',
			departurePlatform: '1',
			destination: {
				type: 'station',
				id: '8000261',
				name: 'München Hbf',
				location: { /**/ },
				products: { /**/ }
			},
			arrival: '2017-12-17T22:45:00+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+01:00',
		destination: {
			type: 'station',
			id: '8000261',
			name: 'München Hbf',
			location: { /**/ },
			products: { /**/ }
		},
		arrival: '2017-12-17T22:45:00+01:00',
		price: {
			amount: null,
			hint: 'No pricing information available.'
		}
	} ],
	earlierRef: /**/,
	laterRef: /**/
}

Related

Contributing

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

You can’t perform that action at this time.