Output
Messages output by the endpoint are encoded in JSON format. The message(s) output when calling the endpoint will have the form of a Flight Object as detailed below.
Flight Object#
The Flight Object will contain all available fields which describe a flight observed by ADS-B and each is identified by a unique flight_id. All fields included in the Flight object are described below.
Content#
Flight object information#
The fields in this table are taken directly from ADS-B messages:
| Field | Type | Description | Example |
|---|---|---|---|
icao_address | string | Hexadecimal representation of ICAO 24-bit address | "02013F" |
callsign | string | Call sign | "RAM200" |
latitude | float | Latitude in degrees, between -90 and 90 (both inclusive) | -26.80491819 |
longitude | float | Longitude in degrees, between -180 (exclusive) and 180 (inclusive) | 28.64151588 |
altitude_baro | integer | Barometric altitude in feet | 38000 |
on_ground | boolean | Specifies if the aircraft is on the ground. true if the aircraft is on the ground, false if the aircraft is airborne | false |
speed | float | Aircraft speed in knots | 477 |
heading | float | Aircraft heading in degrees (0 is North) | 273 |
vertical_rate | integer | Vertical rate of ascent/descent, in ft/min | 100 |
squawk | string | Mode-A squawk code | "6617" |
Spire flight object metadata#
These fields are merged into each record to provide additional information regarding the ADS-B message:
| Field | Type | Description | Example |
|---|---|---|---|
flight_id | ID | Spire internal unique flight ID. Random UUIDv4 sequence | "9bfe2152-471a-402d-9c07-07b2da25649c" |
timestamp | datetime | Timestamp for which all data fields are valid | "2023-01-04T07:55:25Z" |
Aircraft Information#
The following fields are enhanced data and may be present in the record depending on availability:
| Field | Type | Description | Example |
|---|---|---|---|
tail_number | string | Aircraft Registration | "G-EUUL" |
aircraft_type_icao | string | Aircraft type (ICAO code) | "A320" |
aircraft_type_name | string | Full aircraft type name | "Airbus A320 (sharklets)" |
aircraft_role | string | Aircraft role | PAX,CAR |
airline_icao | string | IATA code of the airline | "BAW" |
airline_iata | string | IATA code of the airline | "BA" |
airline_name | string | Airline commerical name | "British Airways" |
Flight Information#
The following fields are enhanced data and may be present in the record depending on availability:
| Field | Type | Description | Example |
|---|---|---|---|
flight_number | string | Flight number (IATA format) | "AK512" |
departure_airport_icao | string | Departure airport ICAO code | "WMKK" |
departure_airport_iata | string | Departure airport IATA code | "KUL" |
departure_scheduled_time | datetime | Scheduled departure time, format is in ISO 8601 | "2023-03-20T04:05:00Z" |
departure_utc_offset | string | Departure airport timezone offset from UTC | "+0800" |
arrival_airport_icao | string | Arrival airport ICAO code | "VVNB" |
arrival_airport_iata | string | Arrival airport IATA code | 'HAN" |
arrival_scheduled_time | datetime | Scheduled arrival time, format is in ISO 8601 | "2023-03-20T07:20:00Z" |
arrival_utc_offset | string | Arrival airport timezone offset from UTC | "+0700" |
Flight Analytics#
The following fields are enhanced data and may be present in the record depending on availability:
| Field | Type | Description | Example |
|---|---|---|---|
flight_state | string | Flight state | "ARCHIVED" |
takeoff_time | timestamp | Timestamp of actual detected take off | "2023-03-20T04:37:25Z" |
landing_time | timestamp | Timestamp of actual detected landing | "2023-03-20T07:28:19Z" |
flight_start | timestamp | Timestamp reflecting point when ADS-B tracking begins | "2023-03-20T04:15:25Z" |
flight_end | timestamp | Timestamp reflecting point when ADS-B tracking ends | "2023-03-20T07:35:19Z" |
off_block_time | timestamp | Timestamp of actual detected OFF block event | "2023-01-04T11:44:15Z" |
on_block_time | timestamp | Timestamp of actual detected ON block event | "2023-01-04T11:44:15Z" |
Sample#
Here is an example of a typical Flights History Object broadcast by our API: