README

PHP client for the FlightStats API.

Installation

Use Composer to install this package:

composer require gvozdb/flightstats-api

Usage

Create a new Gvozdb\FlightStatsApi\FlexClient and use that to make requests to the FlightStats API:

$client = new Gvozdb\FlightStatsApi\FlexClient([
    'appId' => 'yourAppId',
    'appKey' => 'yourAppKey',
]);

// Get information about flight AA100 departing on September 5th:
$response = $client->schedules()->getFlightByDepartureDate(
    'AA',
    100
    new DateTime('2017-09-05')
);

Available APIs

The following FlightStats APIs are currently available:

Flight Status API

Flight Status API documentation

getFlightStatusById

Get the flight status from a flight associated with provided Flight ID.

$client->flightStatus()->getFlightStatusById(123456, [
    // Optional query parameters
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

getFlightStatusByArrivalDate

Get the flight status from a flight that's arriving on the given date.

$client->flightStatus()->getFlightStatusByArrivalDate('AA', 100, new DateTime('2017-09-05'), [
    // Optional query parameters
    'utc' => true,
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

getFlightStatusByDepartureDate

Get the flight status from a flight that's departing on the given date.

$client->flightStatus()->getFlightStatusByDepartureDate('AA', 100, new DateTime('2017-09-05'), [
    // Optional query parameters
    'utc' => true,
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

Airport Status API

Airport Status API documentation

getAirportStatusByArrivalDate

Get the airport status from a flight that's arriving on the given date and hour of day.

$client->airportStatus()->getAirportStatusByArrivalDate('ALA', new DateTime('2018-10-24'), (new DateTime())->format('H'), [
    // Optional query parameters
    'carrier' => 'KC',
    'numHours' => 3,
    'maxFlights' => 5,
    'utc' => false,
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

getAirportStatusByDepartureDate

Get the airport status from a flight that's departing on the given date and hour of day.

$client->airportStatus()->getAirportStatusByDepartureDate('ALA', new DateTime('2018-10-24'), (new DateTime())->format('H'), [
    // Optional query parameters
    'carrier' => 'KC',
    'numHours' => 3,
    'maxFlights' => 5,
    'utc' => false,
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

Schedules API

Schedules API documentation

getFlightByArrivalDate

$client->schedules()->getFlightByArrivalDate('AA', 100, new DateTime('2017-09-05'), [
    // Optional query parameters
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

getFlightByDepartureDate

$client->schedules()->getFlightByDepartureDate('AA', 100, new DateTime('2017-09-05'), [
    // Optional query parameters
    'extendedOptions' => [
        'includeDeltas',
    ],
]);

Note

Copyright of the name FlightStats and its API belong to FlightStats.