1.0.0 • Published 7 years ago
wmata-api-node v1.0.0
Washington Metropolitan Area Transit Authority API Node.JS Wrapper
This is a wrapper for the WMATA Web API that runs on Node.JS.
It includes helper functions to do the following:
Bus Information
- Bus positions
- Bus arrival time predictions
Train Information
- Train positions
- Train arrival time predictions
Dependencies
This project deponds on request to make HTTP requests.
Installation
$ npm install wmata-api-node --save
Usage
First, instantiate the wrapper.
var WmataApi = require('wmata-api-node');
// Instantiate the api with your api key
var wmataApi = new WmataApi('mysupersecretkey123');
Use the wrapper's methods to make requests to WMATA's web API. Methods use promises, so be sure to provide success and error handlers.
// Get bus positions for the D2 line
wmataApi.getBusPositions('D2')
.then(data => {
console.log('Bus positions', data.BusPositions);
})
.catch(err => {
console.error(err);
});
Authorization
You must provide an API key to the wrapper at instantiation. See WMATA's API documentation for steps on obtaining your free API key.
Development
Discover a bug, or have improvements? Open an issue or clone the project and send a pull request with your changes!
Running tests
You can run unit tests by executing mocha
.
1.0.0
7 years ago