FlightStats Flex API Reference

This section provides detailed documentation on the Flex APIs.

Read This First

How to Use the Flex APIs outlines conventions common to all the Flex APIs. We recommend you review this document before delving into the documentation for individual APIs.

How to Use the Documentation

The Flex API Quick Reference, below, provides a brief overview of all the Flex APIs, with links into the API-specific documentation. You can also use links in the sidebar to navigate the documentation.

WSDL and XSD resources for SOAP implementation are linked to both in the quick reference and in the more detailed API documentation.

Interactive Documentation

We've provided documentation of API request parameters in an interactive format. Request parameters are displayed in a web form that you can fill out and submit to try out the APIs. To use the interactive documentation:

  1. Click on the name of the web service to expand the test client interface.
  2. Fill out each required parameter (click app id & key to pre-populate with your credentials)
  3. Send Request to see the actual JSON response. You will also be provided with a curl invocation including a pre-formatted REST URL. To see the XML response, replace the json in the URL with xml.
  4. Please be aware that large responses may take a long time to pretty-print in your browser.

Note that you must provide valid application credentials when you submit requests through the interactive documentation. If you are signed in to your account, you'll be able to select your credentials from a pop-up when you enter the appId and appKey fields.

Release Notes

Check the Release Notes for updates.

Flex API Quick Reference

Airlines
The Airlines API provides basic reference information about one or more airlines.
Base URI https://api.flightstats.com/flex/airlines/rest/
Version v1
WADL https://api.flightstats.com/flex/airlines/rest/v1/schema/wadl
WSDL https://api.flightstats.com/flex/airlines/soap/v1/airlinesService?wsdl
XSD https://api.flightstats.com/flex/airlines/rest/v1/schema/xsd
JSON https://api.flightstats.com/flex/airlines/rest/v1/schema/json
Entry Points Name Description Response Elements
active/ Active airlines Airline information for active airlines airline
all/ All airlines Airline information for all airlines, active and inactive. airlines
fs/ Airlines by FlightStats code Airline information for airlines selected by FlightStats code and optionally date. airline
iata/ Airlines by IATA code Airline information for airlines selected by IATA code and optionally date. airline
icao/ Airlines by ICAO code Airline information for airlines selected by ICAO code and optionally date. airline
Airports
The Airports API provides basic reference information about one or more airports.
Base URI https://api.flightstats.com/flex/airports/rest/
Version v1
WADL https://api.flightstats.com/flex/airports/rest/v1/schema/wadl
WSDL https://api.flightstats.com/flex/airports/soap/v1/airportsService?wsdl
XSD https://api.flightstats.com/flex/airports/rest/v1/schema/xsd
JSON https://api.flightstats.com/flex/airports/rest/v1/schema/json
Entry Points Name Description Response Elements
active/ Active airports Airport information for active airports airport
all/ All airports Airport information for all airports, active and inactive. airport
/ Airport on date by code Airport information for an airport selected by airport code and date. airport
cityCode/ Airports by city code Airport information for airports selected by city code. airport
countryCode/ Airports by country code Airport information for airports that have had the given country code. airport
fs/ Airports by FlightStats code Airport information for airports selected by FlightStats code and optionally date. airport
iata/ Airports by IATA code Airport information for airports selected by IATA code and optionally date. airport
icao/ Airports by ICAO code Airport information for airports selected by ICAO code and optionally date. airport
withinRadius/ Airports within radius of location Airport information for airports within radius of a location. airport
Alerts
The Alerts API offers access to push-based alerting of flight status information. Alert Messages are produced when an existing alert rule is triggered, and are delivered to the destination specified by the rule.
Base URI https://api.flightstats.com/flex/alerts/rest/
Version v1
WADL https://api.flightstats.com/flex/alerts/rest/application.wadl
WSDL https://api.flightstats.com/flex/alerts/soap/v1/flightAlertsService?wsdl
XSD https://api.flightstats.com/flex/alerts/soap/v1/flightAlertsService?xsd=1
Entry Points Name Description Response Elements
create/ Create rule Create a flight rule to be monitored for a specific flight. request, error, alerts
delete/ Delete rule Deletes a flight rule that was previously created given a rule ID. request, error, alerts
get/ Retrieve rule Returns the flight rule that was previously created given a rule ID. request, error, alerts
Connections
Connections returns connecting flights between two airports. It is very useful when flying in or out of smaller, regional airports such as Newark, NJ; Fort Lauderdale, FL; or Spokane, WA.
Base URI https://api.flightstats.com/flex/connections/rest/
Version v2
WADL https://api.flightstats.com/flex/connections/rest/v2/schema/wadl
XSD https://api.flightstats.com/flex/connections/rest/v2/schema/xsd
JSON Schema https://api.flightstats.com/flex/connections/rest/v2/schema/json
Entry Points Name Description Response Elements
firstflightin/ First Flight In Connections arriving as early as possible before a given time Scheduled Flight
firstflightout/ First Flight Out Connections leaving as early as possible after a given time Scheduled Flight
lastflightin/ Last Flight In Connections arriving as late as possible before a given time Scheduled Flight
firstflightout/ Last Flight out Connections leaving as late as possible after a given time Scheduled Flight
Delay Index
The Delay Index API offers access to current departure performance at airports.
Base URI https://api.flightstats.com/flex/delayindex/rest/
Version v1
WADL https://api.flightstats.com/flex/delayindex/rest/application.wadl
WSDL https://api.flightstats.com/flex/delayindex/soap/v1/delayIndexService?wsdl
XSD https://api.flightstats.com/flex/delayindex/soap/v1/delayIndexService?xsd=1
Entry Points Name Description Response Elements
airports/ Delay Indexes for specified Airport(s) Delay Index information for the given airport(s) request, error, delayIndex
country/ Delay Index by Country code Delay Indexes for airports in the given Country request, error, delayIndex
region/ Delay Indexes by Region Delay Indexes for airports in the given Region request, error, delayIndex
state/ Delay Indexes by State code (US and Canada only) Delay Indexes for airports in the given State request, error, delayIndex
Equipment
The Equipment API provides basic reference data about aircraft equipment.
Base URI https://api.flightstats.com/flex/equipment/rest/
Version v1
WADL https://api.flightstats.com/flex/equipment/rest/v1/schema/wadl
WSDL https://api.flightstats.com/flex/equipment/soap/v1/equipmentService?wsdl
XSD https://api.flightstats.com/flex/equipment/rest/v1/schema/xsd
JSON Schema https://api.flightstats.com/flex/equipment/rest/v1/schema/json
Entry Points Name Description Response Elements
all/ All equipment Equipment information for all equipment. equipment
iata/ Equipment by IATA code Equipment information for equipment selected by IATA code. equipment
Flight Status & Track
Flight Status gives you access to current flight information, including scheduled, estimated and actual departure/arrival times, equipment type, delay calculations, terminal, gate and baggage carousel.
Flight Track gives you access to information on an active flight, including position (lat/long), previous positions, altitude, bearing, speed and route.
Flight Position provides recent positional information on flights in a defined area.
Base URI https://api.flightstats.com/flex/flightstatus/rest/
Version v2
WADL https://api.flightstats.com/flex/flightstatus/rest/application.wadl
Flight Service WSDL https://api.flightstats.com/flex/flightstatus/soap/v2/flightService?wsdl
Flight Service XSD https://api.flightstats.com/flex/flightstatus/soap/v2/flightService?xsd=1
Airport Service WSDL https://api.flightstats.com/flex/flightstatus/soap/v2/airportService?wsdl
Airport Service XSD https://api.flightstats.com/flex/flightstatus/soap/v2/airportService?xsd=1
Route Service WSDL https://api.flightstats.com/flex/flightstatus/soap/v2/routeService?wsdl
Route Service XSD https://api.flightstats.com/flex/flightstatus/soap/v2/routeService?xsd=1
Flights Near Service WSDL https://api.flightstats.com/flex/flightstatus/soap/v2/flightsNearService?wsdl
Flights Near Service XSD https://api.flightstats.com/flex/flightstatus/soap/v2/flightsNearService?xsd=1
Entry Points Name Description Response Elements
flight/status/ Flight Status by Flight Flight Status for a specific flight identified by Carrier, Flight, and Date, or by unique FlightStats identifier. request, appendix, error, flightStatus
flight/tracks/ Flight Track by Flight Flight Track for a specific flight identified by Carrier, Flight, and Date, or by unique FlightStats identifier. request, appendix, error, flightTrack
airport/status/ Flight Status by Airport Flight Status for flights arriving at or departing from a specific airport. request, appendix, error, flightStatus
airport/tracks/ Flight Track by Airport Flight Track for flights arriving at or departing from a specific airport. request, appendix, error, flightTrack
route/status/ Flight Status by Route Flight Status for flights identified by departure airport, arrival airport, and date. request, appendix, error, flightStatus
flightsNear/ Flights Near (an area) Positions for flights currently within an area (identifed by point and radius, or by geographic boundaries). request, appendix, error, flightPosition
FIDS
The FIDS API provides flight information suitable for use in Flight Information Display Systems.
Base URI https://api.flightstats.com/flex/fids/rest/
Version v1
WADL https://api.flightstats.com/flex/fids/rest/application.wadl
Entry Points Name Description Response Elements
fids/ FIDS for airport FIDS Data for departures/arrivals for a given airport. FIDS
Historical Flight Status
Historical Flight Status provides flight information for flights completed more than 48 hours ago. Information includes scheduled, estimated and actual departure/arrival times, equipment type, delay calculations, terminal, gate and baggage carousel.
Base URI https://api.flightstats.com/flex/flightstatus/historical/rest/
Version v2
WADL https://api.flightstats.com/flex/flightstatus/historical/rest/v3/schema/wadl
XSD https://api.flightstats.com/flex/flightstatus/historical/rest/v3/schema/xsd
JSON Schema https://api.flightstats.com/flex/flightstatus/historical/rest/v3/schema/json
Entry Points Name Description Response Elements
flight/ Historical Flight Status by Flight Historical Flight Status for a specific flight identified by Carrier, Flight, and Date, or by unique FlightStats identifier. Historical Flight Status
airport/ Historical Flight Status by Airport Historical Flight Status for flights that arrived at or departed from a specific airport. Historical Flight Status
route/ Historical Flight Status by Route Historical Flight Status for flights identified by departure airport, arrival airport, and date. Historical Flight Status
Historical Flight Tracks
Historical Flight Tracks provides flight position information for flights completed more than 48 hours ago. Information includes position (lat/long), altitude, bearing, speed and route. Flight plan can be included if available.
Base URI https://api.flightstats.com/flex/flightstatus/historical/rest/v1
Version v2
WADL https://api.flightstats.com/flex/flighttracks/historical/rest/v1/schema/wadl
XSD https://api.flightstats.com/flex/flighttracks/historical/rest/v1/schema/xsd
JSON Schema https://api.flightstats.com/flex/flighttracks/historical/rest/v1/schema/json
Entry Points Name Description Response Elements
flight/ Historical Flight Status by Flight Historical Flight Tracks for a specific flight identified by Carrier, Flight, and Date, or by unique FlightStats identifier. Historical Flight Tracks
airport/ Historical Flight Tracks by Airport Historical Flight Tracks for flights that arrived at or departed from a specific airport. Historical Flight Tracks
route/ Historical Flight Tracks by Route Historical Flight Tracks for flights identified by departure airport, arrival airport, and date. Historical Flight Tracks
Ratings
The Ratings API provides on-time and delay-based ratings.
Base URI https://api.flightstats.com/flex/ratings/rest/
Version v1
WADL https://api.flightstats.com/flex/ratings/rest/application.wadl
WSDL https://api.flightstats.com/flex/ratings/soap/v1/ratingsService?wsdl
XSD https://api.flightstats.com/flex/ratings/soap/v1/ratingsService?xsd=1
Entry Points Name Description Response Elements
flight/ Ratings for flight Ratings information for a given flight. request, appendix, error, ratings
route/ Ratings for route Ratings information for a given route. request, appendix, error, ratings
Schedules
The Schedules API provides access to the schedule information for upcoming flights. It is designed to work in conjunction with the FlightStatus APIs to provide continuity between scheduled flights in the future and real-time flight data in the present. It allows convenient search methods by flight, route and airport.
Base URI https://api.flightstats.com/flex/schedules/rest/
Version v1
WADL https://api.flightstats.com/flex/schedules/rest/application.wadl
WSDL https://api.flightstats.com/flex/schedules/soap/v1/scheduledFlightsService?wsdl
XSD https://api.flightstats.com/flex/schedules/soap/v1/scheduledFlightsService?xsd=1
Entry Points Name Description Response Elements
flight/ Scheduled flights Scheduled Flight information for direct flights by carrier and flight number. request, appendix, error, flights
route/ Scheduled flights by route Flight Schedules information for direct flights between two locations. request, appendix, error, flights
airport/ Scheduled flights by airport Flight Schedules information for flights arriving or departing an airport. request, appendix, error, flights
Entry Points Name Description Response Elements
direct/ Direct scheduled flights Flight Schedules information for direct flights by airport or flight. request, appendix, error, flights
connecting/ Direct and connecting scheduled flights Flight Schedules information for direct and connecting flights between two locations. request, appendix, error, flights
Weather
The Weather API provides information about current and future weather conditions affecting airports and flights. Weather information coverage is good for locations within the United States and is limited for other countries.
Base URI https://api.flightstats.com/flex/weather/rest/
Version v1
WADL https://api.flightstats.com/flex/weather/rest/application.wadl
WSDL https://api.flightstats.com/flex/weather/soap/v1/weatherService?wsdl
XSD https://api.flightstats.com/flex/weather/rest/application.wadl?xsd0.xsd
Entry Points Name Description Response Elements
all/ All weather products for airport Retrieve all weather products (METAR, TAF, and Zone Forecast) for the airport. request, appendix, error, METAR response, TAF response, Zone Forecast response
metar/ METAR for airport Retrieve the most current available METAR weather report for the aerodrome around a given airport. METAR reports describe current conditions and are updated about once an hour. request, appendix, error, METAR response
taf/ TAF for airport Retrieve the most current available Terminal Aerodrome Forecast (TAF) for the airport. TAFs forecast weather conditions for the area within a 5 mile radius from the center of the airport runway complex. request, appendix, error, TAF response
zf/ Zone Forecast for airport Retrieve the most current available zone forecast for the airport. Zone forecasts can cover several days, and apply to a more extensive area around the airport than TAFs. request, appendix, error, TAF response