flightstats v0.21.0

FlightStats

Install via npm

$ npm install --save flightstats

Index

• Usage
• Testing
• API Reference

Usage

var FlightStatsAPI = require( 'flightstats' )

var api = new FlightStatsAPI({
  appId: 'xxxxxxxxxx',
  apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
  // optional, defaults to `node flightstats/{package.version}`
  userAgent: 'FlightBot',
})

Get a list of airlines

// Options are optional;
// defaults to retrieve all currently active airlines
api.getAirlines( options, callback )
// Options (iata, icao, fs are mutually exclusive):
var options = {
  all: {Boolean},
  date: {Date},
  iata: {String},
  icao: {String},
  fs: {String},
}

Look up a flight by airline & flight number

api.lookup( options, callback )
// Options:
var options = {
  date: {Date},
  airlineCode: {String},
  flightNumber: {String},
  airport: {String}, // optional
  direction: {String}, // optional, defaults to `arriving`
  extendedOptions: {Array}, // optional
}

Testing

You'll need FlightStats API credentials to run the tests; Save them to an .env file in the repository root:

FLIGHTSTATS_APP_ID = xxxxxxxxxx
FLIGHTSTATS_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxx

Running the tests:

$ npm test

API Reference

See docs/API.md