Flight Info API - Response Layout & Descriptions

Please see below for a reference table of API response field names and their descriptions.

Core Schedules Data

Field Name

Name in the Response

Description

Carrier Code

carrierCode

This field contains a carrier designator code assigned by either:

·      IATA (International Air Transport Association) a two-character code of the carrier

·      ICAO (International Civil Aviation Organization) a three-character code of the carrier.

Service Suffix

serviceSuffix

A code assigned by the administrating carrier for operational purposes.

Flight Number

flightNumber

The numeric part (up to 4 digits) of the flight number of the operation.

Sequence Number

sequenceNumber

Sequence of stopping points starting at 0.

Departure

departure

Contains field values related to departure, i.e. Airport, Terminal, Time, Date

Departure Airport

airport

The three-letter code assigned by IATA to the departure port.

Departure Terminal

terminal

The departure terminal code.

Departure Time

passengerLocalTime

The local departure time in 24-hour format HHMM, e.g. 0925.

Arrival

arrival

Contains field values related to arrival, i.e. Airport, Terminal, Time, Date

Arrival Airport

airport

The three-letter code assigned by IATA to the arrival port.

Arrival Terminal

terminal

The arrival terminal code.

Arrival Time

passengerLocalTime

The local arrival time in 24-hour format HHMM, e.g. 1430.

Aircraft Type

aircraftType

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.

Specific (or input) equipment type is the specific IATA equipment type code.

Service Type

serviceTypeCode

Indicates the utilization of the equipment whether passenger, cargo etc. Please click here for a reference list of IATA Service type codes.

Stops

numberOfStops

This is the total number of stops for the operation

Intermediate Airports

intermediateAirports

The ports at which any stops occur. These are shown as 3 letter IATA port codes.

Intermediate Airports Sequence Number

sequenceNumber

Sequence number assigned to each intermediate airport.

Note: sequence number starts at 0

Intermediate Airports Station

station

The three-character code that the operation stops at.

Codeshare

codeshare

Denotes the operating carrier of a flight where seats/space can be sold by one or more airline under its own Carrier code in a codeshare agreement. If null assume carrier code is the operator.

Operating Airline Disclosure

operatingAirlineDisclosure

Denotes the operating carrier of a flight where seats/space can be sold by one or more airline under its own Carrier code in a codeshare agreement. If null assume carrier code is the operator.

Operating Airline Disclosure Code

code

Shows the carrier that operates the service in a shared airline agreement. Where an airline integrates their schedules with another airline and sometimes shares the airline code. In a typical case some or all the services operated by a commuter airline are identified with the code of the airline with which it has a special agreement. In some cases, both carriers will show a schedule for the operation.

Operating Airline Disclosure Name

name

The name relating to the operator of the operation.

Operating Airline Disclosure Number

number

DEI number relating to operating airline disclosure (will be DEI 29 OR 127)

Aircraft Owner

aircraftOwner

The Carrier code and/or name of the owner of the equipment.

Aircraft Owner Code

code

The Carrier code of the owner of the equipment.

Aircraft Owner Name

name

The Carrier name of the owner of the equipment.

Cockpit Crew Employer

cockpitCrewEmployer

The Carrier code and/or name of the provider of the cockpit crew.

Cockpit Crew Employer Code

code

The Carrier code of the provider of the equipment.

Cockpit Crew Employer Name

name

The Carrier name of the provider of the equipment.

Cockpit Crew Employer Number

number

The Carrier number of the provider

Joint Operation Airline Designators

jointOperationAirlineDesignators

The Carrier codes, name and/or number that denote when two or three carriers jointly operate the flight.

Joint Operation Airline Designators Code

code

The Carrier codes that denote when two or three carriers jointly operate the flight.

Joint Operation Airline Designators Name

name

The Carrier names that denote when two or three carriers jointly operate the flight.

Joint Operation Airline Designators Number

number

The Carrier number that denote when two or three carriers jointly operate the flight.

Comment 010

comment010

Duplicate flight identifier for an Operating Flight. Here the Marketing Carrier Code and Service number(s) are displayed.

Comment 010 Code

code

Carrier code

Comment 010 Service Number

serviceNumber

Service Number

Comment 010 Suffix

suffix

Relates to the operation suffix

Comment 050

comment050

Duplicate flight indicator for a Marketing Flight. Here the Operating Carrier Code and Service Number is displayed.

Comment 050 Code

code

Here the Operating Carrier Code is displayed

Comment 050 Service Number

serviceNumber

Service Number is displayed

Comment 050 Suffix

suffix

Relates to the carrier suffix

Codeshare

codeshare

Denotes the operating carrier of a flight where seats/space can be sold by one or more airline under its own Carrier code in a codeshare agreement. If null assume carrier code is the operator.

Leg Days of Operation

legDaysOfOperation

The operating days of the week of the operation.

Arrival Interval Days

arrivalIntervalDays

Shows if the leg/segment arrives on a different day to when it departed

Flight

Departure Date/Time

Arrival Date/Time

Leg Arrival Interval Day

Arrival interval days

A > B

2021-04-28 23:00

2021-04-29 11:00

1

2

B > C

2021-04-29 18:00

2021-04-30 4:00

1

2

A > C

2021-04-28 23:00

2021-04-30 4:00

2

2

Leg Arrival Interval Days

legArrivalIntervalDays

The interval day of the leg

 

Extended Schedules Data

Field Name

Name in the Response

Description

Booking Classes

bookingClasses

Information relating to the Passenger Reservations Booking Designator (PRBD) and Meals.

Booking Classes Code

code

The Passenger Reservations Booking Designator (PRBD) as per IATA standard.

Booking Classes Meals

meal

The meal/s available in relation to the Passenger Reservations Booking Designator. Please click here to see a list of IATA meal codes.

Restrictions

restrictions

Information provided by a carrier to specify restrictions on carrying traffic or limitations to the carriage of traffic.

Restrictions Number

number

The number of traffic restrictions

Restrictions Code

code

The traffic restriction code.

Restrictions Pax

passenger

 

True/False value showing application of traffic restriction for this usage type.

Restrictions Cargo

cargo

True/False value showing application of traffic restriction for this usage type.

Restrictions Mail

mail

True/False value showing application of traffic restriction for this usage type.

Restrictions BoardPoint

boardPoint

True/False value showing if traffic restriction applies at the board point.

Restrictions OffPoint

offPoint

True/False value showing if traffic restriction applies at the off point.

Automated Check-in

automatedCheckIn

Identifies if the carrier offers automated check-in for the flight leg

Electronic Ticketing

electronicTicketing

Used to identify if a flight leg is an electronic ticketing candidate

Secure Flight

secureFlightIndicator

This data element is present when there is a legal requirement to disclose full Secure Flight passenger data for flights that are operated by a carrier (operating and marketing) flying to/from/within/over the U.S.

S indicates TSA regulations apply.

Government Approval

governmentApproval

Marker to show service is subject to government approval.

Plane change without aircraft change

planeChangeWithoutAircraftChange

True/False value showing if there is an equipment change enroute where the IATA Aircraft Type code is the same on each leg.

On Time Performance

onTimePerformance

A percentage indication of operations that arrive within 15 mins of the scheduled arrival time as per schedule filing.

On Time Performance Indicator

indicator

Shows on-time performance for the flight.

0 - 0-9 Percent
1 - 10-19 Percent
----
8 - 80-89 Percent
9 - 90-100 Percent

On Time Performance Delays & Cancellations Indicator

delaysAndCancellationsIndicator

Represents;

·    Operations on time arriving within 15 minutes of the scheduled arrival time (provided in DEI 501)

·    Operations that were more than 30 minutes late

·    Operations that were late more than 30 minutes more than 50% of the time

Operation cancelled, where this was more than 5% of an airline’s operation

Freight Classes

freightClasses

The freight classes indicate the type of cargo that can be loaded onto the aircraft.

Freight Classes Code

code

The freight classes code shows the type of cargo that can be loaded onto the aircraft e.g. LL (LL Unit Load Devices/containers), PP (Pallets). 

Inflight Service

inFlightServices

Denotes the use of in-flight services in relation to the IATA standard. This is a “/” separated string. Please click here to see a list of in-flight service codes.

 

Seats Information

Field Name

Name in the Response

Description

Predicted Total Seats

totalSeats

Available seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Predicted First-Class Seats

firstClass

Available First-Class seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Predicted Business Class Seats

businessClass

Available Business Class seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Predicted Premium Economy Class Seats

premiumEconomyClass

Available Premium Economy seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Predicted Economy Class Plus Seats

economyPlusClass

Available Economy Plus seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Predicted Economy Class Seats

economyClass

Available Economy seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model.

Actual Total Seats

totalSeats

Actual seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Actual First-Class Seats

firstClass

Actual First-Class seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Actual Business Class Seats

businessClass

Actual Business Class seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Actual Premium Economy Class Seats

premiumEconomyClass

Actual Premium Economy seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Actual Economy Class Plus Seats

economyPlusClass

Actual Economy Plus seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Actual Economy Class Seats

economyClass

Actual Economy seats for the operation. The value is taken from fleet information where OAG has identified the tail number of the aircraft used in the operation.

Status / Detailed Status Information

Field Name

Name in the Response

Description

Data updated at

updatedAt

Shows the date and time the data was updated

State

"state": "InGate",

Current state of the flight. A flight can be in the following states:

- Scheduled

- OutGate

- InAir

- Landed

- InGate

- Cancelled

- Diverted

Aircraft Registration Code

aircraftRegistrationNumber

The Aircraft registration/tail number

Equipment Type Code (IATA)

iata

The three-character code of the equipment type in use, as assigned by IATA.

Equipment Type Code (ICAO)

icao

The four-character code of the equipment type in use, as assigned by ICAO.

Estimated Time

outGateTimeliness

Shows one of three values; Early, OnTime, Delayed based on the estimated difference between the scheduled departure time and the estimated departure time

Time Variation

outGateVariation

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).

Local Out Gate

local

The actual local time that the aircraft will leave the gate.

UTC Out Gate

utc

The actual UTC time that the aircraft will leave the gate.

Off Ground Local

offGround

The actual local time that the aircraft will take off.

Off Ground UTC

offGround

The actual UTC time that the aircraft will take off.

Departure Airport (IATA)

airport

The three-letter code assigned by IATA to the departure port.

Departure Airport (ICAO)

airport

The three-letter code assigned by ICAO to the departure port.

Terminal

actualTerminal

The actual airport departure terminal.

Departure Gate

gate

The actual airport departure gate.

Check-In Desk

checkInCounter

The departure check-in counter.

Estimated Time of Arrival

estimatedTime

Shows one of three values; Early, OnTime, Delayed based on the estimated difference between the scheduled arrival time and the estimated arrival time

Arrival to Gate Variation

inGateVariation

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).

Estimated On Ground Local

onGround

The estimated local time that the aircraft will land.

Estimated On Ground UTC

onGround

The estimated UTC time that the aircraft will land.

Estimated In Gate Local

inGate

The estimated local time that the aircraft will arrive at the gate.

Estimated In Gate UTC

inGate

The estimated UTC time that the aircraft will arrive at the gate.

Actual time of Arrival at gate

inGateTimeliness

Shows one of three values; Early, OnTime, Delayed based on the difference between the scheduled arrival time and the actual arrival time

In gate variation

inGateVariation

The time variation between the scheduled arrival time and the actual arrival time in d.HH:mm:ss format (d is an optional number of days).

Actual on ground Local

onGround local

The actual local time that the aircraft landed.

Actual on ground UTC

onGround utc

The actual UTC time that the aircraft landed.

Actual In Gate Local

inGate local

The actual local time that the aircraft arrived at the gate.

Actual In Gate UTC

inGate utc

The actual UTC time that the aircraft arrived at the gate.

Actual Arrival Terminal

actualTerminal

The actual airport arrival terminal.

Actual Arrival Gate

gate

The actual airport arrival gate.

Arrival Baggage Counter

baggage

The arrival baggage counter.

Diverted Aircraft

diversionAirport

If a flight has been diverted this will show the three-letter code, assigned by IATA, of the actual arrival port.