Getting started

The SafeSky API is available through standard REST API, allowing seamless integration into your applications. To begin using the API:

Get an API key:
Visit SafeSky and subscribe to the desired plan.

Make API Calls:
Use the endpoints below with appropriate parameters in your requests. All responses are returned in JSON format.

Authentication:
SafeSky API automatically handles authentication when you make requests using your API key.

Endpoints Overview

1. Get Nearby Aircraft

Endpoint: GET /uav
Description:
Retrieve a list of airborne aircraft within a specific radius and altitude range from the given latitude and longitude. By default, the search radius is 10,000 meters, with a maximum of 20,000 meters.

Query Parameters:

Parameter	Type	Required	Description	Default
`latitude`	`double`	Yes	Latitude in decimal degrees (4 decimal precision).	N/A
`longitude`	`double`	Yes	Longitude in decimal degrees (4 decimal precision).	N/A
`altitude_min`	`int`	No	Filter all aircraft below the given altitude in meters. Zero means 'unused'.	0
`altitude_max`	`int`	No	Filter all aircraft above the given altitude in meters. Zero means 'unused'.	0
`radius`	`int`	No	Radius in meters from the reference point (maximum: 20,000 meters).	10,000

Response:

200 OK: Returns a list of nearby aircraft.

400 BAD REQUEST: Invalid parameters or failed authentication.

Example Request:

GET /uav?latitude=48.8588&longitude=2.2943&altitude_min=1000&altitude_max=3000&radius=15000

Example Response:

[
  {
    "id": "ABC123",
    "latitude": 48.859,
    "longitude": 2.293,
    "altitude": 1500,
    "status": "AIRBORNE"
  },
  {
    "id": "DEF456",
    "latitude": 48.860,
    "longitude": 2.295,
    "altitude": 2000,
    "status": "AIRBORNE"
  }
]

2. Publish UAV and Get Nearby Aircraft

Endpoint: POST /uav
Description:
Publish the UAV’s position, altitude, and flight status to the SafeSky platform while retrieving nearby traffic data within the specified radius. By default, the search radius is 10,000 meters, with a maximum of 20,000 meters.

Request Body:

Field	Type	Required	Description
`id`	`string`	Yes	Unique identifier for the UAV.
`latitude`	`double`	Yes	Latitude in decimal degrees (4 decimal precision).
`longitude`	`double`	Yes	Longitude in decimal degrees (4 decimal precision).
`altitude`	`int`	Yes	Altitude of the UAV in meters.
`groundSpeed`	`int`	Yes	Ground speed of the UAV in meters per second.
`course`	`int`	Yes	Direction of travel in degrees clockwise relative to true north.
`status`	`string`	Yes	Current status of the UAV (`INACTIVE`, `AIRBORNE`, `GROUNDED`).

Query Parameters:

Parameter	Type	Required	Description	Default
`altitude_min`	`int`	No	Filter all aircraft below the given altitude in meters. Zero means 'unused'.	0
`altitude_max`	`int`	No	Filter all aircraft above the given altitude in meters. Zero means 'unused'.	0
`radius`	`int`	No	Radius in meters from the reference point (maximum: 20,000 meters).	10,000

Response:

201 CREATED: UAV published successfully; returns a list of nearby aircraft.

400 BAD REQUEST: Invalid parameters or failed authentication.

Example Request:

POST /uav?altitude_min=1000&altitude_max=3000&radius=15000
Content-Type: application/json

{
  "id": "UAV123",
  "latitude": 48.8588,
  "longitude": 2.2943,
  "altitude": 1200,
  "groundSpeed": 30,
  "course": 180,
  "status": "AIRBORNE"
}

Example Response:

[
  {
    "id": "XYZ789",
    "latitude": 48.859,
    "longitude": 2.293,
    "altitude": 1500,
    "status": "AIRBORNE"
  }
]

Support

For assistance or further inquiries, please contact us at support@safesky.app or visit our website.

Disclaimer

SafeSky is a non-certified eConspicuity platform that collects and shares information provided by a voluntary and unstructured community of pilots and ground stations. Therefore, no data accuracy, comprehensiveness, nor permanent transmission can be guaranteed while using the API.

The main purpose of the software is to remind and support everybody’s personal duty to ‘See, Be Seen and Avoid’ when flying, i.e., to look out at all times.

Hence, SafeSky can in no way be held liable for any event happening during the flight.

While SafeSky provides significantly more flight traffic information than a single system or no system at all, it will not show everything. Visibility can be affected by factors like pilots not using a detection device, limited ground station coverage, poor internet, or poor GPS quality.

Before using this API, you must have read and agreed to the Terms And Conditions.