The following time range options are mutually exclusive;
only one may be used at the start of an initiation command.
live - Request live data from the present time
pitr <epoch> - Request data from a specified time, in POSIX
format, in the past until the current time, and continue with the live
range <start epoch> <end epoch> - Send data between two
specified times, in POSIX epoch format. FlightAware will disconnect the connection when last message has
The following authentication items must both be used.
password <argument> - Supply the
credentials for authentication. In most cases, this should actually be the FlightXML API Key and not the
password of the account.
username <argument> - Supply the credentials for
authentication. This should be the username of the FlightAware account that has been granted access.
airport_filter "<airport pattern
Send flight information only for flights originating from or destined for airports matching the space
separated list of glob patterns provided. For example: airport_filter "CYUL" or
airport_filter "K??? P??? TJSJ".
compression <mode> - Requests that the server response should use data
reduce network bandwidth. The initiation command sent to the server must not be compressed. The mode
argument indicates the compression algorithm and must be "gzip", "compress", or "deflate". For example:
events "<event code
Specifies a list of which downlink messages should be sent. The available event codes include:
flightplan, departure, arrival, cancellation, position, offblock, onblock, extendedFlightInfo,
ground_position, vehicle_position, location_entry, location_exit, near_surface_position, fmswx, surface_onblock, surface_offblock, power_on.
This argument may be a list of space separated terms wrapped in double
quotes. When requesting surface movement (ground_position, vehicle_position,
location_entry, location_exit, or near_surface_position) messages, you will be
prevented from simultaneously requesting any non-surface messages in the same initiation command.
the weather messages (fmswx) may not be requested simultaneously with any non-weather messages in the
initiation command. For example: events "flightplan departure arrival position"
events "ground_position vehicle_position".
filter "<airline code
list>" - Send
flight information only related to the listed airlines. The list is a series of space separated ICAO
airline codes wrapped in double quotes. For example: filter "FIN" or filter
"FIN BAW AAL".
idents "<ident reg list>" - Send flight
information only related to the listed idents or aircraft registration/tails. The list is a series
of space separated idents or registrations wrapped in double quotes, optionally using wildcard
patterns. For example: idents "N1234 N2345 N456 CXYZA" or idents "N1*UA
N2*UA UAL12 UAL34".
keepalive <interval> - Requests that
the server should periodically send a "keepalive" message at the specified interval, measured in
whole integer seconds (must be 15 seconds or greater). The keepalive messages contain the current
timestamp on the server and the pitr timestamp within the data stream. This can be especially useful
for feeds that are very low data volume due to heavy filtering, where it may be difficult to
distinguish between a failed network connection and a period of time with few aircraft events. For
example: keepalive 60.
"<lowLat> <lowLon> <hiLat> <hiLon>" - Specifies that only positions within
the specified rectangle should be sent and any others will be ignored, unless the flight has already
been matched by other criteria. Once a flight has been matched by a latlong rectangle, it becomes
remembered and all subsequent messages until landing for that flight id will continue to be sent
even if the flight no longer matches a specified rectangle. For example:
latlong "29 -95 30 -94". This command may be repeated multiple times in a single
initiation command, allowing positions within any of the specified rectangles to be
"lat,lon lat,lon lat,lon lat,lon" - A space separated list of lat,lon pairs defining a polygon in either
clockwise or counter-clockwise direction. Specifies that only positions within the specified polygon should
be sent and any others will be ignored, unless the flight has already been matched by other criteria. Once
a flight has been matched by a polygon, all subsequent messages for that flight id will be emitted even if
the flight passes outside the specified polygon. For example: polygon "33.13,-102.34
33.13,-102.64 32.13,-102.64 32.13,-102.34 33.13,-102.34". This command may be repeated multiple times
in a single initiation command, allowing positions within any of the specified polygons to be matched.
For any polygon crossing the international date line, if that polygon will cross the date line more than
once it should be split into separate polygons, each crossing the international date line only once.
Polar polygons are also supported, but only a single pole should be covered by the polygon.
optype_filter <mode> - Send only messages relating to flight
idents based on the operator type. Supported modes are "ga", "airline", or "cargo". For example:
<interval> - Requests that the server should rate limit the connection by discarding
position messages if the last position from the same aircraft was less than the specified interval
(specified in whole seconds). Data availability and/or your account's service contract may limit the
lowest effective interval that may be specified. Default value is determined by your service
contract. For example: ratelimit_secs_between
strict_unblocking <boolean> - When the argument is 1,
then the server will ONLY send messages for aircraft that have been authorized to your FlightAware
Global account, avoiding the need to explicitly name them using the "idents" command. Messages for
aircraft that have not been added to your Global account, even if they are public and not blocked,
will not be sent. When the argument is 0, then all aircraft are visible to your account, including
public and non-blocked aircraft, will be sent. Default value is 0. For example: strict_unblocking 1.
number> - Protocol version the client expects. The latest version is assumed if this is not