Flight Information Display System API

Download OpenAPI specification:Download

Introduction

The Flight Information Display System APIs, part of the FlightStats APIs, provide the data needed by Flight Information Display Systems (FIDS) such as the flight boards commonly visible in airport terminals, hotel lobbies, and other places travelers are found.

FIDS APIs answer questions such as

  • Is my flight on time or cancelled?
  • What is my arrival gate and terminal?
  • What is the weather at the arrival airport?

The FIDS APIs return a list of departing or arriving flights for a given airport for a given time period around the current time at the airport.

The APIs are highly configurable, supporting not only a wide variety of parameters, but is also configurable to return only the information needed for the display. The information is returned in a simple flat structure that's drop-in ready for most applications.

Requested fields

The FIDS APIs provide a customizable set of data pertaining to flights for a particular airport. A FIDS request produces an XML or JSON response with a flat structure that contains only those fields chosen by the requestedFields query parameter.

The available fields are defined in the schema for the fidsData array object. You can see the list of fields by looking the response section of the API documentation below.

For example specifying "airlineCode,flightNumber,city,currentTime,gate,remarks" will return an array of FIDS objects with only those fields represented in the object.

Extended options

The FIDS APIs support useHTTPErrors and languageCode extended options.

Licensing

The FIDS APIs are premium APIs and only available in the Contract plan.

A breakdown of the available plans is available on Get evaluation account

Schemas

Click the download button at the top of this document to download the OpenApi spec for this API. Other schemas:

Long term support

Extended fields

Related articles

Update the Flight Information Display System (FIDS) - Showcase article on how to use the FIDS API

Cirium flight status - Explanation of Cirium flight status data set

Codeshares and wet lease relationships - Explanation of codeshares and wet lease relationships

Related products

Flight Status - Current flight information for flights about three days in advance of departure until about seven days after arrival

Historical Flight Status - Status for flights back to 2006

Flight Alerts - Push based alerts for single flights or bulk

Flight Data (Laminar Data Hub) - Status and positional data appropriate for geospatial-aware applciations

Authentication

appIdQueryParam

ID of the application making the request

Security Scheme Type API Key
Query parameter name: appId

appKeyQueryParam

Authentication key of the application making the request

Security Scheme Type API Key
Query parameter name: appKey

appIdHeader

ID of the application making the request

Security Scheme Type API Key
Header parameter name: appId

appKeyHeader

Authentication key of the application making the request

Security Scheme Type API Key
Header parameter name: appKey

By arrivals

Retrieve FIDS display data for flights arriving at a given airport, including fields selected by a comma-separated list

path Parameters
format
required
string
Enum: "json" "jsonp" "xml"
Example: json

The data format returned in the response

airport
required
string
Example: PDX

Airport code

query Parameters
codeType
string
Enum: "IATA" "ICAO" "FS"
Example: codeType=FS

Airport code type. If not specified, the code searches in the order: IATA, ICAO, FS.

requestedFields
string
Example: requestedFields=airlineCode,flightNumber,city,currentTime,gate,remarks

List of fields to include in response (comma-separated). See fidsData object in response for a list of available fields.

sortFields
string
Example: sortFields=airlineCode,flightNumber

List of fields to sort by, in order of precedence (comma-separated)

excludeAirlines
string
Example: excludeAirlines=AS,AA

Comma-separated list of airline codes to exclude (code type specified by the codeType query parameter). Cannot be combined with includeAirlines.

includeAirlines
string
Example: includeAirlines=AS,AA

Comma-separated list of airline codes to include (code type specified by the codeType query parameter). Cannot be combined with excludeAirlines.

includeCodeshares
boolean
Default: true
Enum: true false
Example: includeCodeshares=true

Whether to include codeshares (multiple airlines sharing the same flight)

terminal
string
Example: terminal=3

Terminal to filter results by. If specified, only flights arriving in the given terminal will be returned.

timeFormat
integer <int64>
Default: 12
Enum: 12 24
Example: timeFormat=24

Format for time-based fields, 12-hour or 24-hour format respectively

timeWindowBegin
integer <int64> [ 0 .. 1440 ]
Example: timeWindowBegin=120

The number of minutes before 'now' during which flights should potentially be included. Default window is based on airport classification.

timeWindowEnd
integer <int64> [ 0 .. 4320 ]
Example: timeWindowEnd=120

The number of minutes after 'now' during which flights should potentially be included. Default window is based on airport classification.

maxFlights
integer <int64> >= 1
Example: maxFlights=100

The maximum number of flights to be returned. If more than this number of flights are available within the time window they will be weighted according to relevance and only this many will be returned.

lateMinutes
integer <int64> [ 1 .. 240 ]
Default: 15
Example: lateMinutes=15

The number of minutes after which a flight should be considered late, when generating remarks.

boardingMinutes
integer <int64> [ 0 .. 120 ]
Example: boardingMinutes=10

The number of minutes before scheduled or estimated departure during which a flight should be considered boarding, when generating remarks. If not specified 'Boarding' messages will not be displayed.

useRunwayTimes
boolean
Default: false
Enum: true false
Example: useRunwayTimes=false

Boolean value indicating whether runway times should be considered when determining delay and generating remarks

excludeCargoOnlyFlights
boolean
Default: false
Enum: true false
Example: excludeCargoOnlyFlights=false

Boolean value indicating whether cargo-only flights should be excluded

extendedOptions
Array of strings
Items Enum: "useHttpErrors" "useInlinedReferences" "includeNewFields" "languageCode:en" "languageCode:ar" "languageCode:de" "languageCode:es" "languageCode:fr" "languageCode:ja" "languageCode:ko" "languageCode:pt" "languageCode:zh"

Extended options for modifying standard API behavior to fit special use cases

Responses

Response samples

Content type
Example

FIDS response with a single field, "flight," requested. Default options.

Loading...

By departures

Retrieve FIDS display data for flights departing from a given airport, including fields selected by a comma-separated list

path Parameters
format
required
string
Enum: "json" "jsonp" "xml"
Example: json

The data format returned in the response

airport
required
string
Example: PDX

Airport code

query Parameters
codeType
string
Enum: "IATA" "ICAO" "FS"
Example: codeType=FS

Airport code type. If not specified, the code searches in the order: IATA, ICAO, FS.

requestedFields
string
Example: requestedFields=airlineCode,flightNumber,city,currentTime,gate,remarks

List of fields to include in response (comma-separated). See fidsData object in response for a list of available fields.

sortFields
string
Example: sortFields=airlineCode,flightNumber

List of fields to sort by, in order of precedence (comma-separated)

excludeAirlines
string
Example: excludeAirlines=AA,AS

Comma-separated list of airline codes to exclude (code type specified by the codeType query parameter). Cannot be combined with includeAirlines.

includeAirlines
string
Example: includeAirlines=AA,AS

Comma-separated list of airline codes to include (code type specified by the codeType query parameter). Cannot be combined with excludeAirlines.

includeCodeshares
boolean
Default: true
Enum: true false
Example: includeCodeshares=true

Whether to include codeshares (multiple airlines sharing the same flight).

terminal
string
Example: terminal=3

Terminal to filter results by. If specified, only flights departing from the given terminal will be returned.

timeFormat
integer <int64>
Default: 12
Enum: 12 24
Example: timeFormat=24

Format for time-based fields, 12-hour or 24-hour format respectively.

timeWindowBegin
integer <int64> [ 0 .. 1440 ]
Example: timeWindowBegin=120

The number of minutes before 'now' during which flights should potentially be included. Default window is based on airport classification.

timeWindowEnd
integer <int64> [ 0 .. 4320 ]
Example: timeWindowEnd=120

The number of minutes after 'now' during which flights should potentially be included. Default window is based on airport classification.

maxFlights
integer <int64> >= 1
Example: maxFlights=100

The maximum number of flights to be returned. If more than this number of flights are available within the time window they will be weighted according to relevance and only this many will be returned.

lateMinutes
integer <int64> [ 1 .. 240 ]
Default: 15
Example: lateMinutes=15

The number of minutes after which a flight should be considered late, when generating remarks.

boardingMinutes
integer <int64> [ 0 .. 120 ]
Example: boardingMinutes=10

The number of minutes before scheduled or estimated departure during which a flight should be considered boarding, when generating remarks. If not specified 'Boarding' messages will not be displayed.

useRunwayTimes
boolean
Default: false
Enum: true false
Example: useRunwayTimes=false

Boolean value indicating whether runway times should be considered when determining delay and generating remarks.

excludeCargoOnlyFlights
boolean
Default: false
Enum: true false
Example: excludeCargoOnlyFlights=false

Boolean value indicating whether cargo-only flights should be excluded.

extendedOptions
Array of strings
Items Enum: "useHttpErrors" "useInlinedReferences" "includeNewFields" "languageCode:en" "languageCode:ar" "languageCode:de" "languageCode:es" "languageCode:fr" "languageCode:ja" "languageCode:ko" "languageCode:pt" "languageCode:zh"

Extended options for modifying standard API behavior to fit special use cases

Responses

Response samples

Content type
Example

FIDS response with a single field, "flight," requested. Default options.

Loading...
)