Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/public-transport/insa-hafas
JavaScript client for the NASA/INSA HAFAS API.
https://github.com/public-transport/insa-hafas
germany insa public-transport transit
Last synced: 2 months ago
JSON representation
JavaScript client for the NASA/INSA HAFAS API.
- Host: GitHub
- URL: https://github.com/public-transport/insa-hafas
- Owner: public-transport
- License: isc
- Created: 2018-03-14T00:31:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T08:44:06.000Z (over 4 years ago)
- Last Synced: 2024-10-29T11:31:47.499Z (2 months ago)
- Topics: germany, insa, public-transport, transit
- Language: JavaScript
- Homepage: https://github.com/public-transport/insa-hafas#insa-hafas
- Size: 13.7 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license.md
Awesome Lists containing this project
README
# insa-hafas
**A client for the [public transport authority *Nahverkehr Sachsen-Anhalt* (NASA)](https://de.wikipedia.org/wiki/Nahverkehrsservice_Sachsen-Anhalt)/[INSA](https://insa.de).** It acts as a consistent and straightforward interface on top of a verbose API.
This project is actually a thin wrapper around [`hafas-client@5`](https://github.com/public-transport/hafas-client/tree/5#hafas-client). [Its docs](https://github.com/public-transport/hafas-client/tree/5/docs) document the API in general.
[](https://www.npmjs.com/package/insa-hafas)
[](https://travis-ci.org/public-transport/insa-hafas)
[](https://gitter.im/public-transport/Lobby)
[](https://github.com/sponsors/derhuerst)
## Installing
```shell
npm install insa-hafas
```
## API
Check [the docs for `hafas-client@5`](https://github.com/public-transport/hafas-client/tree/5/docs) as well as [its INSA-specific customisations](https://github.com/public-transport/hafas-client/blob/5/p/insa/readme.md).
## Usage
```javascript
const hafas = require('insa-hafas')
```
As an example, we will search for a route from *Berlin Jungfernheide* to *München Hbf*. To get the station IDs, use [`locations(query, [opt])`](https://github.com/public-transport/hafas-client/blob/master/docs/locations.md).
```javascript
client.journeys('8011167', '8000261', {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
{
type: 'journey',
legs: [{
mode: 'walking',
public: true
origin: {
type: 'station',
id: '8010226',
name: 'Magdeburg-Neustadt',
location: {
type: 'location',
latitude: 52.148842,
longitude: 11.641705
},
products: {
nationalExp: true,
national: true,
regional: true,
suburban: true,
bus: true,
tram: true,
tourismTrain: true
}
},
departure: '2018-03-14T03:01:00.000+01:00',
plannedDeparture: '2018-03-14T03:01:00.000+01:00',
departureDelay: null,
destination: {
type: 'station',
id: '7368',
name: 'Magdeburg, S-Bahnhof Neustadt (Tram)',
location: { /* … */ },
products: { /* … */ }
},
arrival: '2018-03-14T03:06:00.000+01:00',
plannedArrival: '2018-03-14T03:06:00.000+01:00',
arrivalDelay: null,
}, {
tripId: '1|86821|1|80|14032018',
direction: 'Alter Markt',
line: {
type: 'line',
id: 'n8',
name: 'N8',
public: true,
product: 'tram',
mode: 'train',
operator: {
type: 'operator',
id: 'magdeburger-verkehrsbetriebe',
name: 'Magdeburger Verkehrsbetriebe'
}
},
origin: {
type: 'station',
id: '7368',
name: 'Magdeburg, S-Bahnhof Neustadt (Tram)',
location: { /* … */ },
products: { /* … */ }
},
departure: '2018-03-14T03:06:00.000+01:00',
plannedDeparture: '2018-03-14T03:05:00.000+01:00',
departureDelay: 60,
departurePlatform: null,
plannedDeparturePlatform: null,
destination: {
type: 'station',
id: '7333',
name: 'Magdeburg, Alter Markt',
location: { /* … */ },
products: { /* … */ }
},
arrival: '2018-03-14T03:12:00.000+01:00',
plannedArrival: '2018-03-14T03:12:00.000+01:00',
arrivalDelay: 0,
arrivalPlatform: '2a',
plannedArrivalPlatform: '1',
alternatives: [{
line: {
type: 'line',
id: 'str-n8',
name: 'Str N8',
public: true,
product: 'tram',
mode: 'train'
},
when: '2018-03-14T04:06:00.000+01:00'
}]
} /* … */ ]
}
```
## Related
Check [`hafas-client`'s related libs](https://github.com/public-transport/hafas-client/blob/master/readme.md#related).
## 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/insa-hafas/issues).