Please see below for a reference table of Master Data API response field names and their descriptions.
Notes:
• The order and categorisation of the data points may not be as shown in the product.
• Each API endpoint (equipment, carrier and locations) is sold separately. If you see a field you are interested in receiving, please speak to your account manager.
Carriers API
Request parameters:
|
Name |
Type |
Example |
Description |
|
CarrierCode |
string |
A0,EFW |
A code assigned by IATA or ICAO to a carrier. Accepts comma separated values. |
|
CodeType |
string |
IATA,ICAO |
Code type for Carriers. Code type values are IATA or ICAO. Accepts comma separated values. |
|
CarrierName |
string |
BA EUROFLYER DBA BRITISH AIRWAYS |
Carrier name. Search for carriers by full or partial carrier names. Accepts comma separated values. |
|
PublishingCarrier |
boolean |
TRUE |
Search only among carriers that can have commercial schedules published by OAG. Accepts ‘True’ / ‘False’. |
|
Limit |
integer |
100 |
Maximum number of carriers to return. If specified, the value should be between 1 and 1000. |
|
After |
string |
202301010000-1669289217243000000 |
A cursor after refers to a random string of characters which marks a specific item in a list of data. |
Response fields:
| Field Name | Name in the response | Description |
|
IATA Code |
code.iata |
A two-character code assigned by IATA (International Air Transport Association) to a carrier. |
|
ICAO Code |
code.icao |
A three-character code assigned by ICAO (International Civil Aviation Organization) to a carrier. |
|
Publishing Carrier |
publishingCarrier |
Only carriers with this response field set to True will have schedules published by OAG. Can either be true or false. |
|
Duplicate Carrier |
duplicateCarrier |
Indicates whether the carrier code is a duplicate. Can either be true or false. |
|
IATA Code Rank |
iataCodeRank |
IATA carrier code rank. |
|
IATA Code Assignment Category Code |
iataCodeAssignmentCategory.code |
IATA code assignment category. |
|
IATA Code Assignment Category Description |
iataCodeAssignmentCategory.description |
Description forthe IATA code assignment category. |
|
Alliances |
alliances |
Alliance membership of the airline. |
|
Name |
name |
Carrier name. E.g., ‘Lulutai Airlines Limited’. |
|
IATA Carrier Legal Name |
alternativeName.iata.legal |
IATA legal carrier name for the airline e.g., ‘Lulutai Airlines Limited’. |
|
IATA Carrier Display Name |
alternativeName.iata.display |
IATA display carrier name for Joint Venture and Leased Operations e.g., ‘dba Lulutai Airlines’. |
|
ICAO Carrier Name |
alternativeName.icao |
ICAO carrier name. |
|
IATA Accounting Prefix |
iataAccountingPrefix |
IATA accounting prefix. |
|
ICAO Telephony Name |
icaoTelephonyName |
ICAO telephony name. |
|
Domicile City Name |
domicile.city.name |
Name for carrier's domicile city. |
|
Domicile State Name |
domicile.state.name |
Name for carrier's domicile state. |
|
Domicile Country Name |
domicile.country.name |
Name for carrier's domicile country. |
|
Domcile Country Code ISO |
domicile.country.code.iso |
ISO code for carrier's domicile country. |
|
Domicile Country Code DOT |
domicile.country.code.dot |
DOT (U.S. Department of Transportation) code for carrier's domicile country. |
|
Domicile Region Name |
domicile.region.name |
Name for carrier’s domicile region. |
Locations API
Request parameters:
|
Name |
Type |
Example |
Description |
|
AirportCode |
string |
JFK,ZAL,TFS,GCTS |
The code assigned by the IATA/ICAO/FAA to an airport. Accepts comma separated values. |
|
CodeType |
string |
IATA,ICAO,FAA |
The code type for Airports. Code type values are IATA, ICAO and FAA. Accepts comma separated values. |
|
CountryCode |
string |
ES |
The two letter ISO code of a country where an airport is located in. Accepts comma separated values. |
|
CityCode |
string |
TCI |
The code of a city where an airport is located in. Accepts comma separated values. |
|
Limit |
integer |
100 |
The maximum number of locations to return. If specified, the value should be between 1 and 1000. |
|
After |
string |
202301010000-1669289217243000000 |
The cursor after refers to a random string of characters which marks a specific item in a list of data. |
Response fields:
|
Field Name |
Name in the response |
Description |
|
IATA Code |
code.iata |
The three-character airport code by IATA. E.g., LGW, STN. |
|
ICAO Code |
code.icao |
The four-character airport code by ICAO. E.g., EBFS. |
|
FAA Code |
code.faa |
The four-character airport code by FAA. E.g., 35IL. |
|
Location Type |
type |
The location type. E.g., Airport, Heliport. |
|
Location Name |
name |
The primary Airport Name. |
|
IATA Location Name |
alternativeName.iata |
The airport name from IATA. E.g., London Gatwick. |
|
ICAO Location Name |
alternativeName.icao |
The airport name from ICAO. E.g., Florennes Air Base. |
|
FAA Location Name |
alternativeName.faa |
The airport name from FAA. E.g., Clarion Field Airport |
|
Terminal Code |
terminals.code |
The code for the airport terminal. E.g., ‘B’ |
|
Terminal Name |
terminals.name |
The name of the terminal. E.g., ‘Terminal B’ |
|
City Code |
place.city.code |
The code of the city where the airport is located. |
|
City Name |
place.city.name |
The name of the city where the airport is located. |
|
State Code |
place.state.code |
The code of the state where the airport is located. |
|
Country Code |
place.country.code |
The two letter ISO code of a country where an airport is located in. |
|
Country Name |
place.country.name |
The name of the country where an airport is located in. |
|
Latitude in Degrees Minutes Seconds |
place.latitude.degreesMinutesSeconds |
The latitude shown in degrees, minutes and seconds. |
|
Latitude in Decimal Degrees |
place.latitude.decimalDegrees |
The latitude shown in decimal degrees. |
|
Longitude in Degrees Minutes Seconds |
place.longitude.degreesMinutesSeconds |
The longitude shown in degrees, minutes and seconds |
|
Longitude in Decimal Degrees |
place.longitude.decimalDegrees |
The longitude shown in decimal degrees. |
|
Timezone Code IATA |
timezone.code.iata |
The numerical designator code for the time zone by IATA. E.g., ‘01’ |
|
Standard UTC Variation |
timezone.standardUtcVariation |
The normal time variation from GMT/UT. E.g., "+0200" |
|
DST Sequence number |
timezone.daylightSavingTime.sequenceNumber |
The DST record sequence number. |
|
DST variation |
timezone.daylightSavingTime.variation |
The time variation from GMT/UTC when DST is applied. E.g., ‘+0300’ |
|
DST Start DateTime |
timezone.daylightSavingTime.startDateTime |
The local date and time at which DST begins. E.g., ‘2023-03-26T00:03:00’ |
|
DST End DateTime |
timezone.daylightSavingTime.endDateTime |
The local date and time at which DST ends. E.g., "2023-10-29T04:00:00" |
|
DST Start Status Marker |
timezone.daylightSavingTime.startStatusMarker |
IATA and OAG are advised of time changes by many sources. These are verified by the national carrier and / or the government. If the information is confirmed is labeled as ‘K'. If the information is not confirmed it is considered to be estimated and marked with an 'E’. |
|
DST End Status Marker |
timezone.daylightSavingTime.endStatusMarker |
IATA and OAG are advised of time changes by many sources. These are verified by the national carrier and / or the government. If the information is confirmed is labeled as ‘K'. If the information is not confirmed it is considered to be estimated and marked with an 'E’. |
Equipment API
Request parameters:
|
Name |
Type |
Example |
Description |
|
AircraftCode |
string |
32A,A320 |
An aircraft type code assigned by IATA, ICAO or FAA to an aircraft. Accepts comma separated values. |
|
CodeType |
string |
IATA,ICAO |
Code type for aircraft/equipment types. Code type values are IATA, ICAO or FAA. Accepts comma separated values. |
|
IataManufacturerName |
string |
Airbus |
Aircraft/equipment manufacturer name. Search for Aircraft types by full or partial manufacturer names. Accepts comma separated values. |
|
IataModelName |
string |
A320 Passenger (sharklets) |
Aircraft model name. Search for aircraft/equipment types by full or partial aircraft model names. Accepts comma separated values. |
|
Limit |
integer |
100 |
Maximum number of aircraft/equipment types to return. If specified, the value should be between 1 and 1000. |
|
After |
string |
202301010000-1669289217243000000 |
A cursor after refers to a random string of characters which marks a specific item in a list of data. |
Response fields:
|
Field Name |
Name in the response |
Description |
|
IATA Code |
code.iata |
A three-character code assigned by IATA to an aircraft/equipment type. E.g., ‘CR1’. |
|
ICAO Code |
code.icao |
A two to four-character code assigned by ICAO to an aircraft/equipment type. E.g., ‘CRJ1’. |
|
FAA Code |
code.faa |
An up to four characters code assigned by FAA to an aircraft/equipment type. In some exceptions can have an asterisk at the end of the code as an additional character. E.g., CRJ1 |
|
IATA Group |
iataGroup |
The 3-character designator code of the aircraft/equipment group assigned by IATA. E.g., 'CNJ'. |
|
ICAO Class |
class.icao |
The description of the aircraft/equipment. E.g., ‘Landplane’. |
|
FAA Class |
class.faa |
The description of the aircraft/equipment category class. E.g., ‘Fixed-wing’. |
|
Engine Type |
engine.type |
The type of engine of an aircraft/equipment. E.g., ‘J'=Jet, ‘P’=Piston, ‘T’=Turboprop/Turboshaft, ‘E’= Electric, ‘R’= Rocket, '?’= Unknown. |
|
Engine Count |
engine.count |
The number of engines that the aircraft/equipment has. |
|
Body type code |
bodyCode |
The aircraft/equipment body type. 'N' = Narrow-body and 'W’ = Wide-body. |
|
Freight Classes |
freightClasses |
A list of freight class codes that an equipment can carry. ‘LL' = Unit Load Devices (containers), 'P’=Pallets. |
|
IATA Category Code |
category.iata.code |
The IATA designator code that denotes the Aircraft Category. E.g., '2J'. |
|
IATA Category Description |
category.iata.description |
The description of the IATA’s aircraft/equipment category. E.g., ‘Jet-engined aircraft’. |
|
ICAO Category Code |
category.icao.code |
The ICAO designator code that denotes the aircraft/equipment category. E.g., 'L2J'. |
|
IATA Manufacturer Name |
specification.iata.manufacturer.name |
The name of aircraft/equipment manufacturer. E.g., ‘Canadair (Bombardier)’, 'CANADAIR'. |
|
IATA Model |
specification.iata.model |
The model name of the aircraft/equipment provided by IATA. E.g., ‘Regional Jet 100’. |
|
ICAO Manufacturer Name |
specification.icao.manufacturer.name |
The name of aircraft/equipment manufacturer. E.g., ‘Canadair (Bombardier)’, 'CANADAIR'. |
|
ICAO Model Name |
specification.icao.model.name |
The name of aircraft/equipment model. E.g., 'REGIONAL JET CRJ-100'. |
|
ICAO Model Number |
specification.icao.model.number |
The number of aircraft/equipment model. E.g., 'CL-600'. |
|
ICAO Wake Turbulence Category |
specification.icao.wakeTurbulence.category |
The wake turbulence category of the aircraft. E.g., ‘M'='MEDIUM', ‘L’=’LIGHT', ‘H'=’HEAVY'. |
|
ICAO Wake Turbulence group |
specification.icao.wakeTurbulence.group |
The wake turbulence group of the aircraft. E.g., 'E'. |
|
FAA Category |
specification.faa.category |
The FAA category of the aircraft/equipment. E.g., '2J/L'. |
|
FAA Manufacturer Name |
specification.faa.manufacturer.name |
The name of aircraft/equipment manufacturer. E.g., ‘Canadair (Bombardier)’, 'CANADAIR'. |
|
FAA Manufacturer Full Names |
specification.faa.manufacturer.fullNames |
A list of full names for the aircraft/equipment manufacturer provided by FAA. E.g., 'BOMBARDIER AEROSPACE CANADAIR (CANADA)'. |
|
FAA Model |
specification.faa.model |
The model name of the aircraft/equipment. E.g., 'CL-600 REGIONAL JET CRJ-100'. |
|
FAA Wake Turbulence Category |
specification.faa.wakeTurbulence.category |
The wake turbulence category of the aircraft. E.g., ‘M'='MEDIUM', ‘L’=’LIGHT', ‘H'=’HEAVY'. |
|
FAA Wake Turbulence group |
specification.faa.wakeTurbulence.group |
The wake turbulence group of the aircraft. E.g., 'E'. |