mrueg / vbb-rest

An HTTP API for Berlin & Brandenburg public transport.

vbb-rest

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

API documentation

installing & running

vbb-rest expects a Redis server running on 127.0.0.1:6379 (default port), but you can set the REDIS_URL environment variable to change this.

via Docker

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

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

Note: The Docker image does not contain the Redis server.

manually

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

export HOSTNAME='my-vbb-rest-api.example.org'
npm run build

redis-server &
npm start

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

Related Projects

• vbb-modules – List of JavaScript modules for Berlin & Brandenburg public transport.
• vbb-hafas – JavaScript client for the BVG HAFAS API.
• bvg-rest – A clean REST API wrapping around the BVG API.
• db-rest – A clean REST API wrapping around the Deutsche Bahn API.
• hvv-rest – A clean REST API wrapping around the HVV API.
• hafas-rest-api – Expose a HAFAS client via an HTTP REST API.
• hafas-client – JavaScript client for HAFAS public transport APIs.

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.