Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

derhuerst/bvg-rest

Open more actions menu

Repository files navigation

bvg-rest

bvg-rest is a public transport REST API, a clean alternative to the BVG HAFAS API. It is deployed at v6.bvg.transport.rest.

API documentation

bvg-rest architecture diagram

API status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

installing & running

access to Redis

It is recommended that you let bvg-rest cache HAFAS responses within a Redis cache. To use this feature, set $REDIS_URL (e.g. to redis://localhost:6379/1 when running Redis locally).

via Docker

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

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

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

manually

git clone https://github.com/derhuerst/bvg-rest.git
cd bvg-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.
  • bvg-hafas – JavaScript client for the BVG HAFAS 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 need support using bvg-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.

About

An HTTP API for Berlin & Brandenburg public transport.

Topics

Resources

Stars

Watchers

Forks

Packages

Used by

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.