Skip to content
An HTTP API for Berlin & Brandenburg public transport.
JavaScript Dockerfile Shell
Branch: master
Clone or download
Latest commit bb0660a Aug 8, 2019

README.md

vbb-rest

vbb-rest is a public transport REST API, a clean alternative to the VBB HAFAS API.

Use vbb-client@3 for querying this API in browsers or with Node. VBB has blocked our API servers' IP addresses, so the public 2.vbb.transport.rest endpoint is down. For the time being, you have two choices:

  • Use the 1.bvg.transport.rest endpoint. It returns data from the BVG HAFAS API, which is almost exactly the same. Check the docs at derhuerst/bvg-rest#1!
  • Host your vbb-rest instance. See below for instructions.

API Documentation | Why?

vbb-rest architecture diagram

Docker build status dependency status ISC-licensed chat on gitter

installing & running

via Docker

A Docker image is available as derhuerst/vbb-rest.

docker run -d -p 3000:3000 derhuerst/vbb-rest

manually

git clone https://github.com/derhuerst/vbb-rest.git
cd vbb-rest
git checkout 2
npm install --production
npm start

To keep the API running permanently, use tools like forever or systemd.

Contributing

If you have a question or have difficulties using vbb-rest, 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.

You can’t perform that action at this time.