wili

wili

English | Deutsch

A Node wrapper for the Wiener Linien public transport API

Installation

yarn add wili || npm install wili

Prerequisites

You will need a valid API key to access Wiener Linien's real-time data. Sign up here!

Usage

Use ES6 imports or require() to include the module:

// ECMAScript Import
import WienerLinien from 'wili';

// CommonJS Require
const WienerLinien = require('wili');

Example usage in script:

import WienerLinien from 'wili';

// The API key can be omitted when
// process.env.WIENER_LINIEN_API_KEY is set
const wl = new WienerLinien(API_KEY);

const options = {
  relatedLine: ['U2', 'U4', 'U6']
};

// Promise API
wl.trafficInfoList(options)
.then( data => {
  console.log(data.trafficInfos);
})
.catch( error => {
  console.error(error);
});

// async/await
(async () => {
  try {
    let data = await wl.trafficInfoList(options);
    console.log(data.trafficInfos);
  } catch (output) {
    console.error(error);
  }
})();

API

monitor

Usage: monitor(rbl, [options])

Returns real-time data for a station, including train information such as identifier or accessibility features.

Parameters:

rbl

Type: String, Integer, Array

RBL number (Rechnergestütztes Betriebsleitsystem - computer-aided operations control system), can be found this website

options.activeTrafficInfo

Type: String, Array

Disruption type (stoerungkurz, stoerunglang, or aufzugsinfo)

newsList

Usage: newsList(options)

Returns news, elevator maintenance and other information

Options

options.relatedLine

Type: String, Integer, Array

Train or bus number, e.g. U1, S7, 59A (case-insensitive)

options.relatedStop

Type: String, Integer, Array

Station ID

options.name

Type: String, Array

Information category, e.g news or aufzugsservice

trafficInfoList

Usage: trafficInfoList([options])

Returns interruption of operations and elevator outage

Options

options.relatedLine

Type: String, Integer, Array

Train or bus number, e.g. U1, S7, 59A (case-insensitive)

options.relatedStop

Type: String, Integer, Array

Station ID

options.name

Type: String, Array

Disruption type (stoerungkurz, stoerunglang, or aufzugsinfo)

License

This work is licensed under The MIT License

Donate

You are welcome to support this project using Flattr or Bitcoin 17CXJuPsmhuTzFV2k4RKYwpEHVjskJktRd