Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

transperthapi

1.0.3 • Public • Published

TransPerth API

Build Status Coverage Status

This is an API that allows read-only access to information from TransPerth such as the scheduled arrival time of trains, buses and ferries at stopping points as well as SmartRider data.

Documentation

Documentation for this project can be found at maxrumsey.xyz.

Example

These examples fetch data from a SmartRider as well as the expected arrival time of a bus.

SmartRider

const transperth = require('transperthapi');
const Client = new transperth();
Client.smartRiderInfo('SR 1234 5678 9') // Example SmartRider Number
  .then(data => {
    if (data.error) throw new Error(data.error);
 
    console.log(data);
 
    //  {
    //    balance: '$XX.XX',
    //    conc_type: '' || 'Concession Description',
    //    conc_expirt: 'XX/XX/XX',
    //    autolad: 'True | False'
    //    meta: { endpoint: 'http://...' }
    //  }
  })
  .catch(e => {
    throw e;
  })

Bus Times

const transperth = require('transperthapi');
const Client = new transperth();
Client.busTimes('XXXXX') // Example Bus Stop Number
  .then(data => {
    if (data.error) throw new Error(data.error);
 
    console.log(data);
 
    /*
      { buses:
        [ { route: '000', time: 'XX:XX', destination: 'To XXX' },
          {...}],
        meta:
          { endpoint: 'http://...' } }
    */
  })
  .catch(e => {
    throw e;
  })

Keywords

none

Install

npm i transperthapi

DownloadsWeekly Downloads

2

Version

1.0.3

License

MIT

Unpacked Size

25.9 kB

Total Files

14

Last publish

Collaborators

  • avatar