Skip to main content

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.

FieldTypeRequiredDescription
idstringYesThe unique identifier of the UAV.
latitudedoubleYesLatitude in decimal degrees.
longitudedoubleYesLongitude in decimal degrees.
altitudeintYesHeight of the UAV 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_signstringNoUAV call-sign.
ground_speedintNoCurrent ground speed of the UAV, specified in meters per second.
courseintNoDirection of travel, specified in degrees counting clockwise relative to the true north.
statusstringNoThe current status of the UAV. Allowable values: INACTIVE, AIRBORNE, GROUNDED.
last_updatelongYesThe 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. A positive value indicates climbing, a negative value indicates descent.
icao24stringUnique 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.

FieldTypeRequiredDescription
idstringYesThe unique identifier of the beacon.
latitudedoubleYesLatitude in decimal degrees.
longitudedoubleYesLongitude in decimal degrees.
altitudeintYesHeight 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_speedintYesCurrent ground speed of the beacon, specified in meters per second.
courseintYesDirection of travel, specified in degrees counting clockwise relative to the true north.
statusstringNoThe current status of the beacon. Allowable values: INACTIVE, AIRBORNE, GROUNDED.
last_updatelongYesThe 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. A positive value indicates climbing, a negative value indicates descent.
beacon_typestringNoThe type of the beacon. Allowable values: UNKNOWN,ADVISORY, GLIDER, TOW_PLANE, HELICOPTER_ROTORCRAFT, PARACHUTE, DROP_PLANE, HANG_GLIDER, PARA_GLIDER, POWERED_AIRCRAFT, JET_AIRCRAFT, UFO, BALLOON, AIRSHIP, UAV, STATIC_OBJECT.
operation_areaGeoJsonNoWhen beacon_type is an ADVISORY, this GeoJson represent the polygon for the area of operation
remarksstringNoFree text comment when applicable