FlightXML2 Web Services -- WSDL(xml)

author FlightAware
beautifyJson N
checkheader ::WS::Server::ok
description FlightXML2 Web Services
docFormat html
host flightxml.flightaware.com
htmlhead FlightXML2 Web Services
inheaders N/A
mode rivet
outheaders N/A
ports 80
prefix /soap/FlightXML2
stylesheet http://e1.flightcdn.com/commercial/flightxml/flightxml2.css
traceEnabled N
uri FlightXML2

List of Operations


List of Operations | Operation Details | Simple Types | Custom Types

Operation Details

AircraftType

Description

Given an aircraft type string such as GALX, AircraftType returns information about that type, comprising the manufacturer (for instance, "IAI"), type (for instance, "Gulfstream G200"), and description (like "twin-jet").

Inputs

Name Type Description
type string aircraft type ID

Returns

Type Description
AircraftTypeStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

AirlineFlightInfo

Description

AirlineFlightInfo returns additional information about a commercial airline flight, such as gate, baggage claim, and meal service information. This information is currently only available for some carriers and flights. To obtain the faFlightID, you can use a function such as GetFlightID, FlightInfoEx, or InFlightInfo.

Inputs

Name Type Description
faFlightID string unique identifier assigned by FlightAware for this flight (or use "ident@departureTime")

Returns

Type Description
AirlineFlightInfoStruct Additional information about the airline flight

List of Operations | Operation Details | Simple Types | Custom Types

AirlineFlightSchedules

Description

AirlineFlightSchedules returns flight schedules that have been published by airlines. These schedules are available for the recent past as well as up to one year into the future. Flights performed by airline codeshares are also returned in these results.

Inputs

Name Type Description
startDate int timestamp of earliest flight departure to return, specified in integer seconds since 1970 (UNIX epoch time)
endDate int timestamp of latest flight departure to return, specified in integer seconds since 1970 (UNIX epoch time)
origin string optional airport code of origin. If blank or unspecified, then flights with any origin will be returned.
destination string optional airport code of destination. If blank or unspecified, then flights with any destination will be returned.
airline string optional airline code of the carrier. If blank or unspecified, then flights on any airline will be returned.
flightno string optional flight number. If blank or unspecified, then any flight number will be returned.
howMany int maximum number of past records to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0 (most recent report).

Returns

Type Description
ArrayOfAirlineFlightScheduleStruct Additional information about the airline flight

List of Operations | Operation Details | Simple Types | Custom Types

AirlineInfo

Description

AirlineInfo returns information about a commercial airline/carrier given an ICAO airline code.

Inputs

Name Type Description
airlineCode string the ICAO airline ID (e.g., COA, ASA, UAL, etc.)

Returns

Type Description
AirlineInfoStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

AirlineInsight

Description

AirlineInsight returns historical booking and airfare information that has been published by airlines. Currently this information is only available for airports located within the United States and its territories. Information is historical and is aggregated from the 12 months prior to the most recently published (generally 4 to 6 months delayed). The returned data may involve estimated or extrapolated amounts.

This function can return one of several types of reports, as specified by the reportType argument:

Inputs

Name Type Description
origin string airport code of origin
destination string airport code of destination
reportType int type of report to obtain (see list of values above)

Returns

Type Description
ArrayOfAirlineInsightStruct Additional information about the airline flight

List of Operations | Operation Details | Simple Types | Custom Types

AirportInfo

Description

AirportInfo returns information about an airport given an ICAO airport code such as KLAX, KSFO, KORD, KIAH, O07, etc. Data returned includes name (Houston Intercontinental Airport), location (typically city and state), latitude and longitude, and timezone (:America/Chicago).

The returned timezone is specified in a format that is compatible with the official IANA zoneinfo database and can be used to convert the timestamps returned by all other functions into localtimes. Support for timestamp conversion using zoneinfo identifiers is available natively or through third-party libraries for most programming languages. In some cases, the leading colon (":") character may need to be removed from the timezone identifier in order for it to be recognized by some timezone libraries.

Inputs

Name Type Description
airportCode string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
AirportInfoStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

AllAirlines

Description

AllAirlines returns the ICAO identifiers of all known commercial airlines/carriers.

See AirlineInfo to retrieve additional information about any of the identifiers returned.

Inputs

No inputs.

Returns

Type Description
ArrayOfString returned results

List of Operations | Operation Details | Simple Types | Custom Types

AllAirports

Description

AllAirports returns the ICAO identifiers of all known airports. For airports that do not have an ICAO identifier, the FAA LID identifier will be used.

See AirportInfo to retrieve additional information about any of the identifiers returned.

Inputs

No inputs.

Returns

Type Description
ArrayOfString returned results

List of Operations | Operation Details | Simple Types | Custom Types

Arrived

Description

Arrived returns information about flights that have recently arrived for the specified airport and maximum number of flights to be returned. Flights are returned from most to least recent. Only flights that arrived within the last 24 hours are considered.

Times returned are seconds since 1970 (UNIX epoch seconds).

See also Departed, Enroute, and Scheduled for other airport tracking functionality.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
howMany int determines the number of results. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
filter string can be "ga" to show only general aviation traffic, "airline" to only show airline traffic, or null/empty to show all traffic.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
ArrivalStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

BlockIdentCheck

Description

Given an aircraft identification, returns 1 if the aircraft is blocked from public tracking, 0 if it is not.

Inputs

Name Type Description
ident string requested tail number

Returns

Type Description
int returned results

List of Operations | Operation Details | Simple Types | Custom Types

CountAirportOperations

Description

Given an airport, CountAirportOperations returns integer values on the number of aircraft scheduled or actually en route or departing from the airport. Scheduled arrival is a non-airborne flight that is scheduled to the airport in question.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
CountAirportOperationsStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

CountAllEnrouteAirlineOperations

Description

CountAllEnrouteAirlineOperations returns an array of airlines and how many flights each currently has enroute.

Inputs

No inputs.

Returns

Type Description
ArrayOfCountAirlineOperationsStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

DecodeFlightRoute

Description

Given a flight identifier (faFlightID) of a past, current, or future flight, DecodeFlightRoute returns a "cracked" list of noteworthy navigation points along the planned flight route. The list represents the originally planned route of travel, which may differ slightly from the actual flight path flown. The returned list will include the name, type, latitude, and longitude of each point. Additional reporting points along the route may be automatically included in the returned list. Not all flight routes can be successfully decoded by this function, particularly if the flight is not entirely within the continental U.S. airspace, since this function only has access to navaids within that area. To obtain the faFlightID, you can use a function such as GetFlightID, FlightInfoEx, or InFlightInfo.

For an alternate version of this function that lets you specify the route, see DecodeRoute.

Inputs

Name Type Description
faFlightID string unique identifier assigned by FlightAware for the desired flight (or use "ident@departureTime")

Returns

Type Description
ArrayOfFlightRouteStruct returned list of route points

List of Operations | Operation Details | Simple Types | Custom Types

DecodeRoute

Description

Given an origin airport, destination airport, and a route between them, DecodeRoute returns a "cracked" list of noteworthy navigation points along the planned flight route. The list represents the originally planned route of travel, which may differ slightly from the actual flight path flown. The returned list will include the name, type, latitude, and longitude of each point. Additional reporting points along the route may be automatically included in the returned list. Not all flight routes can be successfully decoded by this function, particularly if the flight is not entirely within the continental U.S. airspace, since this function only has access to navaids within that area.

For an alternate version of this function that lets you specify an existing flight identifier, see DecodeFlightRoute.

Inputs

Name Type Description
origin string origin airport code
route string space separated list of intersections and/or VORs along the route
destination string destination airport code

Returns

Type Description
ArrayOfFlightRouteStruct returned list of route points

List of Operations | Operation Details | Simple Types | Custom Types

DeleteAlert

Description

DeleteAlert deletes a FlightXML flight alert.

The other methods SetAlert, GetAlerts, and RegisterAlertEndpoint can be used to manage FlightXML flight alerts.

Inputs

Name Type Description
alert_id int alert_id to delete

Returns

Type Description
int returns 1 on success

List of Operations | Operation Details | Simple Types | Custom Types

Departed

Description

Departed returns information about already departed flights for a specified airport and maximum number of flights to be returned. Departed flights are returned in order from most recently to least recently departed. Only flights that have departed within the last 24 hours are considered.

Times returned are seconds since 1970 (UNIX epoch seconds).

See also Arrived, Enroute, and Scheduled for other airport tracking functionality.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
howMany int determines the number of results. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
filter string can be "ga" to show only general aviation traffic, "airline" to only show airline traffic, or null/empty to show all traffic.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
DepartureStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

Enroute

Description

Enroute returns information about flights already in the air for the specified airport and maximum number of flights to be returned. Enroute flights are returned from soonest estimated arrival to least soon estimated arrival.

See also Arrived, Departed, and Scheduled for other airport tracking functionality.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
howMany int determines the number of results. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
filter string can be "ga" to show only general aviation traffic, "airline" to only show airline traffic, or null/empty to show all traffic.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
EnrouteStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

FleetArrived

Description

FleetArrived returns information about recently arrived flights belonging to an aircraft fleet. Only flights that have arrived within the last 24 hours are considered. Codeshares and alternate idents are NOT considered.

The next_offset value returned advises an application of the next offset to use (if more data is available).

Times returned are seconds since 1970 (UNIX epoch seconds).

See also FleetScheduled for other fleet tracking functionality.

Inputs

Name Type Description
fleet string must be an ICAO prefix (e.g., COA, DAL, UAL, OPT, etc.)
howMany int determines the number of results. must be an integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int an integer value of the offset row count you want the search to start at. Most requests should be 0

Returns

Type Description
ArrivalStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

FleetScheduled

Description

FleetScheduled returns information about scheduled flights belonging to an aircraft fleet. Scheduled flights are returned from soonest to furthest in the future to depart. Only flights that have not actually departed, and have a scheduled departure time between 2 hours in the past and 24 hours in the future, are considered. Codeshares and alternate idents are NOT considered.

The next_offset value returned advises an application of the next offset to use (if more data is available).

Times returned are seconds since 1970 (UNIX epoch time).

See also FleetArrived for other fleet tracking functionality.

Inputs

Name Type Description
fleet string must be an ICAO prefix (e.g., COA, DAL, UAL, OPT, etc.)
howMany int determines the number of results. must be an integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int an integer value of the offset row count you want the search to start at. Most requests should be 0

Returns

Type Description
ScheduledStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

FlightInfo

Description

FlightInfo returns information about flights for a specific tail number (e.g., N12345), or ICAO airline code with flight number (e.g., SWA2558).

The howMany argument specifies the maximum number of flights to be returned. Flight information will be returned from newest to oldest. The oldest flights searched by this function are about 2 weeks in the past.

When specifying an airline with flight number, wither an ICAO or IATA code may be used to designate the airline, howver andCodeshares and alternate idents are automatically searched.

Times are in integer seconds since 1970 (UNIX epoch time), except for estimated time enroute, which is in hours and minutes.

See FlightInfoEx for a more advanced interface.

Inputs

Name Type Description
ident string requested tail number, or airline with flight number
howMany int maximum number of past flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.

Returns

Type Description
FlightInfoStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

FlightInfoEx

Description

FlightInfoEx returns information about flights for a specific tail number (e.g., N12345), or an ident (typically an ICAO airline with flight number, e.g., SWA2558), or a FlightAware-assigned unique flight identifier (e.g. faFlightID returned by another FlightXML function).

The howMany argument specifies the maximum number of flights to be returned. When a tail number or ident is specified and multiple flights are available, the results will be returned from newest to oldest. The oldest flights searched by this function are about 2 weeks in the past. Codeshares and alternate idents are automatically searched. When a FlightAware-assigned unique flight identifier is supplied, at most a single result will be returned.

Times are in integer seconds since 1970 (UNIX epoch time), except for estimated time enroute, which is in hours and minutes.

See FlightInfo for a simpler interface.

Inputs

Name Type Description
ident string requested tail number, or airline with flight number, or faFlightID, or "ident@departureTime"
howMany int maximum number of past flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
FlightInfoExStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

GetAlerts

Description

GetAlerts retrieves all of the FlightXML flight alerts that are currently scheduled for the user.

The other methods SetAlert, DeleteAlert, and RegisterAlertEndpoint can be used to manage FlightXML flight alerts.

Note: If other alerts have been defined by the user on the FlightAware website or mobile app, they will also be included in the returned listing.

Inputs

No inputs.

Returns

Type Description
FlightAlertListing all defined alerts by the user

List of Operations | Operation Details | Simple Types | Custom Types

GetFlightID

Description

GetFlightID looks up the "faFlightID" for a given ident and departure time. This value is a unique identifier assigned by FlightAware as a way to permanently identify a flight. The specified departure time must exactly match either the actual or scheduled departure time of the flight. The departureTime is specified as integer seconds since 1970 (UNIX epoch time).

If more than one flight corresponds to the specified ident and departure time, then only the first matching faFlightID is returned. Codeshares and alternate idents are automatically searched.

Inputs

Name Type Description
ident string requested tail number
departureTime int time and date of the desired flight, UNIX epoch seconds since 1970

Returns

Type Description
string returned faFlightID

List of Operations | Operation Details | Simple Types | Custom Types

GetHistoricalTrack

Description

GetHistoricalTrack looks up a past flight's track log by its unique identifier. To obtain the faFlightID, you can use a function such as GetFlightID, FlightInfoEx, or InFlightInfo.

This function returns an array of positions, with each including the timestamp, longitude, latitude, groundspeed, altitude, altitudestatus, updatetype, and altitudechange. Altitude is in hundreds of feet or Flight Level where appropriate, see our FAQ about flight levels. Also included is altitude status, update type, and altitude change.

Altitude status is 'C' when the flight is more than 200 feet away from its ATC-assigned altitude. (For example, the aircraft is transitioning to its assigned altitude.) Altitude change is 'C' if the aircraft is climbing (compared to the previous position reported), 'D' for descending, and empty if it is level. This happens for VFR flights with flight following, among other things. Timestamp is integer seconds since 1970 (UNIX epoch time).

Use the GetLastTrack function to look up just the most recent flight rather than a specific historical one.

Inputs

Name Type Description
faFlightID string unique identifier assigned by FlightAware for the desired flight (or use "ident@departureTime")

Returns

Type Description
ArrayOfTrackStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

GetLastTrack

Description

GetLastTrack looks up a flight's track log by specific tail number (e.g., N12345) or ICAO airline and flight number (e.g., SWA2558). It returns the track log from the current IFR flight or, if the aircraft is not airborne, the most recent IFR flight. It returns an array of positions, with each including the timestamp, longitude, latitude, groundspeed, altitude, altitudestatus, updatetype, and altitudechange. Altitude is in hundreds of feet or Flight Level where appropriate, see our FAQ about flight levels. Also included altitude status, update type, and altitude change.

Altitude status is 'C' when the flight is more than 200 feet away from its ATC-assigned altitude. (For example, the aircraft is transitioning to its assigned altitude.) Altitude change is 'C' if the aircraft is climbing (compared to the previous position reported), 'D' for descending, and empty if it is level. This happens for VFR flights with flight following, among other things. Timestamp is integer seconds since 1970 (UNIX epoch time).

This function only returns tracks for recent flights within approximately the last 24 hours. Use the GetHistoricalTrack function to look up a specific past flight rather than just the most recent one. Codeshares and alternate idents are automatically searched.

Inputs

Name Type Description
ident string requested tail number

Returns

Type Description
ArrayOfTrackStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

InboundFlightInfo

Description

InboundFlightInfo returns information about the flight being served by the same aircraft that will service a future flight. To obtain the faFlightID, you can use a function such as GetFlightID, FlightInfoEx, or InFlightInfo.

The inbound flight can only be determined with accuracy for some commercial airlines. If the inbound flight cannot be determined, an error will be returned.

Times are in integer seconds since 1970 (UNIX epoch time), except for estimated time enroute, which is in hours and minutes.

Inputs

Name Type Description
faFlightID string unique identifier assigned by FlightAware of the desired flight

Returns

Type Description
FlightExStruct returned inbound flight

List of Operations | Operation Details | Simple Types | Custom Types

InFlightInfo

Description

InFlightInfo looks up a specific tail number (e.g., N12345) or ICAO airline and flight number (e.g., SWA2558) and returns current position/direction/speed information. It is only useful for currently airborne flights within approximately the last 24 hours. Codeshares and alternate idents are automatically searched.

Inputs

Name Type Description
ident string requested tail number

Returns

Type Description
InFlightAircraftStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

LatLongsToDistance

Description

Given two latitudes and longitudes, lat1 lon1 lat2 and lon2, respectively, determine the great circle distance between those positions in miles. The returned distance is rounded to the nearest whole mile.

Inputs

Name Type Description
lat1 float Latitude of point 1
lon1 float Longitude of point 1
lat2 float Latitude of point 2
lon2 float Longitude of point 2

Returns

Type Description
int returned distance

List of Operations | Operation Details | Simple Types | Custom Types

LatLongsToHeading

Description

Given two latitudes and longitudes, lat1 lon1 lat2 and lon2, respectively, calculate and return the initial compass heading (where 360 is North) from position one to position two. Quite accurate for relatively short distances but since it assumes the earth is a sphere rather than on irregular oblate sphereoid may be inaccurate for flights around a good chunk of the world, etc.

Inputs

Name Type Description
lat1 float Latitude of point 1
lon1 float Longitude of point 1
lat2 float Latitude of point 2
lon2 float Longitude of point 2

Returns

Type Description
int returned heading

List of Operations | Operation Details | Simple Types | Custom Types

MapFlight

Description

This function will return a base64 encoded GIF or PNG image (with the height and width as specified in pixels) of the current flight of a specified ident. If the aircraft is not currently in the air, then a blank image may be returned. Codeshares and alternate idents are automatically searched.

See MapFlightEx for a more advanced interface with historical flight capabilities.

Inputs

Name Type Description
ident string requested tail number
mapHeight int width of requested image, in pixels
mapWidth int height of requested image, in pixels

Returns

Type Description
string returned image data

List of Operations | Operation Details | Simple Types | Custom Types

MapFlightEx

Description

This function will return a base64 encoded GIF or PNG image (with the height and width as specified in pixels) of a specific flight. The flight may be a current or historical flight, but it must be specified using the unique FlightAware-assigned identifier for the desired flight. To obtain the faFlightID, you can use a function such as GetFlightID, FlightInfoEx, or InFlightInfo.

The layer_on and layer_off arguments are specify what map features to include or exclude. The available layers and its default mode is shown below:

See MapFlight for a simpler interface.

Inputs

Name Type Description
faFlightID string unique identifier assigned by FlightAware for the desired flight (or use "ident@departureTime")
mapHeight int width of requested image, in pixels
mapWidth int height of requested image, in pixels
layer_on string() optional list of map layer names to enable
layer_off string() optional list of map layer names to disable
show_data_blocks boolean if true, a textual caption of the ident, type, heading, altitude, origin, and destination will be displayed below the flight position.
show_airports boolean if true, show the origin/destination airports as dots with textual labels.
airports_expand_view boolean if true, force zoom area to ensure origin/destination airports are visible. show_airports must also be true to use this feature.
latlon_box float() optionally specify the zoom area. if specified, should be a list of 4 elements (hilat, lowlon, lowlat, hilon), otherwise an automatic zoom will be used.

Returns

Type Description
string returned image data

List of Operations | Operation Details | Simple Types | Custom Types

Metar

Description

Given an airport, return the current raw METAR weather info. If no reports are available at the requested airport but are for a nearby airport, then the report from that airport may be returned instead.

Use the MetarEx function for more functionality, including access to historical weather and parsed.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
string returned results

List of Operations | Operation Details | Simple Types | Custom Types

MetarEx

Description

Given an airport, return the METAR weather info as parsed, human-readable, and raw formats. If no reports are available at the requested airport but are for a nearby airport, then the reports from that airport may be returned instead. If a value greater than 1 is specified for howMany then multiple past reports will be returned, in order of increasing age. Historical data is generally only available for the last 7 days.

Use the Metar function for a simpler interface to access just the most recent raw report.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
startTime int the latest date and time to begin retrieving results from (in seconds since 1970), enumerating backwards in time when howMany is non-zero. If specified as zero, then the most recent report available is assumed.
howMany int maximum number of past records to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0 (most recent report).

Returns

Type Description
ArrayOfMetarStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

NTaf

Description

Given an airport, return the terminal area forecast, if available.

See Taf for a simpler interface.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
TafStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

RegisterAlertEndpoint

Description

RegisterAlertEndpoint specifies where pushed FlightXML flight alerts. Calling this method a second time will overwrite any previously registered endpoint.

The other methods SetAlert, GetAlerts, and DeleteAlert can be used to manage FlightXML flight alerts.

The "format_type" argument controls how the flight alert is delivered to the specified address. Currently "format_type" must always be "json/post", although other formats may be introduced in the future. When an alert occurs, FlightAware servers will deliver an HTTP POST to the specified address with the body containing a JSON-encoded message about the alert and flight.

Returns 1 on success, otherwise an error record is returned.

Inputs

Name Type Description
address string URL of endpoint
format_type string Must be "json/post"

Returns

Type Description
int returns 1 on success

List of Operations | Operation Details | Simple Types | Custom Types

RoutesBetweenAirports

Description

RoutesBetweenAirports returns information about assigned IFR routings between two airports. For each known routing, the route, number of times that route has been assigned, and the filed altitude (measured in hundreds of feet or Flight Level) are returned. Only flights that departed within the last 6 hours and flight plans filed within the last 3 days are considered.

See RoutesBetweenAirportsEx for additional functionality.

Inputs

Name Type Description
origin string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
destination string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
ArrayOfRoutesBetweenAirportsStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

RoutesBetweenAirportsEx

Description

RoutesBetweenAirportsEx returns information about assigned IFR routings between two airports. This is an extended version of RoutesBetweenAirports that allows you to specify the maximum age of flights to consider. For each known routing, the route, number of times that route has been assigned, the filed altitude (lowest and highest among found plans, measured in 100 ft intervals), and the most recent filed departure date/time are returned.

See RoutesBetweenAirports for a simpler interface.

Inputs

Name Type Description
origin string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
destination string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
howMany int maximum number of past flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.
maxDepartureAge string maximum departure age of flights to consider (for example: "3 days" or "72 hours")
maxFileAge string maximum filed plan age of flights to consider (for example: "6 days"). This should generally be longer than maxDepartureAge.

Returns

Type Description
ArrayOfRoutesBetweenAirportsExStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

Scheduled

Description

Scheduled returns information about scheduled flights (technically, filed IFR flights) for a specified airport and a maximum number of flights to be returned. Scheduled flights are returned from soonest to furthest in the future to depart. Only flights that have not actually departed, and have a scheduled departure time between 2 hours in the past and 24 hours in the future, are considered.

Times returned are seconds since 1970 (UNIX epoch time).

See also Arrived, Departed, and Enroute for other airport tracking functionality.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)
howMany int determines the number of results. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
filter string can be "ga" to show only general aviation traffic, "airline" to only show airline traffic, or null/empty to show all traffic.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
ScheduledStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

Search

Description

Search performs a query for data on all airborne aircraft to find ones matching the search query. Query parameters include a latitude/longitude box, aircraft ident with wildcards, type with wildcards, prefix, suffix, origin airport, destination airport, origin or destination airport, groundspeed, and altitude. It takes search terms in a single string comprising "-key value" pairs and returns an array of flight structures. Codeshares and alternate idents are NOT searched when using the -idents clause.

Keys include:

To search for all aircraft below ten-thousand feet with a groundspeed over 200 kts:

-belowAltitude 100 -aboveGroundspeed 200

To search for all in-air Boeing 777s:

-type B77*

To search for all aircraft heading to Los Angeles International Airport (LAX) that are "heavy" aircraft:

-destination LAX -prefix H

To search for all United Airlines flights in Boeing 737s

-idents UAL* -type B73*

See the SearchBirdseyeInFlight function for additional functionality.

Inputs

Name Type Description
query string search expression
howMany int maximum number of flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
InFlightStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

SearchBirdseyeInFlight

Description

SearchBirdseyeInFlight performs a query for all aircraft matching the search query. Query parameters include a latitude/longitude box, aircraft ident with wildcards, type with wildcards, prefix, suffix, origin airport, destination airport, origin or destination airport, groundspeed, and altitude. It takes search terms in a single string comprising of {operator key value} elements and returns an array of flight structures. Each search term must be enclosed in curly braces. Multiple search terms can be combined in an implicit boolean "and" by separating the terms with at least one space. This function only searches flight data representing approximately the last 24 hours. Codeshares and alternate idents are NOT searched when matching against the ident key.

The supported operators include (note that operators take different numbers of arguments):

The supported key names include (note that not all of these key names are returned in the result structure, and some have slightly different names):

Some example queries:

QueryDescription
{< alt 100} {> gs 200} All aircraft below ten-thousand feet with a groundspeed over 200 kts
{match aircraftType B77*} All in-air Boeing 777s
{= dest KLAX} {= prefix H} All aircraft heading to Los Angeles International Airport (LAX) that are "heavy" aircraft
{match ident UAL*} {match aircraftType B73*} All United Airlines flights in Boeing 737s
{true lifeguard} All "lifeguard" rescue flights
{in orig {KLAX KBUR KSNA KLGB KVNY KSMO KLGB KONT}} {in dest {KJFK KEWR KLGA KTEB KHPN}} All flights between Los Angeles area and New York area
{range lat 36.897669 40.897669} {range lon -79.03655 -75.03655} All flights with a last reported position +/- 2 degrees of the Whitehouse
{> lastPositionTime 1278610758} {true inAir} {!= physClass P} {> circles 3} All flights that have a reported position after a specified epoch time, are still in the air, are not piston class, and have made several circular flight patterns (potentially in distress)

See the Search function for a simpler interface.

Inputs

Name Type Description
query string search expression
howMany int maximum number of flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
InFlightStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

SearchBirdseyePositions

Description

SearchBirdseyePositions performs a query for aircraft flightpath datapoints matching the search query. This allows you to locate flights that have ever flown within a specific a latitude/longitude box, groundspeed, and altitude. It takes search terms in a single string comprising of {operator key value} elements and returns an array of flight structures. Each search term must be enclosed in curly braces. Multiple search terms can be combined in an implicit boolean "and" by separating the terms with at least one space. This function only searches flight data representing approximately the last 24 hours.

The supported operators include (note that operators take different numbers of arguments):

The supported key names include (note that not all of these key names are returned in the result structure, and some have slightly different names):

Some example queries:

QueryDescription
{< alt 100} {> gs 200} All flight positions below ten-thousand feet with a groundspeed over 200 kts
{match fp ASA*} {> lat 45} All Alaska Airlines flight positions north of the 45th parallel
{range lat 36.897669 40.897669} {range lon -79.03655 -75.03655} All flight positions +/- 2 degrees of the lat/lon of the Whitehouse
{= fp UAL1516-1230998450-98986-22} All flight positions for a specific flight identifier (faFlightID)

See the SearchBirdseyeInFlight function for a similar function that searches only the most last reported position of aircraft but has more search criteria.

Inputs

Name Type Description
query string optional search expression to limit matches. For example: {< alt 5000} to search for flights under a given altitude
uniqueFlights boolean if true, only one flight position will be returned per unique faFlightID. if false, all matching flight positions will be returned
howMany int maximum number of flights to obtain. Must be a positive integer value less than or equal to 15, unless SetMaximumResultSize has been called.
offset int must be an integer value of the offset row count you want the search to start at. Most requests should be 0.

Returns

Type Description
ArrayOfTrackExStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

SearchCount

Description

SearchCount works like Search but returns a count of matching flights rather than information about each flight.

Inputs

Name Type Description
query string search expression

Returns

Type Description
int number of results that would be returned by Search

List of Operations | Operation Details | Simple Types | Custom Types

SetAlert

Description

SetAlert creates or updates a FlightXML flight alert. When the alert is triggered, a callback mechanism will be used to notify the address specified by RegisterAlertEndpoint. Each alert that is triggered is charged at the rate of one "class 2" FlightXML query.

If the "alert_id" argument is specified, then an existing alert is updated to the new values specified, otherwise a 0 or blank alert_id will cause a new alert to be created.

As a special case, if "alert_id" is specified as -1 and "ident" is not blank, update the most recently modified alert for the same "ident" to the arguments specified. If no existing alert for that "ident" exists, create it.

For a single day alert, specify date_start and date_end with the same value. For a recurring alert, specify both date_start as 0 and date_end as 0.

The "channel" argument is a Tcl-style string list that specifies the target channel ID and the triggering event types. At this time, the channel ID should always be specified as 16. Supported event types are: e_filed e_departure e_arrival e_diverted e_cancelled. For example this specifies a FlightXML Push channel with several flight statuses: "{16 e_filed e_departure e_arrival e_diverted e_cancelled}"

The "max_weekly" argument is used to prevent the an alert from being created that might generate more alerts than desired. This check is only done at alert creation time based on historical trends for the filter selection, and is not an enforcement of alerts actually delivered.

Returns a non-zero number (the alert_id that was added or updated) on success, otherwise an exception is raised. An error string beginning with "OVERLIMIT" means the user has exceeded the maximum number of enabled alerts permitted by their account type; consider disabling or deleting some alerts, or request an account upgrade. An error string beginning with "FLOODWARN" means that the new alert was rejected because it was predicted to exceed the number of alerts specified by the "max_weekly" argument.

Inputs

Name Type Description
alert_id int alert_id of an existing alert to update. specify 0 or "" to create a new alert. specify -1 to upsert an alert. otherwise an existing alert id.
ident string optional ident or faFlightID of flight
origin string optional origin airport code
destination string optional destination airport code
aircrafttype string optional aircraft type
date_start int optional starting date of alert (in epoch seconds, will be rounded to whole day)
date_end int optional ending date of alert (in epoch seconds, will be rounded to whole day)
channels string list of channels and event types (see description for syntax)
enabled boolean whether the alert should be enabled or disabled (if missing, default is true)
max_weekly int reject the new alert if the estimated number of alerts per week exceeds this amount (recommended default 1000)

Returns

Type Description
int returns non-zero on success

List of Operations | Operation Details | Simple Types | Custom Types

SetMaximumResultSize

Description

SetMaximumResultSize modifies the maximum result count returned by other FlightXML methods. Many FlightXML methods that return lists limit the number of results to 15 records for performance reasons, even if you specify a larger number to its "howMany" argument. Using this method, you can raise the limit allowed for the "howMany" argument for all subsequent FlightXML methods invoked using your account. Once invoked, the last specified max_size is remembered for your account until the next call to SetMaximumResultSize; it is not necessary to call this function repeatedly.

Any request that has a "howMany" argument and returns more than 15 records will be billed at a rate equivalent to the actual number of results returned divided by 15, rounded up. For example, if you call SetMaximumResultSize with a max_size of 100, then call FlightInfo with howMany of 45, but it only returns 35 records, you will be charged the equivalent of calling FlightInfo a total of 3 times, or 1+int(35/15).

Inputs

Name Type Description
max_size int Maximum number of results allowed to be returned

Returns

Type Description
int always returns 0

List of Operations | Operation Details | Simple Types | Custom Types

Taf

Description

Given an airport, return the terminal area forecast, if available.

See NTaf for a more advanced interface.

Inputs

Name Type Description
airport string the ICAO airport ID (e.g., KLAX, KSFO, KIAH, KHOU, KJFK, KEWR, KORD, KATL, etc.)

Returns

Type Description
string returned results

List of Operations | Operation Details | Simple Types | Custom Types

TailOwner

Description

TailOwner returns information about an the owner of an aircraft, given a flight number or N-number. Data returned includes owner's name, location (typically city and state), and website, if any. Codeshares and alternate idents are automatically searched.

Inputs

Name Type Description
ident string requested tail number

Returns

Type Description
TailOwnerStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

ZipcodeInfo

Description

ZipcodeInfo returns information about a five-digit zipcode. Of particular importance is latitude and longitude.

Inputs

Name Type Description
zipcode string a five-digit U.S. Postal Service zipcode.

Returns

Type Description
ZipcodeInfoStruct returned results

List of Operations | Operation Details | Simple Types | Custom Types

Custom Types

AircraftTypeRequest

Field Type
type string

AircraftTypeResults

Field Type
AircraftTypeResult AircraftTypeStruct

AircraftTypeStruct

Field Type
description string
manufacturer string
type string

AirlineFlightInfoRequest

Field Type
faFlightID string

AirlineFlightInfoResults

Field Type
AirlineFlightInfoResult AirlineFlightInfoStruct

AirlineFlightInfoStruct

Field Type
bag_claim string
codeshares string()
faFlightID string
gate_dest string
gate_orig string
ident string
meal_service string
seats_cabin_business int
seats_cabin_coach int
seats_cabin_first int
tailnumber string
terminal_dest string
terminal_orig string

AirlineFlightSchedulesRequest

Field Type
airline string
destination string
endDate int
flightno string
howMany int
offset int
origin string
startDate int

AirlineFlightSchedulesResults

Field Type
AirlineFlightSchedulesResult ArrayOfAirlineFlightScheduleStruct

AirlineFlightScheduleStruct

Field Type
actual_ident string
aircrafttype string
arrivaltime int
departuretime int
destination string
ident string
meal_service string
origin string
seats_cabin_business int
seats_cabin_coach int
seats_cabin_first int

AirlineInfoRequest

Field Type
airlineCode string

AirlineInfoResults

Field Type
AirlineInfoResult AirlineInfoStruct

AirlineInfoStruct

Field Type
callsign string
country string
location string
name string
phone string
shortname string
url string

AirlineInsightRequest

Field Type
destination string
origin string
reportType int

AirlineInsightResults

Field Type
AirlineInsightResult ArrayOfAirlineInsightStruct

AirlineInsightStruct

Field Type
carrier string
destination string
fare_max string
fare_median string
fare_min string
flights_performed int
flights_scheduled int
layover string
opcarrier string
origin string
percent float
total_mail int
total_passengers int
total_payload int
total_seats int

AirportInfoRequest

Field Type
airportCode string

AirportInfoResults

Field Type
AirportInfoResult AirportInfoStruct

AirportInfoStruct

Field Type
latitude float
location string
longitude float
name string
timezone string

AllAirlinesRequest

Field Type

AllAirlinesResults

Field Type
AllAirlinesResult ArrayOfString

AllAirportsRequest

Field Type

AllAirportsResults

Field Type
AllAirportsResult ArrayOfString

ArrayOfAirlineFlightScheduleStruct

Field Type
data AirlineFlightScheduleStruct()
next_offset int

ArrayOfAirlineInsightStruct

Field Type
data AirlineInsightStruct()
end_date int
start_date int

ArrayOfCountAirlineOperationsStruct

Field Type
data CountAirlineOperationsStruct()

ArrayOfFlightRouteStruct

Field Type
data FlightRouteStruct()
next_offset int

ArrayOfMetarStruct

Field Type
metar MetarStruct()
next_offset int

ArrayOfRoutesBetweenAirportsExStruct

Field Type
data RoutesBetweenAirportsExStruct()
next_offset int

ArrayOfRoutesBetweenAirportsStruct

Field Type
data RoutesBetweenAirportsStruct()

ArrayOfString

Field Type
data string()

ArrayOfTrackExStruct

Field Type
data TrackExStruct()
next_offset int

ArrayOfTrackStruct

Field Type
data TrackStruct()

ArrivalFlightStruct

Field Type
actualarrivaltime int
actualdeparturetime int
aircrafttype string
destination string
destinationCity string
destinationName string
ident string
origin string
originCity string
originName string

ArrivalStruct

Field Type
arrivals ArrivalFlightStruct()
next_offset int

ArrivedRequest

Field Type
airport string
filter string
howMany int
offset int

ArrivedResults

Field Type
ArrivedResult ArrivalStruct

BlockIdentCheckRequest

Field Type
ident string

BlockIdentCheckResults

Field Type
BlockIdentCheckResult int

CountAirlineOperationsStruct

Field Type
enroute int
icao string
name string

CountAirportOperationsRequest

Field Type
airport string

CountAirportOperationsResults

Field Type
CountAirportOperationsResult CountAirportOperationsStruct

CountAirportOperationsStruct

Field Type
departed int
enroute int
scheduled_arrivals int
scheduled_departures int

CountAllEnrouteAirlineOperationsRequest

Field Type

CountAllEnrouteAirlineOperationsResults

Field Type
CountAllEnrouteAirlineOperationsResult ArrayOfCountAirlineOperationsStruct

DecodeFlightRouteRequest

Field Type
faFlightID string

DecodeFlightRouteResults

Field Type
DecodeFlightRouteResult ArrayOfFlightRouteStruct

DecodeRouteRequest

Field Type
destination string
origin string
route string

DecodeRouteResults

Field Type
DecodeRouteResult ArrayOfFlightRouteStruct

DeleteAlertRequest

Field Type
alert_id int

DeleteAlertResults

Field Type
DeleteAlertResult int

DepartedRequest

Field Type
airport string
filter string
howMany int
offset int

DepartedResults

Field Type
DepartedResult DepartureStruct

DepartureFlightStruct

Field Type
actualarrivaltime int
actualdeparturetime int
aircrafttype string
destination string
destinationCity string
destinationName string
estimatedarrivaltime int
ident string
origin string
originCity string
originName string

DepartureStruct

Field Type
departures DepartureFlightStruct()
next_offset int

EnrouteFlightStruct

Field Type
actualdeparturetime int
aircrafttype string
destination string
destinationCity string
destinationName string
estimatedarrivaltime int
filed_departuretime int
ident string
origin string
originCity string
originName string

EnrouteRequest

Field Type
airport string
filter string
howMany int
offset int

EnrouteResults

Field Type
EnrouteResult EnrouteStruct

EnrouteStruct

Field Type
enroute EnrouteFlightStruct()
next_offset int

FleetArrivedRequest

Field Type
fleet string
howMany int
offset int

FleetArrivedResults

Field Type
FleetArrivedResult ArrivalStruct

FleetScheduledRequest

Field Type
fleet string
howMany int
offset int

FleetScheduledResults

Field Type
FleetScheduledResult ScheduledStruct

FlightAlertChannel

Field Type
channel_id int
channel_name string
e_arrival boolean
e_cancelled boolean
e_departure boolean
e_diverted boolean
e_filed boolean
mask_summary string
target_address string

FlightAlertEntry

Field Type
aircrafttype string
alert_changed int
alert_created int
alert_id int
channels FlightAlertChannel()
date_end int
date_start int
description string
destination string
enabled boolean
ident string
origin string
type string
user_ident string

FlightAlertListing

Field Type
alerts FlightAlertEntry()
num_alerts int

FlightExStruct

Field Type
actualarrivaltime int
actualdeparturetime int
aircrafttype string
destination string
destinationCity string
destinationName string
diverted string
estimatedarrivaltime int
faFlightID string
filed_airspeed_kts int
filed_airspeed_mach string
filed_altitude int
filed_departuretime int
filed_ete string
filed_time int
ident string
origin string
originCity string
originName string
route string

FlightInfoExRequest

Field Type
howMany int
ident string
offset int

FlightInfoExResults

Field Type
FlightInfoExResult FlightInfoExStruct

FlightInfoExStruct

Field Type
flights FlightExStruct()
next_offset int

FlightInfoRequest

Field Type
howMany int
ident string

FlightInfoResults

Field Type
FlightInfoResult FlightInfoStruct

FlightInfoStruct

Field Type
flights FlightStruct()
next_offset int

FlightRouteStruct

Field Type
latitude float
longitude float
name string
type string

FlightStruct

Field Type
actualarrivaltime int
actualdeparturetime int
aircrafttype string
destination string
destinationCity string
destinationName string
diverted string
estimatedarrivaltime int
filed_airspeed_kts int
filed_airspeed_mach string
filed_altitude int
filed_departuretime int
filed_ete string
filed_time int
ident string
origin string
originCity string
originName string
route string

GetAlertsRequest

Field Type

GetAlertsResults

Field Type
GetAlertsResult FlightAlertListing

GetFlightIDRequest

Field Type
departureTime int
ident string

GetFlightIDResults

Field Type
GetFlightIDResult string

GetHistoricalTrackRequest

Field Type
faFlightID string

GetHistoricalTrackResults

Field Type
GetHistoricalTrackResult ArrayOfTrackStruct

GetLastTrackRequest

Field Type
ident string

GetLastTrackResults

Field Type
GetLastTrackResult ArrayOfTrackStruct

InboundFlightInfoRequest

Field Type
faFlightID string

InboundFlightInfoResults

Field Type
InboundFlightInfoResult FlightExStruct

InFlightAircraftStruct

Field Type
altitude int
altitudeChange string
altitudeStatus string
arrivalTime int
departureTime int
destination string
faFlightID string
firstPositionTime int
groundspeed int
heading int
highLatitude float
highLongitude float
ident string
latitude float
longitude float
lowLatitude float
lowLongitude float
origin string
prefix string
suffix string
timeout string
timestamp int
type string
updateType string
waypoints string

InFlightInfoRequest

Field Type
ident string

InFlightInfoResults

Field Type
InFlightInfoResult InFlightAircraftStruct

InFlightStruct

Field Type
aircraft InFlightAircraftStruct()
next_offset int

LatLongsToDistanceRequest

Field Type
lat1 float
lat2 float
lon1 float
lon2 float

LatLongsToDistanceResults

Field Type
LatLongsToDistanceResult int

LatLongsToHeadingRequest

Field Type
lat1 float
lat2 float
lon1 float
lon2 float

LatLongsToHeadingResults

Field Type
LatLongsToHeadingResult int

MapFlightExRequest

Field Type
airports_expand_view boolean
faFlightID string
latlon_box float()
layer_off string()
layer_on string()
mapHeight int
mapWidth int
show_airports boolean
show_data_blocks boolean

MapFlightExResults

Field Type
MapFlightExResult string

MapFlightRequest

Field Type
ident string
mapHeight int
mapWidth int

MapFlightResults

Field Type
MapFlightResult string

MetarExRequest

Field Type
airport string
howMany int
offset int
startTime int

MetarExResults

Field Type
MetarExResult ArrayOfMetarStruct

MetarRequest

Field Type
airport string

MetarResults

Field Type
MetarResult string

MetarStruct

Field Type
airport string
cloud_altitude int
cloud_friendly string
cloud_type string
conditions string
pressure float
raw_data string
temp_air int
temp_dewpoint int
temp_relhum int
time int
visibility float
wind_direction int
wind_friendly string
wind_speed int
wind_speed_gust int

NTafRequest

Field Type
airport string

NTafResults

Field Type
NTafResult TafStruct

RegisterAlertEndpointRequest

Field Type
address string
format_type string

RegisterAlertEndpointResults

Field Type
RegisterAlertEndpointResult int

RoutesBetweenAirportsExRequest

Field Type
destination string
howMany int
maxDepartureAge string
maxFileAge string
offset int
origin string

RoutesBetweenAirportsExResults

Field Type
RoutesBetweenAirportsExResult ArrayOfRoutesBetweenAirportsExStruct

RoutesBetweenAirportsExStruct

Field Type
count int
filedAltitude_max int
filedAltitude_min int
last_departuretime int
route string

RoutesBetweenAirportsRequest

Field Type
destination string
origin string

RoutesBetweenAirportsResults

Field Type
RoutesBetweenAirportsResult ArrayOfRoutesBetweenAirportsStruct

RoutesBetweenAirportsStruct

Field Type
count int
filedAltitude int
route string

ScheduledFlightStruct

Field Type
aircrafttype string
destination string
destinationCity string
destinationName string
estimatedarrivaltime int
filed_departuretime int
ident string
origin string
originCity string
originName string

ScheduledRequest

Field Type
airport string
filter string
howMany int
offset int

ScheduledResults

Field Type
ScheduledResult ScheduledStruct

ScheduledStruct

Field Type
next_offset int
scheduled ScheduledFlightStruct()

SearchBirdseyeInFlightRequest

Field Type
howMany int
offset int
query string

SearchBirdseyeInFlightResults

Field Type
SearchBirdseyeInFlightResult InFlightStruct

SearchBirdseyePositionsRequest

Field Type
howMany int
offset int
query string
uniqueFlights boolean

SearchBirdseyePositionsResults

Field Type
SearchBirdseyePositionsResult ArrayOfTrackExStruct

SearchCountRequest

Field Type
query string

SearchCountResults

Field Type
SearchCountResult int

SearchRequest

Field Type
howMany int
offset int
query string

SearchResults

Field Type
SearchResult InFlightStruct

SetAlertRequest

Field Type
aircrafttype string
alert_id int
channels string
date_end int
date_start int
destination string
enabled boolean
ident string
max_weekly int
origin string

SetAlertResults

Field Type
SetAlertResult int

SetMaximumResultSizeRequest

Field Type
max_size int

SetMaximumResultSizeResults

Field Type
SetMaximumResultSizeResult int

TafRequest

Field Type
airport string

TafResults

Field Type
TafResult string

TafStruct

Field Type
airport string
forecast string()
timeString string

TailOwnerRequest

Field Type
ident string

TailOwnerResults

Field Type
TailOwnerResult TailOwnerStruct

TailOwnerStruct

Field Type
location string
location2 string
owner string
website string

TrackExStruct

Field Type
altitude int
altitudeChange string
altitudeStatus string
faFlightID string
groundspeed int
latitude float
longitude float
timestamp int
updateType string

TrackStruct

Field Type
altitude int
altitudeChange string
altitudeStatus string
groundspeed int
latitude float
longitude float
timestamp int
updateType string

ZipcodeInfoRequest

Field Type
zipcode string

ZipcodeInfoResults

Field Type
ZipcodeInfoResult ZipcodeInfoStruct

ZipcodeInfoStruct

Field Type
city string
county string
latitude float
longitude float
state string

List of Operations | Operation Details | Simple Types | Custom Types

Simple Types


List of Operations | Operation Details | Simple Types | Custom Types