Vbb-client NPM

vbb-client

A client for the Berlin & Brandenburg public transport API deployed at 2.vbb.transport.rest. Works both in browsers (using a bundler) and in Node.

architecture

ISC-licensed

Installing

npm install vbb-client

Usage

const vbb = require('vbb-client')()

vbb.journeys('900000003201', '900000024101', {results: 1})
.then(console.log)
.catch(console.error)

With Custom Endpoint

const vbb = require('vbb-client')({
    endpoint: "https://my.local.api",
})

API

vbb-client is a client for the vbb-rest API deployed at 2.vbb.transport.rest. Refer to its API docs for all supported parameters.

It wraps the following routes:

/stations?query=… as stations([query]) → Promise/stream.Readable
/stations/all as allStations([query]) → Promise
/stations/nearby as nearby([query]) → Promise
/stations/:id as station(id, [query]) → Promise
/stations/:id/departures as departures(id, [query]) → Promise
/lines?query=… as lines([query]) → stream.Readable
/lines/:id as line(id, [query]) → Promise
/journeys as journeys(from, to, [query]) → Promise
/journeys/legs/:ref as journeyLeg(ref, [query]) → Promise
/maps/:type as map(type, [query]) → stream.Readable

Contributing

If you have a question or have difficulties using vbb-client, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.