SITA Historical Flight Status API
- 1 Revision History
- 2 Registration and API Sign Up
- 3 SITA Historical Flight Status API
- 3.1 Resources
- 3.2 Flights V2
- 3.2.1 GET Get Flight by Airline and Flight Number
- 3.2.2 GET Get Flights by Airport, Airline and Direction
- 3.2.3 GET Get Flights by Airport and Direction
- 3.2.4 GET Get Flight Updates by Airport, Airline and Flight Number
- 3.2.5 GET Get Flight Updates by Airport and Airline
- 3.2.6 GET Get Flight Updates by Airport
- 4 Error Response
- 5 Notes
- 6 Appendix A - Status Codes
- 7 Appendix B - V2 Flight Details Response Schema
- 8 Appendix C - V2 Flight Updates Response Schema
- 9 Appendix D - Update Fields
- 10 Appendix E - Flights Response Examples
- 11 Appendix F - Historical Flight Use Cases
1 Revision History
| Date | Version | Description | Author |
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2 Registration and API Sign Up
To access the APIs you will need a registration key, also known as an API key. These can be obtained by creating an account on https://www.developer.aero/ and registering your interest for access to the API.
2.1 API Key Usage
The API key will be passed in an HTTP header as follows:
-
Name of header: x-apikey
-
Value of header: The API key as generated for the application.
2.2 Security
-
All incoming requests will be REST over HTTPS.
-
Users are authenticated using their API key.
-
Certain response payload elements will be filtered based on permissions associated with the x-apikey value used.
[[SITA Historical Flight Status API]]
3 SITA Historical Flight Status API
The SITA Historical Flight Status API is a REST based service which provides information about flights around the world.
A user may
-
Search for the flight details based on a combination of airport, airline and flight number details
-
Search for flight updates created within a specific time window. These can be at a global level or filtered to an airport/airline/flight number level
3.1 Resources
This section describes each SITA Historical Flight Status API service.
Detailed API structure, example requests and responses, JSON schema for request (where appropriate) and responses, and error response codes and formats are included.
3.2 Flights V2
3.2.1 GET Get Flight by Airline and Flight Number
Retrieve a single flight according to airline and flight number showing both the departure and arrival flight details. Results are filtered by operation date (default is current UTC date).
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
operationDate
In this scenario the operationDate is considered to be the local date on which the flight departed/arrived.
operationDate & searchByUTC
A user can force the operationDate value to be considered as UTC by providing the parameter 'searchByUTC=true'.
Path parameters
| Parameter | Description |
|---|---|
|
|
2-character airline IATA code or 3-character airline ICAO code |
|
|
Flight number |
Request parameters
| Parameter | Description |
|---|---|
|
|
Local date of operation (yyyy-MM-dd). Default value is current UTC date |
|
|
Search based by UTC. Default value is false |
|
|
Include cargo flights. Default value is false |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Name used to identify the slot |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
3-character airport IATA code |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Calculated Delay Prediction |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Calculated Delay Prediction |
|
|
|
Name used to identify the slot internally |
|
|
|
Custom Properties |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Stand Slots |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Recovery flight |
|
|
|
Carousel Slots |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Key value used to identify a custom property |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Route |
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
3-character airport IATA code |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Estimated Landing Time |
|
|
|
Route |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
|
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
Airport |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Actual Take Off Time |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Departure |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Actual Off Block Time |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Total number of adults |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Actual In Block Time |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
|
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Total number of reduced mobility passengers e.g those requiring assistance boarding the aircraft etc. |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
Carousel Slots |
|
|
|
Stand Slots |
|
|
|
Name used to identify the slot |
|
|
|
Actual Landing Time |
|
|
|
Name used to identify the slot |
|
|
|
Events |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Events |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
The actual local time at which the aircraft arrived at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot internally |
|
|
|
Key value used to identify a custom property |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The actual local time at which the aircraft landed on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Custom Properties |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total weight of bags/pieces |
|
|
|
Actual number of 1st class passengers |
|
|
|
IATA code for the aircraft |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Load breakdown |
|
|
|
Actual number of passengers |
|
|
|
Aircraft |
|
|
|
Total number of mail pieces |
|
|
|
Actual number of economy class passengers |
|
|
|
Specific aircraft model details |
|
|
|
Flight number e.g 1234 |
|
|
|
Total number of cargo pieces |
|
|
|
Actual number of business class passengers |
|
|
|
ICAO code for the aircraft |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Total number of booked 1st class passengers |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Total number of infants |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Total number of children |
|
|
|
Total number of booked passengers |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Original flight |
|
|
|
Recovery flight |
|
|
|
Original flight |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
Marketing Carriers |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total number of bags/pieces |
|
|
|
Total number of booked economy class passengers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Diversion |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Diversion |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Flight number e.g 1234 |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Baggage |
|
|
|
Total number of booked business class passengers |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Take Off Time |
|
|
|
Flight number e.g 1234 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Off Block Time |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
UTC timestamp when last update update was applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Estimated Take Off Time |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Estimated Off Block Time |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Data source of the last update applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Estimated In Block Time |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Metadata |
|
|
|
The estimated local time at which the aircraft is expected at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Actual number of transit passengers |
|
|
|
Call-sign for the aircraft type |
|
|
|
Flight Identifier |
|
|
|
The estimated local time at which the aircraft is expected to land on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Actual number of transfer passengers |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Operating Carrier |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
The actual local time at which the aircraft left the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Arrival |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Passengers |
|
|
|
Flight number e.g 1234 |
|
|
|
Flight number e.g 1234 |
|
|
|
A message related to the prediction |
|
|
|
The actual local time at which the aircraft left the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
A message related to the prediction |
|
|
|
Flight Stats |
|
|
|
Flight Records |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/airline/UL/flightNumber/1512?operationDate=2021-04-01' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3330
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"aircraft" : {
"iataCode" : "321",
"icaoCode" : "A321",
"model" : "A321",
"registration" : "4RAND"
}
},
"flightStats" : {
"passengers" : {
"bookedTotal" : "120",
"adult" : "109",
"child" : "2",
"infant" : "2"
},
"baggage" : {
"count" : "235",
"load" : "3661",
"cargo" : "0",
"mail" : "0"
}
},
"departure" : {
"airport" : {
"iataCode" : "CMB",
"cityText" : "Colombo"
},
"scheduled" : "2021-04-01T12:25:00+04:00",
"estimated" : "2021-04-01T14:43:00+05:30",
"actual" : "2021-04-01T13:48:00+05:30",
"status" : "DP",
"statusText" : "Departed",
"terminal" : "T1",
"gate" : "C3",
"stand" : "401R",
"checkIn" : "F10",
"chute" : "S1",
"standSlots" : [ {
"name" : "401R",
"externalName" : "401R",
"startTime" : "2021-04-01T11:06:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Sector 4C"
} ],
"checkinSlots" : [ {
"name" : "F10",
"externalName" : "F10",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F11",
"externalName" : "F11",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F12",
"externalName" : "F12",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F8",
"externalName" : "F8",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F9",
"externalName" : "F9",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
} ],
"gateSlots" : [ {
"name" : "C3",
"externalName" : "C3",
"startTime" : "2021-04-01T11:18:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Pier C Contact"
} ],
"chuteSlots" : [ {
"name" : "S1",
"externalName" : "S1",
"startTime" : "2021-04-01T09:25:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Chutes"
} ],
"route" : [ {
"sequenceNumber" : 0
} ],
"customProperties" : [ {
"key" : "S---_Status",
"value" : "SCH"
} ],
"events" : {
"AOBT" : "2021-04-01T12:18:00+04:00",
"ATOT" : "2021-04-01T12:26:00+04:00",
"EOBT" : "2021-04-01T13:13:00+04:00"
},
"delayPrediction" : {
"minutes" : 65,
"prediction" : "2021-04-01T13:30:00+04:00"
}
},
"serviceType" : "J",
"duration" : 255
} ]
}
3.2.2 GET Get Flights by Airport, Airline and Direction
Retrieve all flights arriving to or departing from a specified airport for a given airline. Results are filtered by operation date (default is current UTC date).
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
operationDate
If the operation date is not provided the search is based on the current UTC date/time. The search window will be current UTC date/time → current UTC date/time + 4 hours (futureWindow default value).
The user can adjust the search window by providing values for the pastWindow/futureWindow in their request.
If the operation date is provided the search window will be operationDate (00:00:00) → operationDate + 4 hours (futureWindow default value) e.g. 2021-01-12 00:00:00 → 2021-01-12 04:00:00.
In this scenario the operationDate is considered to be the local date on which the flight departed/arrived.
The user can adjust the search window by providing values for the pastWindow/futureWindow in their request.
operationDate & searchByUTC
A user can force the operationDate value to be considered as UTC by providing the parameter 'searchByUTC=true'. By doing so the user has the ability to search for flights in the past/future based on UTC date/time.
Path parameters
| Parameter | Description |
|---|---|
|
|
3-character airport IATA code or 4-character airport ICAO code |
|
|
2-character airline IATA code or 3-character airline ICAO code |
|
|
1-character direction indicator (A/D) |
Request parameters
| Parameter | Description |
|---|---|
|
|
Local date of operation (yyyy-MM-dd). Default value is current UTC date |
|
|
Search based by UTC. Default value is false |
|
|
Include cargo flights. Default value is false |
|
|
Filter results based on origin or destination airport |
|
|
View 'full' or 'local' leg, based on direction. Default value is local. See notes for further details. |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Name used to identify the slot |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
3-character airport IATA code |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Calculated Delay Prediction |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Calculated Delay Prediction |
|
|
|
Name used to identify the slot internally |
|
|
|
Custom Properties |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Stand Slots |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Recovery flight |
|
|
|
Carousel Slots |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Key value used to identify a custom property |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Route |
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
3-character airport IATA code |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Estimated Landing Time |
|
|
|
Route |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
|
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
Airport |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Actual Take Off Time |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Departure |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Actual Off Block Time |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Total number of adults |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Actual In Block Time |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
|
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Total number of reduced mobility passengers e.g those requiring assistance boarding the aircraft etc. |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
Carousel Slots |
|
|
|
Stand Slots |
|
|
|
Name used to identify the slot |
|
|
|
Actual Landing Time |
|
|
|
Name used to identify the slot |
|
|
|
Events |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Events |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
The actual local time at which the aircraft arrived at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot internally |
|
|
|
Key value used to identify a custom property |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The actual local time at which the aircraft landed on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Custom Properties |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total weight of bags/pieces |
|
|
|
Actual number of 1st class passengers |
|
|
|
IATA code for the aircraft |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Load breakdown |
|
|
|
Actual number of passengers |
|
|
|
Aircraft |
|
|
|
Total number of mail pieces |
|
|
|
Actual number of economy class passengers |
|
|
|
Specific aircraft model details |
|
|
|
Flight number e.g 1234 |
|
|
|
Total number of cargo pieces |
|
|
|
Actual number of business class passengers |
|
|
|
ICAO code for the aircraft |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Total number of booked 1st class passengers |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Total number of infants |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Total number of children |
|
|
|
Total number of booked passengers |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Original flight |
|
|
|
Recovery flight |
|
|
|
Original flight |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
Marketing Carriers |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total number of bags/pieces |
|
|
|
Total number of booked economy class passengers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Diversion |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Diversion |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Flight number e.g 1234 |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Baggage |
|
|
|
Total number of booked business class passengers |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Take Off Time |
|
|
|
Flight number e.g 1234 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Off Block Time |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
UTC timestamp when last update update was applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Estimated Take Off Time |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Estimated Off Block Time |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Data source of the last update applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Estimated In Block Time |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Metadata |
|
|
|
The estimated local time at which the aircraft is expected at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Actual number of transit passengers |
|
|
|
Call-sign for the aircraft type |
|
|
|
Flight Identifier |
|
|
|
The estimated local time at which the aircraft is expected to land on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Actual number of transfer passengers |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Operating Carrier |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
The actual local time at which the aircraft left the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Arrival |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Passengers |
|
|
|
Flight number e.g 1234 |
|
|
|
Flight number e.g 1234 |
|
|
|
A message related to the prediction |
|
|
|
The actual local time at which the aircraft left the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
A message related to the prediction |
|
|
|
Flight Stats |
|
|
|
Flight Records |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/airport/MCT/airline/UL/direction/D?operationDate=2021-04-01' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3330
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"aircraft" : {
"iataCode" : "321",
"icaoCode" : "A321",
"model" : "A321",
"registration" : "4RAND"
}
},
"flightStats" : {
"passengers" : {
"bookedTotal" : "120",
"adult" : "109",
"child" : "2",
"infant" : "2"
},
"baggage" : {
"count" : "235",
"load" : "3661",
"cargo" : "0",
"mail" : "0"
}
},
"departure" : {
"airport" : {
"iataCode" : "CMB",
"cityText" : "Colombo"
},
"scheduled" : "2021-04-01T12:25:00+04:00",
"estimated" : "2021-04-01T14:43:00+05:30",
"actual" : "2021-04-01T13:48:00+05:30",
"status" : "DP",
"statusText" : "Departed",
"terminal" : "T1",
"gate" : "C3",
"stand" : "401R",
"checkIn" : "F10",
"chute" : "S1",
"standSlots" : [ {
"name" : "401R",
"externalName" : "401R",
"startTime" : "2021-04-01T11:06:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Sector 4C"
} ],
"checkinSlots" : [ {
"name" : "F10",
"externalName" : "F10",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F11",
"externalName" : "F11",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F12",
"externalName" : "F12",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F8",
"externalName" : "F8",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F9",
"externalName" : "F9",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
} ],
"gateSlots" : [ {
"name" : "C3",
"externalName" : "C3",
"startTime" : "2021-04-01T11:18:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Pier C Contact"
} ],
"chuteSlots" : [ {
"name" : "S1",
"externalName" : "S1",
"startTime" : "2021-04-01T09:25:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Chutes"
} ],
"route" : [ {
"sequenceNumber" : 0
} ],
"customProperties" : [ {
"key" : "S---_Status",
"value" : "SCH"
} ],
"events" : {
"AOBT" : "2021-04-01T12:18:00+04:00",
"ATOT" : "2021-04-01T12:26:00+04:00",
"EOBT" : "2021-04-01T13:13:00+04:00"
},
"delayPrediction" : {
"minutes" : 65,
"prediction" : "2021-04-01T13:30:00+04:00"
}
},
"serviceType" : "J",
"duration" : 255
} ]
}
3.2.3 GET Get Flights by Airport and Direction
Retrieve all flights arriving to or departing from a specific airport. Results are filtered by operation date (default is current UTC date).
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
operationDate
If the operation date is not provided the search is based on the current UTC date/time. The search window will be current UTC date/time → current UTC date/time + 4 hours (futureWindow default value).
The user can adjust the search window by providing values for the pastWindow/futureWindow in their request.
If the operation date is provided the search window will be operationDate (00:00:00) → operationDate + 4 hours (futureWindow default value) e.g. 2021-01-12 00:00:00 → 2021-01-12 04:00:00.
In this scenario the operationDate is considered to be the local date on which the flight departed/arrived.
The user can adjust the search window by providing values for the pastWindow/futureWindow in their request.
operationDate & searchByUTC
A user can force the operationDate value to be considered as UTC by providing the parameter 'searchByUTC=true'. By doing so the user has the ability to search for flights in the past/future based on UTC date/time.
Path parameters
| Parameter | Description |
|---|---|
|
|
3-character airport IATA code or 4-character airport ICAO code |
|
|
1-character direction indicator (A/D) |
Request parameters
| Parameter | Description |
|---|---|
|
|
Local date of operation (yyyy-MM-dd). Default value is current UTC date |
|
|
Search based by UTC. Default value is false |
|
|
Include cargo flights. Default value is false |
|
|
Filter results based on origin or destination airport |
|
|
View 'full' or 'local' leg, based on direction. Default value is local. See notes for further details. |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Calculated Delay in Minutes |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Name used to identify the slot |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
3-character airport IATA code |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Calculated Delay Prediction |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Calculated Delay Prediction |
|
|
|
Name used to identify the slot internally |
|
|
|
Custom Properties |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Stand Slots |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Recovery flight |
|
|
|
Carousel Slots |
|
|
|
Flight Delay Prediction. Available for Premium Users. |
|
|
|
Key value used to identify a custom property |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Route |
|
|
|
4-character airport ICAO code |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
3-character airport IATA code |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Estimated Landing Time |
|
|
|
Route |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
|
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
Airport |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Actual Take Off Time |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The flights departure/arrival gate e.g C1 |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Departure |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
Actual Off Block Time |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
End time for the slot activity e.g check-in desk closed |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Total number of adults |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Gate remark text when applicable e.g Boarding at 21:00 |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Actual In Block Time |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
|
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Total number of reduced mobility passengers e.g those requiring assistance boarding the aircraft etc. |
|
|
|
Gate Slots |
|
|
|
Checkin Slots |
|
|
|
Carousel Slots |
|
|
|
Stand Slots |
|
|
|
Name used to identify the slot |
|
|
|
Actual Landing Time |
|
|
|
Name used to identify the slot |
|
|
|
Events |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
Name used to identify the slot internally |
|
|
|
Name used to identify the slot internally |
|
|
|
Events |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
The current status code for this flight e.g SC, DP |
|
|
|
The value of a custom property |
|
|
|
Chute Slots |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
The actual local time at which the aircraft arrived at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot internally |
|
|
|
Key value used to identify a custom property |
|
|
|
Location details of the slot resource i.e check-in desks1-20, Gate 2C etc |
|
|
|
The actual local time at which the aircraft landed on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Name used to identify the slot |
|
|
|
Custom Properties |
|
|
|
The actual local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total weight of bags/pieces |
|
|
|
Actual number of 1st class passengers |
|
|
|
IATA code for the aircraft |
|
|
|
Value used to identify the routes position within an entire flight route e.g leg 0, leg 1, leg 2 etc |
|
|
|
The latest estimated local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Load breakdown |
|
|
|
Actual number of passengers |
|
|
|
Aircraft |
|
|
|
Total number of mail pieces |
|
|
|
Actual number of economy class passengers |
|
|
|
Specific aircraft model details |
|
|
|
Flight number e.g 1234 |
|
|
|
Total number of cargo pieces |
|
|
|
Actual number of business class passengers |
|
|
|
ICAO code for the aircraft |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Total number of booked 1st class passengers |
|
|
|
Start time for the slot activity e.g check-in desk opened |
|
|
|
Aircraft stand details e.g S12 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Total number of infants |
|
|
|
2-character airline IATA code e.g A |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Total number of children |
|
|
|
Total number of booked passengers |
|
|
|
Name used to identify the slot |
|
|
|
Expected carousel(s) for baggage reclaim |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Original flight |
|
|
|
Recovery flight |
|
|
|
Original flight |
|
|
|
Baggage chute details e.g CH-2 |
|
|
|
Marketing Carriers |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Total number of bags/pieces |
|
|
|
Total number of booked economy class passengers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Diversion |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Diversion |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Flight number e.g 1234 |
|
|
|
Check-in desk details e.g CK-1 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Baggage |
|
|
|
Total number of booked business class passengers |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Take Off Time |
|
|
|
Flight number e.g 1234 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The local time at which the aircraft is targeted to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
The city in which the airport is located e.g New York |
|
|
|
Target Off Block Time |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
UTC timestamp when last update update was applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
The name of the airport e.g John F Kennedy International Airport |
|
|
|
Estimated Take Off Time |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Estimated Off Block Time |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
Data source of the last update applied to this flight |
|
|
|
The estimated local time at which the aircraft is expected to leave the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
4-character airport ICAO code e.g KJFK |
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Estimated In Block Time |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Metadata |
|
|
|
The estimated local time at which the aircraft is expected at the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
3-character airport IATA code e.g JFK |
|
|
|
Actual number of transit passengers |
|
|
|
Call-sign for the aircraft type |
|
|
|
Flight Identifier |
|
|
|
The estimated local time at which the aircraft is expected to land on the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Airport |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Actual number of transfer passengers |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Operating Carrier |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
The actual local time at which the aircraft left the runway e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The flights departure/arrival terminal e.g T1 |
|
|
|
Arrival |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Passengers |
|
|
|
Flight number e.g 1234 |
|
|
|
Flight number e.g 1234 |
|
|
|
A message related to the prediction |
|
|
|
The actual local time at which the aircraft left the gate e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
The current status text for this flight e.g Scheduled, Departed |
|
|
|
A message related to the prediction |
|
|
|
Flight Stats |
|
|
|
Flight Records |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/airport/MCT/direction/D?operationDate=2021-04-01' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3330
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"aircraft" : {
"iataCode" : "321",
"icaoCode" : "A321",
"model" : "A321",
"registration" : "4RAND"
}
},
"flightStats" : {
"passengers" : {
"bookedTotal" : "120",
"adult" : "109",
"child" : "2",
"infant" : "2"
},
"baggage" : {
"count" : "235",
"load" : "3661",
"cargo" : "0",
"mail" : "0"
}
},
"departure" : {
"airport" : {
"iataCode" : "CMB",
"cityText" : "Colombo"
},
"scheduled" : "2021-04-01T12:25:00+04:00",
"estimated" : "2021-04-01T14:43:00+05:30",
"actual" : "2021-04-01T13:48:00+05:30",
"status" : "DP",
"statusText" : "Departed",
"terminal" : "T1",
"gate" : "C3",
"stand" : "401R",
"checkIn" : "F10",
"chute" : "S1",
"standSlots" : [ {
"name" : "401R",
"externalName" : "401R",
"startTime" : "2021-04-01T11:06:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Sector 4C"
} ],
"checkinSlots" : [ {
"name" : "F10",
"externalName" : "F10",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F11",
"externalName" : "F11",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F12",
"externalName" : "F12",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F8",
"externalName" : "F8",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
}, {
"name" : "F9",
"externalName" : "F9",
"startTime" : "2021-04-01T07:40:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Check-In F"
} ],
"gateSlots" : [ {
"name" : "C3",
"externalName" : "C3",
"startTime" : "2021-04-01T11:18:00+04:00",
"endTime" : "2021-04-01T12:18:00+04:00",
"area" : "Pier C Contact"
} ],
"chuteSlots" : [ {
"name" : "S1",
"externalName" : "S1",
"startTime" : "2021-04-01T09:25:00+04:00",
"endTime" : "2021-04-01T11:25:00+04:00",
"area" : "Chutes"
} ],
"route" : [ {
"sequenceNumber" : 0
} ],
"customProperties" : [ {
"key" : "S---_Status",
"value" : "SCH"
} ],
"events" : {
"AOBT" : "2021-04-01T12:18:00+04:00",
"ATOT" : "2021-04-01T12:26:00+04:00",
"EOBT" : "2021-04-01T13:13:00+04:00"
},
"delayPrediction" : {
"minutes" : 65,
"prediction" : "2021-04-01T13:30:00+04:00"
}
},
"serviceType" : "J",
"duration" : 255
} ]
}
3.2.4 GET Get Flight Updates by Airport, Airline and Flight Number
Retrieve a single flight and its updates based on airline, flight number and arrival/departure airport. Results are filtered by operation date (default is current UTC date).
The date range defined by the 'from' and 'to' query parameters may not exceed 60 minutes.
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
operationDate
In this scenario the operationDate is considered to be the local date on which the flight departed/arrived.
operationDate & searchByUTC
A user can force the operationDate value to be considered as UTC by providing the parameter 'searchByUTC=true'.
Path parameters
| Parameter | Description |
|---|---|
|
|
3-character airport IATA code or 4-character airport ICAO code |
|
|
2-character airline IATA code or 3-character airline ICAO code |
|
|
Flight number |
Request parameters
| Parameter | Description |
|---|---|
|
|
Local date of operation (yyyy-MM-dd). Default value is current UTC date |
|
|
Date interval start e.g 2020-01-01T12:00:00-0000. Default is current UTC date/time - 2 minutes |
|
|
Date interval end e.g 2020-01-01T12:05:00-0000. Default is current UTC date/time - 1 minutes |
|
|
Group marketing and operating carrier flights into a single record. Default value is false |
|
|
Show additional information such as version |
|
|
Include cargo flights. Default value is false |
|
|
1-character direction indicator (A/D) |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Call-sign for the aircraft type |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Departure |
|
|
|
Operating Carrier |
|
|
|
Specific aircraft model details |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Flight Identifier |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Arrival |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Marketing Carriers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
Updates |
|
|
|
Previous field value |
|
|
|
Current field value |
|
|
|
Flight number e.g 1234 |
|
|
|
Payload field which was updated |
|
|
|
Updates |
|
|
|
FLIFO internal version number |
|
|
|
Payload field which was updated |
|
|
|
Flight Records |
|
|
|
IATA code for the aircraft |
|
|
|
UTC timestamp when update was received |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
ICAO code for the aircraft |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
Previous field value |
|
|
|
UTC timestamp when update was received |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Aircraft |
|
|
|
Current field value |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Data source of this update |
|
|
|
FLIFO internal version number |
|
|
|
UTC timestamp when update was applied |
|
|
|
Metadata |
|
|
|
3-character airline ICAO code e.g AAL |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/updates/airport/MCT/airline/UL/flightNumber/1512?from=2021-04-01T03:00:00.000Z&to=2021-04-01T04:00:00.000Z' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 5521
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"marketingCarriers" : [ {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "512",
"name" : "SriLankan Airlines"
} ]
},
"departure" : {
"scheduled" : "2021-04-01T08:25:00+00:00",
"version" : 39,
"updates" : [ {
"updatedField" : "CHECK_IN_SLOT",
"previous" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"current" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"received" : "2021-04-01T03:17:35.662Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:15:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T04:34:28.747Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T05:10:43.956Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T07:06:13.922Z"
}, {
"updatedField" : "STATUS",
"previous" : "SC",
"current" : "FC",
"received" : "2021-04-01T07:52:30.967Z"
}, {
"updatedField" : "STATUS",
"previous" : "FC",
"current" : "GC",
"received" : "2021-04-01T08:13:56.299Z"
}, {
"updatedField" : "ESTIMATED",
"current" : "2021-04-01T13:58:00+05:30",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "GATE_SLOT",
"previous" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:25:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Pier C Contact\"}]",
"current" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:28:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Pier C Contact\"}]",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "EVENTS",
"previous" : "{}",
"current" : "{\"EOBT\":\"2021-04-01T12:28:00+04:00\"}",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T08:22:41.376Z"
}, {
"updatedField" : "DELAY_PREDICTION",
"previous" : "{\"minutes\":55,\"prediction\":\"2021-04-01T13:20:00+04:00\"}",
"current" : "{\"minutes\":65,\"prediction\":\"2021-04-01T13:30:00+04:00\"}",
"received" : "2021-04-01T08:25:12.156Z"
} ]
},
"arrival" : {
"version" : 39
}
} ]
}
3.2.5 GET Get Flight Updates by Airport and Airline
Retrieve all updates created within the from/to search window for flights arriving to or departing from an airport, operated or marketed by the provided airline.
The date range defined by the 'from' and 'to' query parameters may not exceed 60 minutes.
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
Path parameters
| Parameter | Description |
|---|---|
|
|
3-character airport IATA code or 4-character airport ICAO code |
|
|
2-character airline IATA code or 3-character airline ICAO code |
Request parameters
| Parameter | Description |
|---|---|
|
|
Date interval start e.g 2020-01-01T12:00:00-0000. Default is current UTC date/time - 2 minutes |
|
|
Date interval end e.g 2020-01-01T12:05:00-0000. Default is current UTC date/time - 1 minutes |
|
|
Group marketing and operating carrier flights into a single record. Default value is false |
|
|
Show additional information such as version |
|
|
Include cargo flights. Default value is false |
|
|
1-character direction indicator (A/D) |
|
|
View 'full' or 'local' leg, based on direction. Default value is local. See notes for further details. |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Call-sign for the aircraft type |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Departure |
|
|
|
Operating Carrier |
|
|
|
Specific aircraft model details |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Flight Identifier |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Arrival |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Marketing Carriers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
Updates |
|
|
|
Previous field value |
|
|
|
Current field value |
|
|
|
Flight number e.g 1234 |
|
|
|
Payload field which was updated |
|
|
|
Updates |
|
|
|
FLIFO internal version number |
|
|
|
Payload field which was updated |
|
|
|
Flight Records |
|
|
|
IATA code for the aircraft |
|
|
|
UTC timestamp when update was received |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
ICAO code for the aircraft |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
Previous field value |
|
|
|
UTC timestamp when update was received |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Aircraft |
|
|
|
Current field value |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Data source of this update |
|
|
|
FLIFO internal version number |
|
|
|
UTC timestamp when update was applied |
|
|
|
Metadata |
|
|
|
3-character airline ICAO code e.g AAL |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/updates/airport/MCT/airline/UL?from=2021-04-01T03:00:00.000Z&to=2021-04-01T04:00:00.000Z' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 5521
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"marketingCarriers" : [ {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "512",
"name" : "SriLankan Airlines"
} ]
},
"departure" : {
"scheduled" : "2021-04-01T08:25:00+00:00",
"version" : 39,
"updates" : [ {
"updatedField" : "CHECK_IN_SLOT",
"previous" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"current" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"received" : "2021-04-01T03:17:35.662Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:15:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T04:34:28.747Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T05:10:43.956Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T07:06:13.922Z"
}, {
"updatedField" : "STATUS",
"previous" : "SC",
"current" : "FC",
"received" : "2021-04-01T07:52:30.967Z"
}, {
"updatedField" : "STATUS",
"previous" : "FC",
"current" : "GC",
"received" : "2021-04-01T08:13:56.299Z"
}, {
"updatedField" : "ESTIMATED",
"current" : "2021-04-01T13:58:00+05:30",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "GATE_SLOT",
"previous" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:25:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Pier C Contact\"}]",
"current" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:28:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Pier C Contact\"}]",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "EVENTS",
"previous" : "{}",
"current" : "{\"EOBT\":\"2021-04-01T12:28:00+04:00\"}",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T08:22:41.376Z"
}, {
"updatedField" : "DELAY_PREDICTION",
"previous" : "{\"minutes\":55,\"prediction\":\"2021-04-01T13:20:00+04:00\"}",
"current" : "{\"minutes\":65,\"prediction\":\"2021-04-01T13:30:00+04:00\"}",
"received" : "2021-04-01T08:25:12.156Z"
} ]
},
"arrival" : {
"version" : 39
}
} ]
}
3.2.6 GET Get Flight Updates by Airport
Retrieve all updates created within the from/to search window for flights arriving to or departing from an airport.
The date range defined by the 'from' and 'to' query parameters may not exceed 60 minutes.
Payload elements are filtered based on permissions associated with the 'X-apiKey' used in the request.
Path parameters
| Parameter | Description |
|---|---|
|
|
3-character airport IATA code or 4-character airport ICAO code |
Request parameters
| Parameter | Description |
|---|---|
|
|
Date interval start e.g 2020-01-01T12:00:00-0000. Default is current UTC date/time - 2 minutes |
|
|
Date interval end e.g 2020-01-01T12:05:00-0000. Default is current UTC date/time - 1 minutes |
|
|
Group marketing and operating carrier flights into a single record. Default value is false |
|
|
Show additional information such as version |
|
|
Include cargo flights. Default value is false |
|
|
1-character direction indicator (A/D) |
|
|
View 'full' or 'local' leg, based on direction. Default value is local. See notes for further details. |
Request headers
| Name | Description |
|---|---|
|
|
Content type of this request. Required value is 'application/json' |
|
|
Authorization header that contains the API key. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
3-character airline ICAO code e.g AAL |
|
|
|
Call-sign for the aircraft type |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
2-character airline IATA code e.g A |
|
|
|
Departure |
|
|
|
Operating Carrier |
|
|
|
Specific aircraft model details |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
Flight duration in minutes e.g 60 |
|
|
|
Flight Identifier |
|
|
|
Aircraft registration/tail number details e.g EIAA44W |
|
|
|
Arrival |
|
|
|
2-character airline IATA code e.g AA |
|
|
|
Marketing Carriers |
|
|
|
Name of airline e.g American Airlines |
|
|
|
The published scheduled local departure/arrival time for this flight e.g 2020-01-22T12:00:00+03:00 |
|
|
|
Flight number e.g 1234 |
|
|
|
Updates |
|
|
|
Previous field value |
|
|
|
Current field value |
|
|
|
Flight number e.g 1234 |
|
|
|
Payload field which was updated |
|
|
|
Updates |
|
|
|
FLIFO internal version number |
|
|
|
Payload field which was updated |
|
|
|
Flight Records |
|
|
|
IATA code for the aircraft |
|
|
|
UTC timestamp when update was received |
|
|
|
UTC timestamp when update was applied (only visible when updates are grouped) |
|
|
|
ICAO code for the aircraft |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Flight service type e.g J-Passenger, F-Cargo |
|
|
|
Previous field value |
|
|
|
UTC timestamp when update was received |
|
|
|
Name of airline e.g American Airlines |
|
|
|
Aircraft |
|
|
|
Current field value |
|
|
|
Data source of this update (only visible when updates are grouped) |
|
|
|
Data source of this update |
|
|
|
FLIFO internal version number |
|
|
|
UTC timestamp when update was applied |
|
|
|
Metadata |
|
|
|
3-character airline ICAO code e.g AAL |
Curl request
$ curl 'https://historical.api.aero/historical/v2/flights/updates/airport/MCT?from=2021-04-01T03:00:00.000Z&to=2021-04-01T04:00:00.000Z' -i -X GET \
-H 'Content-Type: application/json' \
-H 'X-apiKey: Insert your API key here'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 5521
{
"flightRecords" : [ {
"flightIdentifier" : {
"operatingCarrier" : {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "1512",
"name" : "SriLankan Airlines"
},
"marketingCarriers" : [ {
"iataCode" : "UL",
"icaoCode" : "ALK",
"flightNumber" : "512",
"name" : "SriLankan Airlines"
} ]
},
"departure" : {
"scheduled" : "2021-04-01T08:25:00+00:00",
"version" : 39,
"updates" : [ {
"updatedField" : "CHECK_IN_SLOT",
"previous" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T08:25:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"current" : "[{\"name\":\"F9\",\"externalName\":\"F9\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F10\",\"externalName\":\"F10\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F11\",\"externalName\":\"F11\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F12\",\"externalName\":\"F12\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"},{\"name\":\"F8\",\"externalName\":\"F8\",\"startTime\":\"2021-04-01T07:40:00+04:00\",\"endTime\":\"2021-04-01T11:25:00+04:00\",\"area\":\"Check-In F\"}]",
"received" : "2021-04-01T03:17:35.662Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:15:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T04:34:28.747Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:19:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T05:10:43.956Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:18:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T07:06:13.922Z"
}, {
"updatedField" : "STATUS",
"previous" : "SC",
"current" : "FC",
"received" : "2021-04-01T07:52:30.967Z"
}, {
"updatedField" : "STATUS",
"previous" : "FC",
"current" : "GC",
"received" : "2021-04-01T08:13:56.299Z"
}, {
"updatedField" : "ESTIMATED",
"current" : "2021-04-01T13:58:00+05:30",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "GATE_SLOT",
"previous" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:25:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Pier C Contact\"}]",
"current" : "[{\"name\":\"C3\",\"externalName\":\"C3\",\"startTime\":\"2021-04-01T11:28:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Pier C Contact\"}]",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "EVENTS",
"previous" : "{}",
"current" : "{\"EOBT\":\"2021-04-01T12:28:00+04:00\"}",
"received" : "2021-04-01T08:22:41.375Z"
}, {
"updatedField" : "STAND_SLOT",
"previous" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:25:00+04:00\",\"area\":\"Sector 4C\"}]",
"current" : "[{\"name\":\"401R\",\"externalName\":\"401R\",\"startTime\":\"2021-04-01T11:06:00+04:00\",\"endTime\":\"2021-04-01T12:28:00+04:00\",\"area\":\"Sector 4C\"}]",
"received" : "2021-04-01T08:22:41.376Z"
}, {
"updatedField" : "DELAY_PREDICTION",
"previous" : "{\"minutes\":55,\"prediction\":\"2021-04-01T13:20:00+04:00\"}",
"current" : "{\"minutes\":65,\"prediction\":\"2021-04-01T13:30:00+04:00\"}",
"received" : "2021-04-01T08:25:12.156Z"
} ]
},
"arrival" : {
"version" : 39
}
} ]
}
4 Error Response
4.1 Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4.2 HTTP Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 159
{
"errors" : {
"error" : [ {
"description" : "Error Description",
"code" : 9999,
"invalidParam" : "parameterName"
} ]
}
}
5 Notes
5.1 'view' parameter
'view' parameter
The 'view' query parameter can have the value 'local' or 'full' (default value is 'local').
The purpose of this parameter is to enable the user to decide if they wish to see just the 'local' view of the flight (e.g only the
departure details if 'direction' parameter provided was 'D') or the 'full' view which will return both departure and arrival details for the flight(s) if 'direction' parameter provided was 'D'.
See 'Appendix E - Flights Response Examples' for sample 'local' and 'full' response
payloads.
6 Appendix A - Status Codes
| Code | Description |
|---|---|
|
AD |
Arrived-Diverted |
|
AP |
Approach |
|
AR |
Arrived |
|
AT |
See Agent |
|
BC |
Boarding Complete |
|
BD |
Boarding |
|
BO |
Boarded |
|
CD |
Baggage Delay |
|
CO |
Closed |
|
CL |
Closed |
|
CX |
Cancelled |
|
DE |
Deleted |
|
DL |
Delayed |
|
DP |
Departed |
|
DV |
Diverted |
|
EN |
Enroute |
|
EX |
Expected |
|
FB |
First Bag Unloaded |
|
FC |
Final Call |
|
GC |
Gate Closed |
|
GG |
Go To Gate |
|
GT |
Gate Time (Gate Time HH:MM can be found in gateInfo field) |
|
IA |
In Air |
|
ID |
In Air-Diverted |
|
IR |
In Range |
|
LB |
Last Bag Unloaded |
|
LD |
Landed-Diverted |
|
LN |
Landed |
|
LR |
Landed-Recovered |
|
OG |
Landed (On Ground) |
|
ON |
On Time |
|
TX |
Taxiing |
|
PD |
Possible Delay |
|
RA |
Arrived-Recovered |
|
RE |
In Air-Recovered |
|
RG |
Return To Gate |
|
SC |
Scheduled |
|
UN |
Unknown |
|
VN |
TEST |
|
WX |
Weather |
7 Appendix B - V2 Flight Details Response Schema
{
"type" : "object",
"properties" : {
"flightRecords" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"flightIdentifier" : {
"type" : "object",
"properties" : {
"operatingCarrier" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"marketingCarriers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"aircraft" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"model" : {
"type" : "string"
},
"registration" : {
"type" : "string"
},
"callSign" : {
"type" : "string"
}
}
}
}
},
"flightStats" : {
"type" : "object",
"properties" : {
"passengers" : {
"type" : "object",
"properties" : {
"bookedTotal" : {
"type" : "string"
},
"bookedFirst" : {
"type" : "string"
},
"bookedBusiness" : {
"type" : "string"
},
"bookedEconomy" : {
"type" : "string"
},
"actualTotal" : {
"type" : "string"
},
"actualFirst" : {
"type" : "string"
},
"actualBusiness" : {
"type" : "string"
},
"actualEconomy" : {
"type" : "string"
},
"actualTransfer" : {
"type" : "string"
},
"actualTransit" : {
"type" : "string"
},
"reducedMobility" : {
"type" : "string"
},
"adult" : {
"type" : "string"
},
"child" : {
"type" : "string"
},
"infant" : {
"type" : "string"
}
}
},
"baggage" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "string"
},
"load" : {
"type" : "string"
},
"totalWeight" : {
"type" : "string"
},
"cargo" : {
"type" : "string"
},
"mail" : {
"type" : "string"
}
}
}
}
},
"departure" : {
"type" : "object",
"properties" : {
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "any"
},
"estimated" : {
"type" : "any"
},
"actual" : {
"type" : "any"
},
"status" : {
"type" : "string"
},
"statusText" : {
"type" : "string"
},
"terminal" : {
"type" : "string"
},
"gate" : {
"type" : "string"
},
"gateRemark" : {
"type" : "string"
},
"gateRemarkText" : {
"type" : "string"
},
"carousel" : {
"type" : "string"
},
"stand" : {
"type" : "string"
},
"checkIn" : {
"type" : "string"
},
"chute" : {
"type" : "string"
},
"standSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"checkinSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"carouselSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"gateSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"chuteSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"route" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"sequenceNumber" : {
"type" : "integer"
}
}
}
},
"customProperties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
},
"events" : {
"type" : "object",
"properties" : {
"ALDT" : {
"type" : "any"
},
"AIBT" : {
"type" : "any"
},
"AOBT" : {
"type" : "any"
},
"ATOT" : {
"type" : "any"
},
"ELDT" : {
"type" : "any"
},
"EIBT" : {
"type" : "any"
},
"EOBT" : {
"type" : "any"
},
"ETOT" : {
"type" : "any"
},
"TOBT" : {
"type" : "any"
},
"TTOT" : {
"type" : "any"
}
}
},
"diversion" : {
"type" : "object",
"properties" : {
"original" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "string"
}
}
},
"recovery" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "string"
}
}
}
}
},
"delayPrediction" : {
"type" : "object",
"properties" : {
"minutes" : {
"type" : "integer"
},
"prediction" : {
"type" : "string"
},
"message" : {
"type" : "string"
}
}
}
}
},
"arrival" : {
"type" : "object",
"properties" : {
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "any"
},
"estimated" : {
"type" : "any"
},
"actual" : {
"type" : "any"
},
"status" : {
"type" : "string"
},
"statusText" : {
"type" : "string"
},
"terminal" : {
"type" : "string"
},
"gate" : {
"type" : "string"
},
"gateRemark" : {
"type" : "string"
},
"gateRemarkText" : {
"type" : "string"
},
"carousel" : {
"type" : "string"
},
"stand" : {
"type" : "string"
},
"checkIn" : {
"type" : "string"
},
"chute" : {
"type" : "string"
},
"standSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"checkinSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"carouselSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"gateSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"chuteSlots" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"externalName" : {
"type" : "string"
},
"startTime" : {
"type" : "any"
},
"endTime" : {
"type" : "any"
},
"area" : {
"type" : "string"
}
}
}
},
"route" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"sequenceNumber" : {
"type" : "integer"
}
}
}
},
"customProperties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
},
"events" : {
"type" : "object",
"properties" : {
"ALDT" : {
"type" : "any"
},
"AIBT" : {
"type" : "any"
},
"AOBT" : {
"type" : "any"
},
"ATOT" : {
"type" : "any"
},
"ELDT" : {
"type" : "any"
},
"EIBT" : {
"type" : "any"
},
"EOBT" : {
"type" : "any"
},
"ETOT" : {
"type" : "any"
},
"TOBT" : {
"type" : "any"
},
"TTOT" : {
"type" : "any"
}
}
},
"diversion" : {
"type" : "object",
"properties" : {
"original" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "string"
}
}
},
"recovery" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"airport" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"cityText" : {
"type" : "string"
}
}
},
"scheduled" : {
"type" : "string"
}
}
}
}
},
"delayPrediction" : {
"type" : "object",
"properties" : {
"minutes" : {
"type" : "integer"
},
"prediction" : {
"type" : "string"
},
"message" : {
"type" : "string"
}
}
}
}
},
"serviceType" : {
"type" : "string"
},
"duration" : {
"type" : "integer"
},
"metadata" : {
"type" : "object",
"properties" : {
"provider" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "any"
}
}
}
}
}
}
}
}
8 Appendix C - V2 Flight Updates Response Schema
{
"type" : "object",
"properties" : {
"flightRecords" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"flightIdentifier" : {
"type" : "object",
"properties" : {
"operatingCarrier" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"marketingCarriers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"iataCode" : {
"type" : "string"
},
"icaoCode" : {
"type" : "string"
},
"flightNumber" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
}
},
"departure" : {
"type" : "object",
"properties" : {
"scheduled" : {
"type" : "any"
},
"version" : {
"type" : "integer"
},
"updates" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"updatedField" : {
"type" : "string",
"enum" : [ "GATE", "CLAIM", "TERMINAL", "ACTUAL", "ESTIMATED", "SCHEDULED", "AIRCRAFT", "DURATION", "TAILNO", "STATUS", "SERVICE_TYPE", "STAND", "CHECK_IN", "AIRCRAFT_OBJECT", "STAND_SLOT", "CHECK_IN_SLOT", "CAROUSEL_SLOT", "GATE_SLOT", "CHUTE_SLOT", "ROUTE", "FLIGHT_STATS", "CUSTOM_PROPERTIES", "MARKETING_CARRIER", "EVENTS", "DIVERSION", "AIRPORT", "RECOVERY", "ORIGINAL", "DELAY_PREDICTION" ]
},
"previous" : {
"type" : "string"
},
"current" : {
"type" : "string"
},
"received" : {
"type" : "any"
},
"metadata" : {
"type" : "object",
"properties" : {
"provider" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "any"
}
}
}
}
}
}
}
},
"arrival" : {
"type" : "object",
"properties" : {
"scheduled" : {
"type" : "any"
},
"version" : {
"type" : "integer"
},
"updates" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"updatedField" : {
"type" : "string",
"enum" : [ "GATE", "CLAIM", "TERMINAL", "ACTUAL", "ESTIMATED", "SCHEDULED", "AIRCRAFT", "DURATION", "TAILNO", "STATUS", "SERVICE_TYPE", "STAND", "CHECK_IN", "AIRCRAFT_OBJECT", "STAND_SLOT", "CHECK_IN_SLOT", "CAROUSEL_SLOT", "GATE_SLOT", "CHUTE_SLOT", "ROUTE", "FLIGHT_STATS", "CUSTOM_PROPERTIES", "MARKETING_CARRIER", "EVENTS", "DIVERSION", "AIRPORT", "RECOVERY", "ORIGINAL", "DELAY_PREDICTION" ]
},
"previous" : {
"type" : "string"
},
"current" : {
"type" : "string"
},
"received" : {
"type" : "any"
},
"metadata" : {
"type" : "object",
"properties" : {
"provider" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "any"
}
}
}
}
}
}
}
},
"metadata" : {
"type" : "object",
"properties" : {
"provider" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "any"
}
}
}
}
}
}
}
}
9 Appendix D - Update Fields
| Field | Description |
|---|---|
|
NEW_FLIGHT |
Identifies a new flight created within FLIFO. This is the first possible notification which can be generated for a flight |
|
GATE |
Gate change |
|
CLAIM |
Baggage Claim/Carousel |
|
ACTUAL |
Actual time of departure or arrival |
|
ESTIMATED |
Estimated time of departure or arrival |
|
AIRCRAFT |
Aircraft type change |
|
TERMINAL |
Terminal change |
|
DURATION |
Flight duration change |
|
TAILNO |
Tail number change |
|
STATUS |
Flight status change. |
|
SCHEDULED |
Scheduled departure/arrival time change |
|
SERVICE_TYPE |
Change of flight service type |
|
STAND |
Stand allocation change |
|
STAND_SLOT |
Sand slot change |
|
CHECK_IN |
Check in desk allocation |
|
CHECK_IN_SLOT |
Check in slot change |
|
AIRCRAFT_OBJECT |
Aircraft object change |
|
CAROUSEL_SLOT |
Carousel slot change |
|
GATE_SLOT |
Gate slot change |
|
CHUTE_SLOT |
Baggage chute slot change |
|
ROUTE |
Route change |
|
FLIGHT_STATS |
Flight Stats change i.e. passenger counts/baggage counts |
|
EVENTS |
Events change i.e. updates to off/on block times |
|
MARKETING_CARRIER |
Change to listed marketing/codeshare flight details |
|
CUSTOM_PROPERTIES |
Change to details contained within the custom properties key value mappings |
|
DIVERSION |
Diversion details change |
|
DELAY_PREDICTION |
Delay Prediction change |
10 Appendix E - Flights Response Examples
| /v1/flights/airport/MCT/airline/UL/direction/D?view=#local# | /v1/flights/airport/MCT/airline/UL/direction/D?view=#full# |
|---|---|
|
|
11 Appendix F - Historical Flight Use Cases
11.1 Flight Updates Use Cases
|
Scenario: |
As an API user I want to make a request to the Historical API to return all updates for flights at a given airport within a provided timeframe |
|
Request: |
GET /historical/v2/flights/updates/airport/AMS?operationDateFrom=2020-01-01T12:00:00-0000&operationDateTo=2020-01-01T12:30:00-0000 |
|
Response: |
List of flight update records for AMS flights between January 1st at 12pm until 12.30pm |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all updates for flights from a specific airline at a given airport within a provided timeframe |
|
Request: |
GET /historical/v2/flights/updates/airport/AMS/airline/KL?operationDateFrom=2020-01-01T12:00:00-0000&operationDateTo=2020-01-01T12:30:00-0000 |
|
Response: |
List of flight update records for KL flights to and from AMS between January 1st at 12pm until 12.30pm |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all updates for flights from a specific airline, with a specific flight number, at a given airport within a provided timeframe |
|
Request: |
GET /historical/v2/flights/updates/airport/AMS/airline/KL/flightNumber/1417?operationDateFrom=2020-01-01T12:00:00-0000&operationDateTo=2020-01-01T12:30:00-0000 |
|
Response: |
List of flight update records for KL flights with a flight number of 1417 to and from AMS between January 1st at 12pm until 12.30pm |
11.2 Flight Details Use Cases
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records arriving at a specific airport |
|
Request: |
GET /historical/v2/flights/airport/AMS/direction/A |
|
Response: |
List of flight records for flights arriving at AMS airport |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records departing a specific airport |
|
Request: |
GET /historical/v2/flights/airport/AMS/direction/D |
|
Response: |
List of flight records for flights departing at AMS airport |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records arriving at a given airport for a specific airline and flight number |
|
Request: |
GET /historical/v2/flights/airport/AMS/airline/KL/flightNumber/1417/direction/A |
|
Response: |
List of flight records for flights arriving at AMS airport with an airline code of KL, and a flight number of 1417 |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records departing from a given airport for a specific airline and flight number |
|
Request: |
GET /historical/v2/flights/airport/AMS/airline/KL/flightNumber/1417/direction/D |
|
Response: |
List of flight records for flights departing from AMS airport with an airline code of KL, and a flight number of 1417 |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records arriving at a given airport for a specific airline |
|
Request: |
GET /historical/v2/flights/airport/AMS/airline/KL/direction/A |
|
Response: |
List of flight records for flights arriving at AMS airport with an airline code of KL |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records departing a given airport for a specific airline |
|
Request: |
GET /historical/v2/flights/airport/AMS/airline/KL/direction/D |
|
Response: |
List of flight records for flights departing from AMS airport with an airline code of KL |
|
Scenario: |
As an API user I want to make a request to the Historical API to return all flight records departing a given airport for a specific airline |
|
Request: |
GET /historical/v2/flights/airline/KL/flightNumber/1417 |
|
Response: |
List of a single record for a flight with an airline code of KL and a flight number of 1417 |
Last updated 2022-10-25 11:59:46 +0100
