https://github.com/willosof/oslobysykkel

Unofficial API for the latest city bike system in Oslo, Norway
https://github.com/willosof/oslobysykkel

Last synced: 2 months ago
JSON representation

Unofficial API for the latest city bike system in Oslo, Norway

• Host: GitHub
• URL: https://github.com/willosof/oslobysykkel
• Owner: willosof
• Created: 2016-05-20T21:56:33.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-28T22:49:06.000Z (almost 8 years ago)
• Last Synced: 2025-02-28T16:12:11.284Z (3 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/oslobysykkel
• Size: 12.7 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/oslobysykkel.svg)](https://badge.fury.io/js/oslobysykkel)

[![Downloads](https://img.shields.io/npm/dm/oslobysykkel.svg)](https://npmjs.com/oslobysykkel)

[![Dependency Status](https://david-dm.org/willosof/oslobysykkel.svg)](https://david-dm.org/willosof/oslobysykkel)

[![Build Status](https://travis-ci.org/willosof/oslobysykkel.svg?branch=master)](https://travis-ci.org/willosof/oslobysykkel)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

[![GitHub issues](https://img.shields.io/github/issues/willosof/oslobysykkel.svg?style=plastic)](https://github.com/willosof/oslobysykkel/issues)

[![GitHub forks](https://img.shields.io/github/forks/willosof/oslobysykkel.svg?style=plastic)](https://github.com/willosof/oslobysykkel/network)

[![GitHub stars](https://img.shields.io/github/stars/willosof/oslobysykkel.svg?style=plastic)](https://github.com/willosof/oslobysykkel/stargazers)

## 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

```

```javascript

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

* [https://github.com/willosof/oslobysykkel](https://github.com/willosof/oslobysykkel)

* `[email protected]:willosof/oslobysykkel.git`

### Data Sources

* https://oslobysykkel.no/api/v1/stations/availability

* https://oslobysykkel.no/api/v1/stations

### Other

#### A link that shows where new stations will appear:

* https://oslobysykkel.no/api/internal/stations (ready=false is the coming ones)

### Author

William Viker <>

### Contributors

[Marius Gundersen](https://github.com/igundersen) - Implemented clientId in 2.0

### Changelog

* 1.2.6 Stable version for 2016 API

* 2.0.0 Implemented clientId required in 2017 API