derhuerst/hvv-rest

An HTTP API for Hamburg public transport.

hvv-rest

Deprecated because HVV has shut off hteir HAFAS API.

---

hvv-rest is a public transport REST API, a clean alternative to the HVV HAFAS API. It is deployed at v5.hvv.transport.rest.

API documentation

installing & running

hvv-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/hvv-rest:5.

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

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

manually

git clone https://github.com/derhuerst/hvv-rest.git
cd hvv-rest
git checkout 5
npm install --production

redis-server &
npm start

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

Related Projects

• db-rest – A clean REST API wrapping around the Deutsche Bahn API.
• vbb-rest – A clean REST API wrapping around the VBB API.
• bvg-rest – A clean REST API wrapping around the BVG 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 hvv-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.