Flight API

Flight Status (single day) / TIER 2

What is the status of a specific flight? What is the historical status or schedule of a specific flight on a specific date in past or in future?

This endpoint returns data about a specific flight live flight status (if the flight is within the coverage and not in distant future), or flight schedule data otherwise.

If dateLocal is specified, gets data about flight(s) departing or arriving on the day specified (local time). Otherwise, gets data about the status of flight(s) operating on the nearest date (either in past or in future).

A flight can be searched by:

  • flight number it's being operated under; or
  • ATC-callsign it's being operated under; or
  • tail-number of the aircraft it's being operated by; or
  • Mode-S 24-bit ICAO Transponder address of the aircraft it's being operated by.

Flight data may include airport of arrival and departure, scheduled and actual times, flight status, type of aircraft, tail-number and aircraft image.

Some flights may have partial data. The data may be absent for either arrival or departure airport or may not include live updates of time and status. Check quality markers inside the response to determine which data is available.

Normally, information with live status updates and estimated/actual arrival/departure times is only available for airports tracked live or with ADS-B by our system. Otherwise flight information will be with scheduled info only or absent.

To check if an airport is currently tracked and on which level, use /health/services/airports/{icao}/feeds endpoint. You can also use /health/services/feeds/{service}/airports to get the list of covered airports.

Read more about coverage and flight data limitations here: https://www.aerodatabox.com/data-coverage.

get/flights/{searchBy}/{searchParam}/{dateLocal}

Request

  • Base URL: https://api.aerodatabox.com
  • URL: https://api.aerodatabox.com/flights/{searchBy}/{searchParam}/{dateLocal}
  • 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).
dateLocalstring date-time required

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

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 dateLocal parameter shall be considered as both departure and arrival date. If a flight departs OR arrives on that date (in the local timezone of the origin or destination, respectively), it will be returned.
  • If set to Departure then the dateLocal parameter shall be considered as departure date only. Only the flights departing on that date (in the local timezone of origin) will be returned.
  • If set to Arrival then the dateLocal parameter shall be considered as arrival date only. Only the flights arriving on that date (in the local timezone of destination) will be returned.
withAircraftImageboolean

Should include aircraft image (default: false).

Aircraft images are being searched in external sources by certain criteria without any manual intervention. Therefore, false matches may be returned. Only images with licenses approved for commercial use are returned. Please be advised that you may be required to mention author attribution before using the image.

withLocationboolean

Should include real-time positional data, e.g.: location, speed, altitude, etc., if available (default: false).

withFlightPlanboolean

Should include the flight plan filed with the ATC for the flight (default: false).

  • NOTE 1: Subject to coverage. Generally may be available for flights departing from, arriving to or crossing the mainland U.S. airspace.
  • NOTE 2: Available on select pricing plans only (https://aerodatabox.com/pricing).
  • NOTE 3: If set to true and the flight plan is found for one or more flights returned, the request may be billed x 2 against your API quota on specified pricing plans (https://aerodatabox.com/pricing).

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.