Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/public-transport/vbb-hafas
A JavaScript client for Berlin & Brandenburg public transport HAFAS API.
https://github.com/public-transport/vbb-hafas
api berlin bvg search transit transport vbb
Last synced: 9 days ago
JSON representation
A JavaScript client for Berlin & Brandenburg public transport HAFAS API.
- Host: GitHub
- URL: https://github.com/public-transport/vbb-hafas
- Owner: public-transport
- License: isc
- Created: 2015-07-17T12:19:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T16:24:49.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T07:11:20.695Z (7 months ago)
- Topics: api, berlin, bvg, search, transit, transport, vbb
- Language: JavaScript
- Homepage: https://github.com/public-transport/vbb-hafas
- Size: 323 KB
- Stars: 31
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
# vbb-hafas
**A client for the Berlin & Brandenburg public transport service (VBB).** It acts as a consistent and straightforward interface on top of a verbose API.
This project is actually a thin wrapper around [`hafas-client@6`](https://github.com/public-transport/hafas-client/tree/6#hafas-client). [Its docs](https://github.com/public-transport/hafas-client/tree/6/docs) document the API in general.
*Note*: You may not want to query the VBB API by yourself. [`vbb-client`](https://github.com/derhuerst/vbb-client) is an API-compatible client for [`vbb-rest`](https://github.com/derhuerst/vbb-rest), my wrapper API. It also works in the browser.
[](https://www.npmjs.com/package/vbb-hafas)
[](https://travis-ci.org/public-transport/vbb-hafas)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
## Installing
```shell
npm install vbb-hafas
```
## API
Check [the docs for `hafas-client`](https://github.com/public-transport/hafas-client/tree/6/docs) as well as [its VBB-specific customisations](https://github.com/public-transport/hafas-client/blob/6/p/vbb/readme.md).
## Usage
```javascript
const createHafas = require('vbb-hafas')
const hafas = createHafas('my-awesome-program')
```
As an example, we will search for a journey [from *Berlin Hauptbahnhof* to *Berlin Charlottenburg*](https://www.google.de/maps/dir/Berlin+Hauptbahnhof,+Europaplatz,+Berlin/S+Berlin-Charlottenburg/@52.5212391,13.3287227,13z). To get the station IDs, [use `vbb-stations`](https://github.com/derhuerst/vbb-stations#usage).
```javascript
hafas.journeys('900000003201', '900000024101', {results: 1})
.then((journeys) => console.log(journeys[0]))
.catch(console.error)
```
The output will be an array of [`journey` objects in the *Friendly Public Transport Format* `1.2.1` format](https://github.com/public-transport/friendly-public-transport-format/tree/1.2.1/spec#journey):
```javascript
[ {
legs: [ {
tripId: '1|50420|0|86|25122017',
direction: 'Brandenburg, Hbf',
line: {
type: 'line',
id: '10',
name: 'RE1',
public: true,
mode: 'train',
product: 'regional',
symbol: 'RE',
nr: 1,
metro: false,
express: true,
night: false,
class: 64,
productCode: 6,
operator: {
type: 'operator',
id: 'db-regio-ag',
name: 'DB Regio AG'
}
},
origin: {
type: 'station',
id: '900000003201',
name: 'S+U Berlin Hauptbahnhof',
location: {
type: 'location',
latitude: 52.52585,
longitude: 13.368928
},
products: {
suburban: true,
subway: true,
tram: true,
bus: true,
ferry: false,
express: true,
regional: true
}
},
departure: '2017-12-26T00:41:00.000+01:00',
plannedDeparture: '2017-12-26T00:41:00.000+01:00',
departureDelay: 0,
departurePlatform: '14',
plannedDeparturePlatform: '13',
destination: {
type: 'station',
id: '900000024101',
name: 'S Charlottenburg',
location: {
type: 'location',
latitude: 52.504806,
longitude: 13.303846
},
products: {
suburban: true,
subway: false,
tram: false,
bus: true,
ferry: false,
express: false,
regional: true
}
},
arrival: '2017-12-26T00:50:00.000+01:00',
plannedArrival: '2017-12-26T00:50:00.000+01:00',
arrivalDelay: null,
arrivalPlatform: '4',
plannedArrivalPlatform: '4'
} ],
// all these are from the first leg
origin: {
type: 'station',
id: '900000003201',
name: 'S+U Berlin Hauptbahnhof'
// …
},
departure: '2017-12-26T00:41:00.000+01:00',
plannedDeparture: '2017-12-26T00:41:00.000+01:00',
departureDelay: 0,
departurePlatform: '14',
plannedDeparturePlatform: '13',
// all these are from the last leg
destination: {
type: 'station',
id: '900000024101',
name: 'S Charlottenburg'
// …
},
arrival: '2017-12-26T00:50:00.000+01:00',
plannedArrival: '2017-12-26T00:50:00.000+01:00',
arrivalDelay: null,
arrivalPlatform: '4',
plannedArrivalPlatform: '4'
// …
} ]
```
### Transfer information for journeys
`vbb-hafas` will try to add transfer information from [`vbb-change-positions`](https://github.com/juliuste/vbb-change-positions) if you pass `transferInfo: true` as an option.
If it identifies a known transfer, the previous leg will have a `bestArrivalPosition` and the next leg will have a `departurePosition`, indicating the optimal transfer between both platforms. Check out the markup in [`vbb-change-positions`](https://github.com/juliuste/vbb-change-positions) for more details.
## Related
Check [`hafas-client`'s related projects](https://github.com/public-transport/hafas-client/blob/6/readme.md#related-projects).
## Contributing
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/public-transport/vbb-hafas/issues).