README.md

🏗 This project is under development!

Node.js API-wrapper for Public Transport in Hamburg

Installation

npm install hvv

Usage

import { HVVClient } from 'hvv';

const hvv = new HVVClient({
  key: 'secret',
  user: 'user'
});

hvv.getRoute({ start: { name: '...' }, dest: { name: '...' } }).then(result => console.log(result));

Documentation

HVVClientOptions

You can initialize a new instance by calling new HVVClient(HVVClientOptions). HVVClientOptions is an object with the following properties:

user

Required
Type: string

Represents geofox-auth-user header, provided by HBT GmbH.

key

Required
Type: string

Individual password, provided by HBT GmbH.

host

Type: string
Default: http://api-test.geofox.de

The API Host address.

contentType

Type: string
Value: application/json or application/xml
Default: application/json

The Content-Type HTTP-Header.

acceptEncoding

Type: string
Value: gzip or deflate
Default: no compression

Accept-Encoding HTTP-Header.

accept

Type: string
Value: application/json or application/xml
Default: application/json

Accept HTTP-Header.

platform

Type: string
Value: One of the following:

• ios (for iOS Apps)
• android (for Android Apps)
• winphone (for Windows Phone Apps)
• web (for desktop websites)
• mobile (for mobile websites)

Default: platform not specified

Represents the clients platform.

version

Type: number

Pins a specific API version to use in every request. Can be overwritten in specific requests by using the version parameter of a BaseRequest.

Default: 1 (it's advised to supply a version here, since version 1 is quite old)

Methods

init(InitRequest)

checkName(CNRequest)

getRoute(GRRequest)

departureList(DLRequest)

getTariff()

departureCourse()

listStations(LSRequest, LSCustomOptions)

listLines()

getAnnouncements(AnnouncementRequest)

checkPostalCode()

getVehicleMap()

getTrackCoordinates()

getIndividualRoute()

getStationInformation()

License

MIT © Lion Ralfs