See below for a reference list of response field names, and their corresponding descriptions.
Field Name |
JSON Key |
Description |
Document Type |
documentType |
Document type identifier |
State |
state |
Current state of the flight. A flight can be in the following states: Please note that the "Delayed" status is found under outGateTimeliness as well as inGateTimeliness. |
Service Type |
serviceType |
The type of service provided by the flight leg, whether it is for passengers only, cargo only, mail only, passengers & cargo, cargo & mail; common values include: J (scheduled, normal service passenger), S (scheduled, shuttle mode passenger) – check with OAG for more values |
Flight Number |
flightNumber |
The flight number assigned by the airline |
Carrier Code |
carrierCode |
Carrier designator code assigned |
IATA |
iata |
IATA (International Air Transport Association) a two-character code of the carrier |
ICAO |
icao |
ICAO (International Civil Aviation Organization) a three-character code of the carrier. |
Suffix |
serviceSuffix |
A code assigned by the administrating carrier for operational purposes. |
Equipment |
equipment |
General equipment type is the IATA generic equipment type code used to describe one or more equipment of a particular type. A 747 equipment type could describe a 747, 741, 742 or a 74R specific equipment type. |
Aircraft Type |
aircraftType |
Aircraft information |
IATA |
iata |
The three-character code of the equipment type in use, as assigned by IATA. |
ICAO |
icao |
The four-character code of the equipment type in use, as assigned by ICAO. |
Aircraft Registration Number |
aircraftRegistrationNumber |
Registration number of aircraft operating flight (ex: N935UW). The aircraft registration/tail number. Also used for General Aviation flights. |
Origination Date |
originationDate |
Flight local origination date & time |
Local |
local |
Flight local origination date & time in local time |
Departure |
Departure |
Departure information |
times |
times |
Departure times |
scheduled |
scheduled |
The departure time state, “Scheduled” |
local |
local |
The departure date & time assigned by the airline (in time zone local to the departure airport) |
Estimated |
estimated |
The departure time state, “Estimated” |
Out Gate Timeliness |
outGateTimeliness |
Departure estimated out gate timeliness. Shows one of three values; Early, OnTime or Delayed based on the estimated difference between the scheduled departure time and the estimated departure time |
Out Gate Variation |
outGateVariation |
Departure estimated out gate variation. The time variation between the scheduled departure time and the estimated departure time in d.HH:mm:ss format (d is an optional number of days). |
Out Gate |
outGate |
Departure estimated out gate time |
Local |
local |
Departure estimated out gate in local time that the aircraft will leave the gate. |
UTC |
utc |
Departure estimated out gate in UTC time that the aircraft will leave the gate. |
Off Ground |
offGround |
Departure estimated offground timing |
UTC |
utc |
Departure estimated offground in UTC time that the aircraft will take off. |
Local |
local |
Departure estimated offground in local time that the aircraft will take off. |
Actual |
actual |
The departure time state, “Actual” |
Out GateTimeliness |
outGateTimeliness |
Departure actual out gate timeliness. Shows one of three values; Early, OnTime or Delayed based on the estimated difference between the scheduled departure time and the estimated departure time |
Out GateVariation |
outGateVariation |
Departure actual out gate variation. The time variation between the scheduled departure time and the estimated departure time in d.HH:mm:ss format (d is an optional number of days). |
Out Gate |
outGate |
Departure actual out gate time |
local |
local |
Departure actual out gate in local time that the aircraft will leave the gate. |
UTC |
utc |
Departure actual out gate in UTC time that the aircraft will leave the gate. |
Off Ground |
offGround |
Departure actual offground timing |
Local |
local |
Departure actual offground in local time that the aircraft will take off. |
UTC |
utc |
Departure actual offground in UTC time that the aircraft will take off. |
Airport |
airport |
Departure airport |
IATA |
iata |
The departure iata airport code. The 3 letter IATA airport code for the departure airport |
ICAO |
icao |
The departure icao airport code. The 4 letter IATA airport code for the departure airport |
Terminal |
terminal |
The departure terminal. Terminal assignment for the flight leg at the departure airport |
Gate |
gate |
The departure gate. Gate assignment for the flight leg at the departure airport |
CheckIn Counter |
checkInCounter |
Check-in counter (if available) |
Arrival |
arrival |
Arrival information |
Times |
times |
Arrival times |
Scheduled |
scheduled |
The arrival time state, “Scheduled” |
Local |
local |
The arrival date & time assigned by the airline (in time zone local to the departure airport) |
estimated |
estimated |
The arrival time state, “Estimated” |
In Gate Timeliness |
inGateTimeliness |
Arrival estimated in gate timeliness. Shows one of three values; Early, OnTime or Delayed based on the estimated difference between the scheduled arrival time and the estimated arrival time |
In Gate Variation |
inGateVariation |
Arrival estimated in gate variation. The time variation between the scheduled arrival time and the estimated arrival time in d.HH:mm:ss format (d is an optional number of days). |
In Gate |
inGate |
Arrival estimated in gate time |
local |
local |
Arrival estimated in gate in local time that the aircraft will arrive at the gate. |
UTC |
utc |
Arrival estimated in gate in UTC time that the aircraft arrive at the gate. |
On Ground |
onGround |
Arrival estimated onground timing |
Local |
local |
Arrival estimated onground in local time that the aircraft will land. |
UTC |
utc |
Arrival estimated onground in UTC time that the aircraft will land. |
Actual |
actual |
The arrival time state, “Actual” |
In Gate Timeliness |
inGateTimeliness |
Arrival actual in gate timeliness. Shows one of three values; Early, OnTime or Delayed based on the actual difference between the scheduled arrival time and the estimated arrival time |
In Gate Variation |
inGateVariation |
Arrival actual in gate variation. The time variation between the scheduled arrival time and the estimated arrival time in d.HH:mm:ss format (d is an optional number of days). |
In Gate |
inGate |
Arrival actual in gate time |
Local |
local |
Arrival actual in gate in local time that the aircraft will arrive at the gate. |
UTC |
utc |
Arrival actual in gate in UTC time that the aircraft arrive at the gate. |
On Ground |
onGround |
Arrival actual onground timing |
Local |
local |
Arrival actual onground in local time that the aircraft will land. |
UTC |
utc |
Arrival actual onground in UTC time that the aircraft will land. |
Airport |
airport |
Departure airport |
IATA |
iata |
The arrival iata airport code. The 3 letter IATA airport code for the arrival airport |
ICAO |
icao |
The arrival icao airport code. The 4 letter IATA airport code for the arrival airport |
Terminal |
terminal |
The arrival terminal. Terminal assignment for the flight leg at the arrival airport |
Gate |
gate |
The arrival gate. Gate assignment for the flight leg at the arrival airport |
Baggage |
baggage |
Baggage claim assignment for the flight leg at the arrival airport |
DiversionAirport |
diversionAirport |
Diversion airport info |
IATA |
iata |
The diversion iata airport code. The 3 letter IATA airport code for the diversion airport |
ICAO |
icao |
The diversion icao airport code. The 4 letter IATA airport code for the diversion airport |
Message Timestamp |
messageTimestamp |
The timestamp of the source event. Its set from the Master Message transaction |
Message Id |
messageId |
An id of the source event. |
Operating Instance Key |
operatingInstanceKey |
A unique key for the schedule instance records relating to flight status event. |
Status Key |
statusKey |
A unique key for the status records relating to one flight instance. |
Marketing Instances Keys |
marketingInstancesKeys |
A unique key for the marketing schedule instance records relating to flight status event |
Optional Predicted Seat Information
Field Name |
JSON Key |
Description |
Seating Capacity |
seatingCapacity |
Predicted seating capacity info |
First Class |
firstClass |
Predicted First-Class seats for the flight. |
Business Class |
businessClass |
Predicted Business Class seats for the flight. |
Premium EconomyClass |
premiumEconomyClass |
Predicted premium economy class seats for the flight. |
Economy Plus Class |
economyPlusClass |
Predicted economy plus class seats for the flight. |
Economy Class |
economyClass |
Predicted economy class seats for the flight. |
Total Seats |
totalSeats |
Predicted total seats for the flight. |