Wondering what’s next for npm?Check out our public roadmap! »

ns-api

4.0.1 • Public • Published

ns-api

Access public transit data from Nederlandse Spoorwegen API with node.js

Changelog Build Status Coverage Status Greenkeeper badge

To use this module you need API access credentials, which you can request at Here (Dutch).

Example

const NSAPI = require ('ns-api');
const ns = new NSAPI ({
  key: 'abc123',
});
 
// Get travel advise
ns.getTrips ({
  fromStation: 'UT',
  toStation: 'AMF',
})
  .then (data => console.dir (data, {
    depth: null,
    colors: true,
  }))
  .catch (console.error)
;

Installation

npm i ns-api

Configuration

param type default description
key string One of your API keys
[timeout] number 8000 Request time out in ms
const NSAPI = require ('ns-api');
const ns = new NSAPI ({
  key: 'abc123',
});

Methods

Each method returns a Promise, so make sure to catch the errors properly.

When a method takes arguments they are only accepted in object notation. This way the order no longer matters and it makes it easier to reuse them.

methodName ({ one, two });

I'm not going to outline to full possibilities of each method here, only the parts that adjust the API response or make the request easier. Read the API documentation links to find all available parameters that each method can take.

getAllStations

List of all stations

ns.getAllStations()
  .then (data => data.filter (station => station.land === 'NL'))
  .then (data => console.table (data, ['code', 'stationType']))
  .catch (console.error)
;

API documentation

getArrivals

List of arrivals at a station. It requires a station or uicCode.

parameter type description
[dateTime] Date or string Limit to starting time, will be converted to the right format
ns.getArrivals ({
  dateTime: '2019-05-10',
  station: 'UT',
})
  .then (data => console.table (data, ['name', 'origin', 'actualDateTime']))
  .catch (console.error)
;

API documentation

getCalamities

List of all current calamities

parameter type description
[lang] string Text language
ns.getArrivals ({ lang: 'en' })
  .then (console.log)
  .catch (console.error)
;

API documentation

getDepartures

List all departures at a station. It requires a station or uicCode.

parameter type description
[dateTime] Date or string Limit to starting time, will be converted to the right format
ns.getDepartures ()
  .then (console.log)
  .catch (console.error)
;

API documentation

getDisruptions

List of disruptions/maintenance.

parameter type description
[actual] boolean Only return disruptions within 2 hours
ns.getDisruptions()
  .then (data => console.table (data, ['titel']))
  .catch (console.error)
;

API documentation

getStationDisruption

List of disruptions at a station

parameter type description
[dateTime] Date or string Limit to starting time, will be converted to the right format
ns.getStationDisruption ({ dateTime: '2019-05-10' })
  .then (data => console.table (data, ['titel']))
  .catch (console.error)
;

API documentation

getDisruption

Get details about one disruption

parameter type description
id string Disruption object ID
ns.getDisruption ({ id: 'abc123' })
  .then (console.log)
  .catch (console.error)
;

API documentation

getTrips

Get a list of travel advises

parameter type description
[dateTime] Date or string Limit to starting time, will be converted to the right format
ns.getTrips ({
  dateTime: '2019-05-10 17:40',
  fromStation: 'Amersfoort',
  toStation: 'Den Haag',
})
  .then (console.log)
  .catch (console.error)
;

API documentation

getTrip

Get a specific travel advise

parameter type description
ctxRecon string Trip ctxRecon from getTrips()
ns.getTrip ({ ctxRecon: 'abc123' })
  .then (console.log)
  .catch (console.error)
;

API documentation

getPrice

Get pricing for travel between two stations.

parameter type description
fromStation string Station name or ID
toStation string Station name or ID
ns.getPrices ({
  fromStation: 'AMF',
  toStation: 'Den Haag',
})
  .then (console.log)
  .catch (console.error)
;
 

API documentation

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org/

Author

Franklin | Buy me a coffee

Install

npm i ns-api

DownloadsWeekly Downloads

378

Version

4.0.1

License

Unlicense

Unpacked Size

40.2 kB

Total Files

7

Last publish

Collaborators

  • avatar