Flight API

Flight History and Schedule (range of days) / TIER 3

What is the history or schedule of a specific flight within a specific range of dates in past or in future?

This endpoint is the similar to the Flight status endpoint. The only difference is that instead of returning the flight data on a single date, it returns the data over a range of dates, thus allowing to get insights on the flight history or schedule within the specified range.

All limitations and considerations applicable to Flight status endpoint are applicable to this endpoint as well.

get/flights/{searchBy}/{searchParam}/{dateFromLocal}/{dateToLocal}

Request

  • Base URL: https://api.aerodatabox.com
  • URL: https://api.aerodatabox.com/flights/{searchBy}/{searchParam}/{dateFromLocal}/{dateToLocal}
  • Auth: API key in header X-Api-Key

Path parameters

searchBy'Number' | 'Reg' | 'CallSign' | 'Icao24' required

Criteria to search flight by<p>Possible values:</p>

<ul> <li><b>0 - Number</b>: Search by flight number</li> <li><b>1 - Reg</b>: Search by aircraft registration</li> <li><b>2 - CallSign</b>: Search by ATC call-sign</li> <li><b>3 - Icao24</b>: Search by 24-bit ICAO Mode-S Transponder code</li> </ul>

Criteria to search flight by

searchParamstring required

Value of the search criteria. If searchBy is:

  • number, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)
  • callsign, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);
  • reg, then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);
  • icao24, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD).
dateFromLocalstring date-time required

Beginning of the range of local dates of departure or arrival (in format: YYYY-MM-DD, e.g.: 2019-08-29). Maximum/minimum allowable value is determined by the current data coverage limitations and your pricing plan.

dateToLocalstring date-time required

End of the range of local dates of departure or arrival (in format: YYYY-MM-DD, e.g.: 2019-08-29). Maximum/minimum allowable value is determined by the current data coverage limitations and your pricing plan. This date must be bigger than the dateFromLocal. The maximum difference between this date and dateFromLocal is limited and is determined by your pricing plan (ranging from 7 to 30 days as per moment of writing).

Query parameters

dateLocalRole'Arrival' | 'Departure' | 'Both'

Direction of flight<p>Possible values:</p>

<ul> <li><b>1 - Arrival</b></li> <li><b>2 - Departure</b></li> <li><b>3 - Both</b></li> </ul>
  • If set to Both (default, recommended for best results) then the dateFromLocal and dateToLocal parameters shall be considered as both departure and arrival dates. If a flight departs OR arrives on dates within the specified range (in the local timezone of the origin or destination, respectively), it will be returned.
  • If set to Departure then the dateFromLocal and dateToLocal parameters shall be considered as departure dates only. Only the flights departing on dates within the specified rang(in the local timezone of origin) will be returned.
  • If set to Arrival then the dateFromLocal and dateToLocal parameters shall be considered as arrival dates only. Only the flights arriving on dates within the specified rangd (in the local timezone of destination) will be returned.

Response

OK

lastUpdatedUtcstring date-time required

Time (UTC) of the latest update of flight information (excluding Location)

numberstring required

Flight Number

callSignstring nullable

ATC call-sign of the flight

status'Unknown' | 'Expected' | 'EnRoute' | 'CheckIn' | 'Boarding' | 'GateClosed' | 'Departed' | 'Delayed' | 'Approaching' | 'Arrived' | 'Canceled' | 'Diverted' | 'CanceledUncertain' required

Flight progress status<p>Possible values:</p>

<ul> <li><b>0 - Unknown</b>: Status is not available for this flight</li> <li><b>1 - Expected</b>: Expected</li> <li><b>2 - EnRoute</b>: En route</li> <li><b>3 - CheckIn</b>: Check-in is open</li> <li><b>4 - Boarding</b>: Boarding in progress / Last call</li> <li><b>5 - GateClosed</b>: Gate closed</li> <li><b>6 - Departed</b>: Departed</li> <li><b>7 - Delayed</b>: Delayed</li> <li><b>8 - Approaching</b>: On approach to destination</li> <li><b>9 - Arrived</b>: Arrived</li> <li><b>10 - Canceled</b>: Cancelled</li> <li><b>11 - Diverted</b>: Diverted to another destination</li> <li><b>12 - CanceledUncertain</b>: Status of the flight is uncertain, may be cancelled</li> </ul>
codeshareStatus'Unknown' | 'IsOperator' | 'IsCodeshared' required

Flight code-share status<p>Possible values:</p>

<ul> <li><b>0 - Unknown</b>: Code-sharing information is unavailable for this flight. Flight might be operated both by airline owning the flight number as well as by another airliner.</li> <li><b>1 - IsOperator</b>: Flight is operated by an airline owning the flight number (the same code)</li> <li><b>2 - IsCodeshared</b>: Flight is code-shared (operated by an airline other than airline owning the flight number)</li> </ul>
isCargoboolean required

Is cargo flight

Changes

No recorded changes to this operation across all 1 revision of this API.