Aircraft API

Single aircraft (by tail-number, Mode-S or ID) / TIER 1

Returns: Single aircraft, best matching specified search criteria, if found. Please note that all found aircraft will be impersonated with registration information matching the requested tail number or Mode-S even though an aircraft might be flying under a different registration right now.

get/aircrafts/{searchBy}/{searchParam}

Request

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

Path parameters

searchBy'Id' | 'Reg' | 'Icao24' required

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

<ul> <li><b>0 - Id</b>: ID of the aircraft (as stored in this API)</li> <li><b>1 - Reg</b>: Search by aircraft tail-number</li> <li><b>2 - Icao24</b>: Search by 24-bit ICAO Mode-S Transponder code</li> </ul>

Criteria to search aircraft by

searchParamstring required

Value of the search criteria. If searchBy is:

  • id: then this field should be an ID of an aircraft (as specified in the database of this API);
  • reg: then this field should be a tail-number of an aircraft (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ), multiple matches are possible - see below;
  • icao24, then this field should be a ICAO 24-bit Mode-S address of an aircraft specified in hexadecimal format (e.g. 484161, 483EFD), multiple matches are possible - see below.

If multiple matches are possible:

There cannot be more than one aircraft actively flying with the same tail-number or ICAO 24-bit Mode-S address at any moment of time. However, historically aircraft tail-numbers or addresses may be used multiple times by different aircraft. This endpoint is supposed to return a single aircraft data. In case if multiple aircraft satisfy the search criteria, the best match will be chosen as follows:

  • If an active aircraft is found according to the requested critera, it is returned.
  • Otherwise, an aircraft that used requested tail-number/address the most recently is returned.
  • If usage time may not be determined, the aircraft stored in the database the most recently is returned.

Query parameters

withImageboolean

Should include aircraft image (default: false).

withRegistrationsboolean

Should include the history of aircraft registrations (default: false).

Response

OK

idinteger required

Unique ID of the aircraft record in our database

regstring required

Tail-number of the aircraft

activeboolean required

Indicator if aircraft is operational under this registration

serialstring nullable

Serial number

hexIcaostring nullable

ICAO 24 bit Mode-S hexadecimal transponder address

airlineNamestring nullable

Name of the airline operating the aircraft

iataTypestring nullable

IATA-type of the aircraft

iataCodeShortstring nullable

Short variant of IATA-code of the aircraft

icaoCodestring nullable

ICAO-code of the aircraft

modelstring nullable

Model of the aircraft

modelCodestring nullable

Model code of the aircraft

numSeatsinteger nullable

Number of passenger seats

rolloutDatestring date-time nullable

Date of roll-out (UTC)

firstFlightDatestring date-time nullable

First flight date

deliveryDatestring date-time nullable

Date of delivery to the owner

registrationDatestring date-time nullable

Date of assigning current registration

typeNamestring nullable

Type name

numEnginesinteger nullable

Number of engines

engineType'Unknown' | 'Jet' | 'Turboprop' | 'Piston'
<p>Possible values:</p> <ul> <li><b>0 - Unknown</b></li> <li><b>1 - Jet</b></li> <li><b>2 - Turboprop</b></li> <li><b>3 - Piston</b></li> </ul>
isFreighterboolean required

Marker if aircraft is cargo or not

productionLinestring nullable

Production line

ageYearsnumber float nullable

Age of the aircraft in year

verifiedboolean required
numRegistrationsinteger required

An aircraft may have a history of past registrations with other airlines or operators. This field represents a total number of registration records known in our database.

Changes

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