Model Definition
1. UAV Model
The UAV model defines the structure and attributes of an Unmanned Aerial Vehicle (UAV) as submitted to the /v1/uav endpoint.
| Field | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The unique identifier of the UAV. |
latitude |
double |
Yes | Latitude in decimal degrees. |
longitude |
double |
Yes | Longitude in decimal degrees. |
altitude |
int |
Yes | Altitude of the UAV in meters, based on GPS altitude AMSL. Value "-9999" means unknown |
altitude_accuracy |
int |
No | Accuracy level of the altitude coordinate in meters. |
accuracy |
int |
No | Accuracy level of the latitude and longitude coordinates in meters. |
call_sign |
string |
No | UAV call-sign. |
ground_speed |
int |
No | Current ground speed of the UAV, specified in meters per second. |
course |
int |
No | Direction of travel, specified in degrees counting clockwise relative to the true north. |
status |
string |
No | The current status of the UAV. Allowable values: INACTIVE, AIRBORNE, GROUNDED. |
last_update |
long |
Yes | The time of the event in seconds since epoch at UTC-0. |
turn_rate |
float |
No | Turn rate in degrees per second. |
vertical_rate |
int |
No | Vertical rate in meters per second. A positive value indicates climbing, a negative value indicates descent. |
icao24 |
string |
Unique ICAO 24-bit address of the transponder in hex string representation. See FAQs for more details |
2. Beacon Model
The Beacon model defines the structure of an aircraft beacon, as provided by SafeSky, to represent and describe all detected aircraft in the vicinity.
id
string
Yes
The unique identifier of the beacon.
latitude
double
Yes
Latitude in decimal degrees.
longitude
double
Yes
Longitude in decimal degrees.
altitude
int
Yes
Altitude of the beacon in meters, based on GPS altitude AMSL.
altitude_accuracy
int
No
Accuracy level of the altitude coordinate in meters.
accuracy
int
No
Accuracy level of the latitude and longitude coordinates in meters.
call_sign
string
No
Beacon call-sign, available only if the pilot has a public profile.
ground_speed
int
Yes
Current ground speed of the beacon, specified in meters per second.
course
int
Yes
Direction of travel, specified in degrees counting clockwise relative to the true north.
status
string
No
The current status of the beacon. Allowable values: INACTIVE, AIRBORNE, GROUNDED.
last_update
long
Yes
The time of the event in seconds since epoch at UTC-0.
turn_rate
float
No
Turn rate in degrees per second.
vertical_rate
int
No
Vertical rate in meters per second. A positive value indicates climbing, a negative value indicates descent.
beacon_type
string
No
The type of the beacon. Allowable values: UNKNOWN, GLIDER, PARA_GLIDER, HAND_GLIDER, HELICOPTER, UAV, PARACHUTE, MOTORPLANE, JET, AIRSHIP, BALLOON, GYROCOPTER, FLEX_WING_TRIKES, PARA_MOTOR, THREE_AXES_LIGHT_PLANE, PAV, MILITARY, STATIC_OBJECT.
operation_area
GeoJson
No
When beacon_type is an ADVISORY, this GeoJson represent the polygon for the area of operation
remarks
string
No
Free text comment when applicable