vr

vbb-rest

An HTTP API for Berlin & Brandenburg public transport.

Showing:

Popularity

Downloads/wk

2

GitHub Stars

104

Maintenance

Last Commit

13d ago

Contributors

1

Package

Dependencies

12

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Deprecated!
Deprecated. Install vbb-rest from Github with `npm i vbb-rest@derhuerst/vbb-rest`.

Readme

vbb-rest

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

API documentation

vbb-rest architecture diagram

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

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:5.

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

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 5
npm install --production

redis-server &
npm start

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

  • 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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100