Getting Started with AirMap

Welcome

AirMap delivers world-class airspace services for drones, providing airspace intelligence that powers the next generation of flight, today. Whether you use our APIs, SDKs, or other tools, we'll help you take flight safely and efficiently!

Where to Start?

Before you can interact with the AirMap APIs, you'll need to sign up for a free Developer Account and generate an API key.

You'll find guides and tutorials for the APIs on your left, or check out our SDKs for Web, iOS, or Android. For all the detailed parameters and responses, see the API Reference.

AirMap APIs Overview

AirMap provides multiple APIs, and they are intended to be used together to take full advantage of the AirMap Platform. The APIs are loosely grouped into three categories that span the entire flight lifecycle: Discover, Plan, and Fly. The recommended sequence of APIs is illustrated below, along with details about each phase:

Best Practice

The diagram below is a best practice for interacting with the AirMap APIs. Though not all of the steps are required, you will get the most out of AirMap by using the APIs in this order.

Contextual Airspace Preview

Contextual Airspace (Rules API, Advisory API, and Flight Plan API) is currently in developer PREVIEW for testing and is subject to change. Please Contact Us for more information.

Discover

1. Identify the Rulesets

Discovery begins with identifying which rulesets are available in the flight area. Each ruleset is comprised of the rules that it contains, the airspace type that it affects, and which questions about the flight need to be answered to ensure compliance (flight features).

Learn more: Contextual Airspace

2. Check the Airspace

Once the desired rulesets your pilot will operate under are identified, the airspace is checked using these rulesets. By using the Airspace Advisory API, you can find all relevant advisories and determine whether it is safe and permissible to fly.

Learn more: Airspace Advisory

3. Check the Weather

Additionally, you can find information on current and future weather conditions at the planned flight location before taking flight.

Learn more: Weather

Plan

4. Create a Flight Plan

Planing begins with creating a flight plan detailing the desired flight, including location, altitude, selected rulesets, and many other details. This is a conceptual plan that will be evaluated against the specified rulesets and features of the flight during the briefing step.

Learn more: Flight Planning

5. Get Flight Briefing

Once a flight plan is submitted, a flight briefing is generated which summarizes what rules the flight may or may not comply with. After reviewing this initial briefing, the flight plan can be updated as often as desired, and reviewed again in a briefing, to ensure compliance.

Learn more: Flight Briefing

Fly

6. Submit Flight

After creating a flight plan and receiving a briefing, the pilot is now ready to begin flying. The first step to Fly is to create a flight by submitting the flight plan to the AirMap platform.

Learn more: Creating and Viewing Flights

7. Re-check Flight Briefing

Once a flight is active, you should re-check the flight briefing to ensure compliance with relevant rulesets based on provided flight features and also be aware of any new airspace advisories that arise during the flight.

Learn more: Flight Briefing

8. Take Off and Send Telemetry

Once the flight has achieved liftoff, you should start sending telemetry for the flight to the AirMap platform. The telemetry stream enables realtime communication with the flight -- providing information about its position and health to the AirMap platform.

Learn more: Sending Telemetry

9. Receive Traffic Alerts

Additionally, you can receive traffic alerts relating to the flight. This allows you to monitor manned and unmanned traffic around the flight's location for increased safety.

Learn more: Traffic Alerts

10. End Flight

Finally, after landing and completing your flight, your should finish the flight lifecycle by notifying the AirMap platform that the flight has ended.

Learn more: Ending a Flight


What's Next

Get a Developer Account to generate API keys

Getting a Developer Account

Getting Started with AirMap