oslobysykkel

2.0.1 • Public • Published

npm version Downloads Dependency Status Build Status MIT license GitHub issues GitHub forks GitHub stars

Features

  • getStations(result_cb) List all stations in the system. Here you'll get the id's you need to make sense of getAvailability() and getAvailabilityByStationId()

  • getAvailability(result_cb) Get availability information on all stations in the oslobysykkel system.

  • getAvailabilityByStationId(id, result_cb) Using the id you find in getAvailability(), you can narrow your request down using this function. Notice: for now this function is just a client side processed version of getAvailability()

Getting Started

First, you must register at https://developer.oslobysykkel.no/. Follow the instructions on the page to get a clientId

In Node.js:

npm install oslobysykkel
var oslobysykkel = require('oslobysykkel');
var obs = new oslobysykkel('{Your API clientId}');
 
// Get all stations and their IDs
obs.getStations(response => {
    console.log(response);
});
 
// Get current availability data
obs.getAvailability(response => {
    console.log(response);
});
 
// Get availability data for one specific station
var stationId = 178;
obs.getAvailabilityByStationId(stationId, response => {
    console.log(response);
});
 

Git

Data Sources

Other

A link that shows where new stations will appear:

Author

William Viker <william.viker@gmail.com>

Contributors

Marius Gundersen - Implemented clientId in 2.0

Changelog

  • 1.2.6 Stable version for 2016 API
  • 2.0.0 Implemented clientId required in 2017 API

Package Sidebar

Install

npm i oslobysykkel

Weekly Downloads

0

Version

2.0.1

License

ISC

Last publish

Collaborators

  • willosof