cta-api v0.0.4

cta-api-node

Thin node wrapper for the Chicago Transit Authority API written in Node.js

Notes

I am new to node. My concentration was making this an extremely thin wrapper using only node core modules. As such, you will find no non-core dependencies. I also felt that testing would be over kill.

Responses are in XML. Take this up with Rahm.

Lots of juicy info for Chicago's developers here:

http://www.transitchicago.com/developers/

Complete list of 'L' Stops:

https://data.cityofchicago.org/Transportation/CTA-System-Information-List-of-L-Stops/8pix-ypme

Usage

Get the api keys from Chicago Trainsit above

$ export CTA_TRAIN_API_KEY=hunter2
$ export CTA_BUS_API_KEY=azureDiamond
$ node my_awesome.js

// my_awesome.js

var ctaNode = require("cta-api");

var trainApiKey = process.env.CTA_TRAIN_API_KEY
    , busApiKey = process.env.CTA_BUS_API_KEY;

ctaNode
  .train
  .arrivals
  .get({ mapid: 40360, max: 1, key: trainApiKey }, 
      function(data) { console.log("Data: " + data); },
      function(e) { console.log("Error: " + e.message); });

Trains

Official Train Tracker API:
http://www.transitchicago.com/developers/ttdocs/default.aspx

Locations

Parameters

var callback = function(data) { console.log("" + data); }
var errorCb = function(e) { console.log(e.message); }
ctaNode.train.arrivals.get({ mapid: 40360, max: 1, key: trainApiKey }, callback, errorCb)

Follow That Train

Parameters

var callback = function(data) { console.log("" + data); }
var errorCb = function(e) { console.log(e.message); }
ctaNode.train.followThisTrain.get({ runnumber: 909, key: trainApiKey }, callback, errorCb)

Locations

Parameters

var callback = function(data) { console.log("" + data); }
var errorCb = function(e) { console.log(e.message); }
ctaNode.train.locations.get({ rt: 'red', key: trainApiKey }, callback, errorCb)

Buses

Official Bus Tracker API:
http://www.transitchicago.com/assets/1/developer_center/BusTime_Developer_API_Guide.pdf

Time

  ctaNode.bus.time.get({ key: busApiKey }, callback, errorCb);

Vehicles

  ctaNode.bus.vehicles.get({ key: busApiKey, vid: [509,392] }, callback, errorCb);
  ctaNode.bus.vehicles.get({ key: busApiKey, rt: [80] }, callback, errorCb);

Routes

  ctaNode.bus.routes.get({ key: busApiKey }, callback, errorCb);

Route Directions

  ctaNode.bus.routes.get({ key: busApiKey }, callback, errorCb);

  ctaNode.bus.directions.get({ key: busApiKey, rt: 80 }, callback, errorCb);

Stops

  ctaNode.bus.stops.get({ key: busApiKey, rt: 80, dir: "Westbound" }, callback, errorCb);

Patterns

  ctaNode.bus.patterns.get({ key: busApiKey, rt: 80, vid: 909, top: 5 }, callback, errorCb);

Predictions

  ctaNode.bus.predictions.get({ key: busApiKey, rt: 20, stpid: 456 }, callback, errorCb);

Service Bulletins

  ctaNode.bus.bulletins.get({ key: busApiKey, rt: 20, stpid: 456 }, callback, errorCb);

Alerts

Gives you information on stop/station outages and signifant alerts.

No options.
There appears to be HTML in some of the alerts. Take it up with Rahm.

var callback = function(data) { console.log("" + data); }
var errorCb = function(e) { console.log(e.message); }
ctaNode.customerAlerts.routeStatus.get({}, callback, errorCb);
ctaNode.customerAlerts.detailedAlerts.get({}, callback, errorCb);

Contribute

Fork, code, pull request