Skip to main content

Model Definition

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 submitting 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"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 No Unique ICAO 24-bit address of the transponder in hex string representation.

2. Beacon Model

The Beacon model defines the structure of an aircraft beacon,beacon as provided by SafeSky, to represent and describe all detected aircraft in the vicinity.SafeSky. This is the traffic as 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_accuracyintNoAccuracy level of the altitude coordinate in meters.
accuracyintNoAccuracy level of the latitude and longitude coordinates in meters.
call_signstringNoBeacon 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:beacon: INACTIVE, AIRBORNE, GROUNDED.
last_update long Yes The time of the event in seconds since epoch at UTC-0.
turn_ratefloatNoTurn rate in degrees per second.
vertical_rateintNoVertical rate in meters per second.
beacon_type string No Allowable values: UNKNOWN, GLIDER, PARA_GLIDER, HELICOPTER, UAV, JET, etc.
operation_area GeoJson No When beacon_type is an ADVISORY, this GeoJson represents the polygon for the area of operation.
remarks string No Free text comment when applicable.

Example Payload:

[
    {
        "latitude": 50.70716,
        "longitude": 4.36613,
        "accuracy": 3645,
        "call_sign": "ADVISORY TEST",
        "transponder_type": "ADVISORY",
        "last_update": 1764171645,
        "altitude": 111,
        "remarks": "Inspection powerlines",
        "status": "AIRBORNE",
        "beacon_type": "UAV",
        "id": "my_advisory_id1"
    }
]
Back to top