Firehose Documentation Center
Messages
Messages have two categories of data fields, "Mandatory" and "Optional":
- Mandatory fields must be included in every message.
- Optional fields are not provided by some sources, but provide important additional information to improve the quality of flight tracking.
Messages with the same feed type can be requested together in the "events" command.
Mandatory Fields
Optional Fields
Mandatory Fields
Optional Fields
Departure indicates a flight has departed off the runway (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Mandatory Fields
Extended_predictions includes greater depth of detail and context for Foresight predictions (which are included in the flifo message), most notably prediction quantiles. Requires Foresight Predictions to be enabled on user account. (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Flifo messages are used for all Flight Information (flifo) status updates for a flight, from pre-departure through arrival with scheduled, estimated, predicted, and actual updates. Flifo messages should be consumed along with 'departure', 'arrival', and 'cancellation' messages for complete monitoring of a flight.
All 'predicted' flifo values are generated by FlightAware's Foresight Machine Learning models, providing industry leading accuracy and unprecedented insight into operational efficiency. User account must also have 'FlightAware Foresight' enabled to receive the predicted values. (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Flightplan an obsolete message type, available only to legacy Firehose customers under contract from 2020 or earlier. All Flightplan updates (new or modified flightplans) are now included in the `flifo` message. (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Mandatory Fields
Optional Fields
Mandatory Fields
Optional Fields
Ground_position_unmatched A surface movement position for which the hexid or ident of the vehicle is unknown, and therefore not categorized as a regular ground_position (Schema)
Feed Type: Surface
Mandatory Fields
Optional Fields
Hold_entry This message type is emitted when we detect a flight has entered a holding pattern. (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Hold_exit This message type is emitted when we detect a flight has exited a holding pattern. (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Keepalive periodic heartbeat message generated at a specific interval (Schema)
Feed Type: Any
Mandatory Fields
Location_entry a surface movement position report upon entering a pre-defined polygon (Schema)
Feed Type: Surface
Mandatory Fields
Optional Fields
Location_exit a surface movement position report upon exiting a pre-defined polygon (Schema)
Feed Type: Surface
Mandatory Fields
Optional Fields
Near_surface_position a position report for aircraft operating within 5000ft agl and 5 mile radius of a supported arrival/departure airport (Schema)
Feed Type: Surface
Mandatory Fields
Optional Fields
Surface_Offblock indicates a flight has departed the gate (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Surface_Onblock indicates a flight has arrived at the gate (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Power_on indicates the detection of the first message from an aircraft, typically corresponding with initial powering of the avionics on the ground at the origin airport (Schema)
Feed Type: Airborne
Mandatory Fields
Optional Fields
Mandatory Fields
Optional Fields
Vehicle_position a surface movement position report from a ground vehicle (non-aircraft) (Schema)
Feed Type: Surface