Skip to main content

Overview

Introduction

The SafeSky UAV API offers a comprehensive solution for drone operators and manufacturers to enhance situational awareness by managing two distinct types of drone traffic data:

  1. Live UAV Operations: "/v1/uav"

This API allows to publish real-time telemetry data of drones, including position, altitude, and velocity. By publishing live traffic, drones become visible within the SafeSky network, promoting safer integration with other airspace users.

The typical approach is to PUSH one or multiple live traffic data in a batch. In response, the system returns traffic in the vicinity of all UAVs within a default radius. This method is the most efficient way to avoid polling unnecessary traffic, ensuring optimal performance.

  1. Advisory UAV Operations: "/v1/advisory"

For data sources that don't provide live telemetry, the API allows the submission of advisory messages to define active drone operations using polygons or circles, along with a maximum altitude. This ensures that ongoing drone activities are visible within the SafeSky network, even when real-time telemetry data isn't available.

API Gateway & Endpoint

All API traffic is routed through a single gateway endpoint:

  • API Gateway URL: https://uav-api.safesky.app

Your API key determines the environment your requests are routed to. Each API key is associated with either a sandbox or production environment. The gateway automatically routes your request to the correct backend based on the environment configured for your API key.

Important: You do not need to change the endpoint URL between sandbox and production. Simply use the appropriate API key, and the gateway handles the routing automatically.

Sandbox

The sandbox environment is designed for development and integration testing. It allows you to test API calls and functionalities without affecting the live production data.

  • Key Features:

    • Simplified environment with limited traffic data.
    • Ideal for debugging, testing payloads, and verifying integration.
    • No quota enforcement or usage metering, sandbox API keys are exempt from billing.
    • Data quality is marked as degraded (test data).

  • API Key: You will receive a sandbox-specific API key upon registration. This key is configured with environment: sandbox and will automatically route your requests to the sandbox backend.

Sandbox traffic can be monitored here: https://sandbox-live.safesky.app/

Production

The production environment is the live SafeSky API, providing real-time and unfiltered access to traffic data. This environment is intended for operational use and live deployments.

  • Key Features:

    • Access to all real-time traffic data, including manned and unmanned aircraft.
    • Supports high-availability operations with optimized performance for production workloads.
    • Full quota enforcement and usage metering apply.

  • Usage Guidelines:

    • Ensure robust error handling and retry mechanisms in your application.
    • Follow the recommended request limits to avoid throttling.

  • API Key: A production-specific API key is required. This key is configured with environment: production and will automatically route your requests to the production backend. This key must not be shared and should be stored securely following best practices (e.g., environment variables or secret management systems).

Live traffic can be monitored here: https://live.safesky.app/

Check for API health

Endpoint: GET /
Description:
Provides health checks against the API. Returns the string 'UP' if network services are up and running.

Support

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

Back to top