https://github.com/derhuerst/vbb-rest
An HTTP API for Berlin & Brandenburg public transport.
https://github.com/derhuerst/vbb-rest
api berlin bvg transit transport vbb
Last synced: 2 months ago
JSON representation
An HTTP API for Berlin & Brandenburg public transport.
- Host: GitHub
- URL: https://github.com/derhuerst/vbb-rest
- Owner: derhuerst
- License: isc
- Created: 2015-08-03T18:13:40.000Z (almost 10 years ago)
- Default Branch: 6
- Last Pushed: 2025-03-18T13:22:09.000Z (3 months ago)
- Last Synced: 2025-04-04T06:37:14.859Z (3 months ago)
- Topics: api, berlin, bvg, transit, transport, vbb
- Language: JavaScript
- Homepage: https://v6.vbb.transport.rest/
- Size: 344 KB
- Stars: 135
- Watchers: 4
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
# vbb-rest
***vbb-rest* is a public transport REST API**, a clean alternative to the [VBB HAFAS API](https://github.com/public-transport/hafas-client/blob/6/p/vbb/readme.md).
[**API documentation**](docs/readme.md)
[](https://stats.uptimerobot.com/57wNLs39M/793274559)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
## installing & running
### access to Redis
It is recommended that you let `bvg-rest` cache HAFAS responses within a [Redis](https://redis.io/) 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/vbb-rest:6`](https://hub.docker.com/r/derhuerst/vbb-rest:6).
```shell
docker run -d -p 3000:3000 derhuerst/vbb-rest:6
```
*Note:* The Docker image does not contain the Redis server.
### manually
```shell
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`](https://github.com/foreverjs/forever#forever) or [`systemd`](https://wiki.debian.org/systemd).
## Related Projects
- [`vbb-modules`](https://github.com/derhuerst/vbb-modules) – List of JavaScript modules for Berlin & Brandenburg public transport.
- [`vbb-hafas`](https://github.com/public-transport/vbb-hafas) – JavaScript client for the BVG HAFAS API.
- [`bvg-rest`](https://github.com/derhuerst/bvg-rest) – A clean REST API wrapping around the BVG API.
- [`db-rest`](https://github.com/derhuerst/db-rest) – A clean REST API wrapping around the *Deutsche Bahn* API.
- [`hvv-rest`](https://github.com/derhuerst/hvv-rest) – A clean REST API wrapping around the HVV API.
- [`hafas-rest-api`](https://github.com/public-transport/hafas-rest-api) – Expose a HAFAS client via an HTTP REST API.
- [`hafas-client`](https://github.com/public-transport/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](https://github.com/derhuerst/vbb-rest/issues).