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. This is your UAV telemetry you are submiting to SafeSky.
| 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. This is what is returned by SafeSky
| Field | Type | Required | Description |
|---|---|---|---|
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 |
Example:
[
{
"latitude": 58.88228,
"longitude": 5.51642,
"vertical_rate": 0,
"accuracy": 0,
"call_sign": "NOR303",
"transponder_type": "ADS-B",
"last_update": 1764171642,
"altitude": 283,
"altitude_accuracy": 0,
"course": 63,
"ground_speed": 71,
"turn_rate": 0.06,
"status": "AIRBORNE",
"beacon_type": "HELICOPTER",
"id": "478757"
},
{
"latitude": 50.72218,
"longitude": 4.615,
"vertical_rate": 0,
"accuracy": 0,
"call_sign": "LGL4EW",
"transponder_type": "ADS-B",
"last_update": 1764171642,
"altitude": 6362,
"altitude_accuracy": 0,
"course": 108,
"ground_speed": 168,
"turn_rate": -0.06,
"status": "AIRBORNE",
"beacon_type": "MOTORPLANE",
"id": "4D00C9"
},
{
"latitude": 50.70083,
"longitude": 4.02502,
"vertical_rate": 10,
"accuracy": 0,
"call_sign": "",
"transponder_type": "ADS-BI",
"last_update": 1764171647,
"altitude": 256,
"altitude_accuracy": 7,
"course": 43,
"ground_speed": 16,
"status": "AIRBORNE",
"beacon_type": "PARA_MOTOR",
"id": "kmx87o80"
},
{
"latitude": 50.7756,
"longitude": 4.65264,
"vertical_rate": 0,
"accuracy": 0,
"call_sign": "CES261",
"transponder_type": "ADS-B",
"last_update": 1764171642,
"altitude": 11399,
"altitude_accuracy": 0,
"course": 218,
"ground_speed": 278,
"turn_rate": 0.0,
"status": "AIRBORNE",
"beacon_type": "JET",
"id": "781EB7"
},
{
"latitude": 50.70716,
"longitude": 4.36613,
"accuracy": 3645,
"call_sign": "ADVISORY TEST WITH POLYGON",
"transponder_type": "ADVISORY",
"last_update": 1764171645,
"altitude": 111,
"course": 0,
"ground_speed": 0,
"remarks": "Inspection powerlines",
"operation_area": "{\"type\":\"Polygon\",\"coordinates\":[[[4.3948,50.6831],[4.3952,50.6832],[4.3958,50.6835],[4.3963,50.6838],[4.4072,50.6902],[4.4075,50.6903],[4.4081,50.6905],[4.4085,50.6907],[4.4092,50.691],[4.4096,50.6912],[4.4103,50.6915],[4.4106,50.6917],[4.411,50.692],[4.4113,50.6922],[4.4116,50.6925],[4.4118,50.6927],[4.412,50.693],[4.4121,50.6932],[4.412,50.6935],[4.4118,50.6937],[4.4115,50.694],[4.375,50.715],[4.3748,50.7153],[4.3746,50.7155],[4.3742,50.7158],[4.374,50.716],[4.3735,50.7162],[4.3733,50.7163],[4.3435,50.728],[4.3432,50.7281],[4.3426,50.7283],[4.3423,50.7284],[4.3416,50.7286],[4.3412,50.7287],[4.3405,50.7288],[4.3402,50.7289],[4.3395,50.729],[4.3392,50.729],[4.3385,50.7291],[4.3382,50.7291],[4.3376,50.729],[4.3373,50.7289],[4.3367,50.7287],[4.3365,50.7286],[4.336,50.7284],[4.3358,50.7282],[4.32,50.721],[4.3195,50.7208],[4.3193,50.7207],[4.3189,50.7205],[4.3187,50.7203],[4.3185,50.72],[4.3184,50.7198],[4.3182,50.7195],[4.3181,50.7193],[4.3948,50.6831]]]}",
"status": "AIRBORNE",
"beacon_type": "UAV",
"id": "my_advisory_id1_l2TZ"
},
{
"latitude": 58.88869,
"longitude": 5.63745,
"vertical_rate": 0,
"accuracy": 0,
"call_sign": "SAS92R",
"transponder_type": "ADS-B",
"last_update": 1764171642,
"altitude": 9,
"altitude_accuracy": 0,
"course": 179,
"ground_speed": 44,
"turn_rate": 0.0,
"status": "AIRBORNE",
"beacon_type": "JET",
"id": "4ACA73"
},
{
"latitude": 50.89663,
"longitude": 4.18991,
"vertical_rate": -4,
"accuracy": 0,
"call_sign": "JAF11K",
"transponder_type": "ADS-B",
"last_update": 1764171642,
"altitude": 3101,
"altitude_accuracy": 0,
"course": 51,
"ground_speed": 160,
"turn_rate": 0.06,
"status": "AIRBORNE",
"beacon_type": "JET",
"id": "44B438"
},
{
"latitude": 50.69378,
"longitude": 4.39201,
"vertical_rate": 0,
"call_sign": "TRAFFIC UAV",
"transponder_type": "ADS-BI",
"last_update": 1764171644,
"altitude": 150,
"course": 180,
"ground_speed": 15,
"status": "AIRBORNE",
"beacon_type": "UAV",
"id": "my_uav_002_l2TZ"
},
{
"latitude": 50.7,
"longitude": 4.4,
"accuracy": 500,
"call_sign": "ADVISORY TEST WITH A POINT",
"transponder_type": "ADVISORY",
"last_update": 1764171645,
"altitude": 150,
"course": 0,
"ground_speed": 0,
"remarks": "Inspection rails",
"status": "AIRBORNE",
"beacon_type": "UAV",
"id": "my_advisory_id2_l2TZ"
},
{
"latitude": 50.69378,
"longitude": 4.39201,
"vertical_rate": 5,
"call_sign": "TEST UAV",
"transponder_type": "ADS-BI",
"last_update": 1764171644,
"altitude": 110,
"course": 250,
"ground_speed": 10,
"status": "AIRBORNE",
"beacon_type": "UAV",
"id": "my_uav_001_l2TZ"
}
]