Skip to main content

Output

Messages output by the endpoint are encoded in JSON format. The messages output when calling the endpoint will have the form of an Event Object as detailed below.

Event Object#

The Event Object will contain all available fields which describe a flight observed by ADS-B and each is identified by a unique flight_id. It is delivered in the following format: {"event": {...}}. All fields included in the Event object are described below.

Content#

Event object information#

The fields in this table are taken directly from ADS-B messages:

FieldTypeDescriptionExample
icao_addressstringHexadecimal representation of ICAO 24-bit address"406AE2"
callsignstringCall sign"BAW41HA"
latitudefloatLatitude in degrees, between -90 and 90 (both inclusive)52.331326
longitudefloatLongitude in degrees, between -180 (exclusive) and 180 (inclusive)4.716759
speedfloatAircraft speed in knots477
headingfloatAircraft heading in degrees (0 is North)310

Spire Event object metadata#

These fields are merged into each record to provide additional information regarding the ADS-B message:

FieldTypeDescriptionExample
flight_idIDSpire internal unique flight ID in UUID format."149f14c0-ec7e-4150-8b6f-cbecebaac8b5"
timestampdatetimeTimestamp for which all data fields are valid"2023-02-25T20:56:54.000Z"
creation_timedatetimeTimestamp at which the flight event was created"2023-02-25T20:57:02.000Z"
extrapolatedbooleanConfirmation of whether event is extrapolated"true", "false"

Aircraft Information#

The following fields are enhanced data and may be present in the record depending on availability:

FieldTypeDescriptionExample
tail_numberstringAircraft Registration"G-EUYV"

Flight Information#

The following fields are enhanced data and will be present in the record depending on availability:

FieldTypeDescriptionExample
flight_numberstringFlight number (IATA format)"BA441"

Flight Analytics#

The following fields are enhanced data and may be present in the record depending on availability:

FieldTypeDescriptionExample
event_typestringEvent type assigned at creation_time"NEW_FLIGHT", "TAKEOFF", "LANDING", "OFF_BLOCK", "ON_BLOCK"
statestringFlight state"ON_GROUND", "AIRBORNE", "LANDED", "POST-FLIGHT"

Sample#

Here is an example of a typical Event Object broadcast by our API:

{
"event":{
"creation_time":"2023-02-25T20:57:02.000Z",
"timestamp":"2023-02-25T20:56:54.000Z",
"event_type":"TAKE_OFF",
"icao_address":"406AE2",
"flight_id":"149f14c0-ec7e-4150-8b6f-cbecebaac8b5",
"flight_number":"BA441",
"callsign":"BAW41HA",
"tail_number":"G-EUYV",
"latitude":52.331326,
"longitude":4.716759,
"speed":10.0,
"heading":310.9743,
"extrapolated":false
}
}