iansltx/flightaware-php-client

A curl-based API client for FlightAware's FlightXML v2 API

v0.2 2017-07-10 01:57 UTC

This package is auto-updated.

Last update: 2024-11-06 18:13:36 UTC


README

This class allows for quick interaction with a (small) subset of FlightAware's FlightXML REST API. See http://flightaware.com/commercial/flightxml/explorer/ for more information.

Requirements

  1. PHP 5.5+
  2. curl
  3. A FlightAware API account

Installation

You can install this library via Composer:

composer require iansltx/flightaware-php-client

Or download the repo and require FlightAwareClient.php.

Usage

First, instantiate the client class as follows:

$faClient = new iansltx\FlightAwareClient\Client('username', 'api_key');

The following methods are available; all return unwrapped result arrays:

$inFlightInfo = $faClient->inFlightInfo($ident); // reformats waypoints with distinct latitude and longitude array keys
$flightInfoEx = $faClient->flightInfoEx($ident, $how_many, $offset);
$flightId = $faClient->getFlightId($ident, $departure_time);
$historicalTrack = $faClient->getHistoricalTrack($flight_id);
$lastTrack = $faClient->getLastTrack($ident);
$endpoint = $faClient->registerAlertEndpoint($url,$format);
$getAlertResults = $faClient->getAlerts()
$newAlertID = $faClient->setAlert($alert_id, $ident, $origin, $destination, $aircrafttype, $date_start, $date_end, $channels, $enablede, $max_weekly);
$foo = $faClient->deleteAlert($alert_id);

Contributing

Contributions/PRs are welcomed. This code is MIT licensed.

Other Notes

This library was originally built for use in http://limitless-horizons.org.