Overview
The AirMap API gives you access to a wide range of airspace services to use in your app or device. The interface strives to be RESTful and easy to use.
Before you can use the AirMap API, you will need to create a free AirMap account and apply to become a developer. If approved, you will then be given an API key, which is required for most API calls and to use the SDK.
All of AirMap's REST API responses conform to the JSend Specification. This means that every response will have a status and a data field in the JSON response. The status field will give either a success or fail. In the case of a success, the data field will contain the requested data. In the case of a fail, the data will contain error messages.
For example, in the case of a bad request:
{
"status": "fail",
"data": {
"errors": [
{ "name": "title", "message": "cannot be this ridiculous" },
{ "name": "description", "message": "must be provided" }
]
}
}Here is an example of a successful request of a public profile:
{
"status": "success",
"data": {
"id": "auth0|abc123",
"username": "R2theD2"
}
}The AirMap API returns errors consistent with the standard HTTP status codes along with error objects that describe the error in detail. The following pattern generally applies:
2xx
The request was received, understood, and accepted by AirMap.
4xx
The request has an error. Check the error object for details about what is wrong.
5xx
Something went wrong on AirMap's side. Please open a support ticket or contact AirMap.
AirMap formats all dates according to the sub-formats of the ISO 8601 standard:
- yyyy-MM-dd'T'HH:mm:ss.SSSZ
- yyyy-MM-dd'T'HH:mm:ssZ
Airspace Layers
These are all the available airspace layers that can be used in the Map SDK. See the Available Airspace Layers for more info.
Note
These layers are only for use in the Map SDK. If you are using the Status or Airspace API, keep scrolling down to Airspace Types
airports_recreational
Public Airports (recreational rules)
airports_commercial
Public Airports (commercial rules)
airports_recreational_private
Private Airports (recreational rules)
airports_commerical_private
Private Airports (commercial rules)
class_b
Class B Airspace
class_c
Class C Airspace
class_d
Class D Airspace
class_e0
Class E to Ground
sua_prohibited
Prohibited Special Use Airspace
sua_restricted
Restricted Special Use Airspace
national_parks
National Parks
noaa
NOAA Marine Protection Areas
hospitals
Hospitals
heliports
Heliports
power_plants
Power Plants
schools
Schools
tfrs
Temporary Flight Restrictions
wildfires
Wildfires (realtime)
fires
City and County Fires (realtime)
emergencies
First Responder Activity (realtime)
Airspace Types
Airspace objects represent all the different advisories in which a UAS operator may be interested. The Airspace objects are returned in both the Status API and the Airspace API. For a detailed look at each type, please see below. A description and example JSON response is given for each type. The JSON response is what is returned from the Airspace API. The Status API is similar, except it will not return the GeoJSON geometry of each object.
Here is a summary of all the different types of airspace objects, and the identifier that you should use when filtering in the APIs:
Airports
airport
Controlled Airspace
controlled_airspace
Special Use Airspace
special_use_airspace
Temporary Flight Restrictions
tfr
Wildfires
wildfire
Parks
park
Power Plants
power_plant
Heliports
heliport
Prisons
prison
Schools
school
Hospitals
hospital
Fires
fire
Emergencies
emergency
Densely Inhabit Districts (Japan)
densely_populated_region
Park
Identifier: park
Types of parks included in this Airspace object:
• National Park
• City Park
• Marine Protected Area (NOAA)
{
"status": "success",
"data": {
"id": "3621d752-e870-4a5d-8756-781d82568f6f",
"name": "Yosemite",
"type": "park",
"country": "USA",
"state": "California",
"city": "",
"last_updated": "2016-07-20T20:56:47.000Z",
"properties": {},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-119.845562414,
37.8327833210298
],
[
-119.850205576,
37.8326633630297
],
[
-119.854848738,
37.8325444040298
],
[
-119.85481875,
37.8363413140297
],
[
-119.854788763,
37.8401382230297
],
[
-119.850159602,
37.8401631840298
],
[
-119.845530442,
37.8401881460298
],
[
-119.840885281,
37.8403051040297
],
[
-119.840872297,
37.8439740170297
],
[
"..."
]
]
]
}
}
}Power Plants
Identifier: power_plant
{
"status": "success",
"data": {
"id": "36b57fe5-5714-44d7-83b5-2cb34c88af8c",
"name": "Scattergood",
"type": "power_plant",
"country": "USA",
"state": "California",
"city": "Playa Dal Ray",
"last_updated": "2016-07-22T12:49:00.000Z",
"properties": {
"tech": "Natural Gas Steam Turbine",
"plant_code": 404
},
"geometry": {
"type": "Point",
"coordinates": [
-118.427648,
33.918151
]
}
}
}Heliports
Identifier: heliport
These heliports may not be active, and in some instances may be an empty field where helicopters can land in emergencies. Thus, there may be many objects returned, especially in cities. We include this object as an advisory to help alert UAS operators that they should be particularly alert to helicopter traffic in the area.
{
"status": "success",
"data": {
"id": "bab01b0f-49eb-4422-bd2c-642dd58b380d",
"name": "PALOMAR MEDICAL CENTER",
"type": "heliport",
"country": "USA",
"state": "California",
"city": "Escondido",
"last_updated": "2016-08-11T00:15:38.000Z",
"properties": {
"faa": "'6CA7",
"phone": "+17608024541",
"use": "private"
},
"geometry": {
"type": "Point",
"coordinates": [
-117.121944444444,
33.1223055555556
]
}
}
}Schools
Identifier: school
Types of schools included in this Airspace object:
• University
• High School
• Middle School
• Elementary School
• Other
{
"status": "success",
"data": {
"id": "186b4201-a64d-4eb1-8a18-456ff6e6d34b",
"name": "ST MONICA CATHOLIC HIGH SCHOOL",
"type": "school",
"country": "USA",
"state": "California",
"city": "Santa Monica",
"last_updated": "2016-07-20T17:46:08.000Z",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [
-118.497281,
34.024436
]
}
}
}Prison
Identifier: prison
{
"status": "success",
"data": {
"id": "a943d640-8afd-4ce9-b1dc-864c5325105b",
"name": "California State Prison - Corcoran",
"type": "prison",
"country": "USA",
"state": "California",
"city": "Corcoran",
"last_updated": "2016-07-20T17:46:08.000Z",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [
-119.552849,
36.060114
]
}
}
}Temporary Flight Restrictions
Identifier: tfr
A temporary flight restriction (TFR) is a regulatory action that temporarily restricts certain aircraft from operating within a defined area in order to protect persons or property in the air or on the ground. Common reasons for a TFR include sporting events and national security incidents.
{
"status": "success",
"data": {
"id": "3176b0d6-37c4-4f06-9fa2-5a54db3f0fa2",
"name": "Temporary flight restrictions for Special Security Reasons",
"type": "tfr",
"country": "USA",
"state": "California",
"city": "Anaheim",
"last_updated": "2016-08-23T23:17:29.000Z",
"properties": {
"url": "http://tfr.faa.gov/save_pages/detail_4_3635.html",
"type": "Security",
"notam_reason": "Temporary flight restrictions for Special Security Reasons:DISNEYLAND THEME PARK, ANAHEIM"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-117.921389,
33.851479
],
[
-117.910964,
33.850718
],
[
-117.900856,
33.848457
],
[
-117.891374,
33.844765
],
[
-117.882804,
33.839754
],
[
-117.875409,
33.833578
],
[
-117.869412,
33.826423
],
[
-117.864996,
33.818508
],
[
-117.862294,
33.810073
],
[
-117.861388,
33.801374
],
[
-117.862306,
33.792677
],
[
-117.865018,
33.784244
],
[
-117.869442,
33.776333
],
[
-117.875443,
33.769183
],
[
-117.882839,
33.763011
],
[
-117.891404,
33.758005
],
[
-117.900879,
33.754317
],
[
-117.910976,
33.752059
],
[
-117.921389,
33.751298
],
[
-117.931802,
33.752059
],
[
-117.941899,
33.754317
],
[
-117.951374,
33.758005
],
[
-117.959939,
33.763011
],
[
-117.967335,
33.769183
],
[
-117.973336,
33.776333
],
[
-117.97776,
33.784244
],
[
-117.980472,
33.792677
],
[
-117.981389,
33.801374
],
[
-117.980484,
33.810073
],
[
-117.977782,
33.818508
],
[
-117.973366,
33.826423
],
[
-117.967369,
33.833578
],
[
-117.959974,
33.839754
],
[
-117.951404,
33.844765
],
[
-117.941922,
33.848457
],
[
-117.931814,
33.850718
],
[
-117.921389,
33.851479
]
]
]
}
}
}Airport
Identifier: airport
{
"status": "success",
"data": {
"id": "bdbd3a36-1a36-405c-8733-2cab6d3aa271",
"name": "San Francisco Intl",
"type": "airport",
"country": "USA",
"state": "California",
"city": "San Francisco",
"last_updated": "2016-08-11T23:33:13.000Z",
"properties": {
"iata": "SFO",
"icao": "KSFO",
"paved": true,
"phone": "+16508215000",
"tower": true,
"runways": [
{
"name": "01L",
"length": 7650,
"bearing": 14
},
{
"name": "01R",
"length": 8650,
"bearing": 14
},
{
"name": "10L",
"length": 11870,
"bearing": 104
},
{
"name": "10R",
"length": 11381,
"bearing": 104
},
{
"name": "19L",
"length": 8650,
"bearing": 194
},
{
"name": "19R",
"length": 7650,
"bearing": 194
},
{
"name": "28L",
"length": 11381,
"bearing": 284
},
{
"name": "28R",
"length": 11870,
"bearing": 284
}
],
"elevation": 13,
"longest_runway": 11870,
"instrument_approach_procedure": true,
"use": "public"
},
"geometry": {
"type": "Point",
"coordinates": [
-122.375416666667,
37.6188055555556
]
},
"rules": [
{
"name": "Commercial Rules",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.270495071032,
37.6182035459562
],
[
-122.272669663847,
37.6019340955551
],
[
-122.278790041503,
37.5863144767897
],
[
-122.288618882919,
37.5719443404376
],
[
-122.301777091749,
37.5593750517554
],
[
-122.317758572282,
37.5490886345066
],
[
-122.335949742127,
37.5414793998077
],
[
-122.355653022862,
37.5368389427161
],
[
-122.376113419842,
37.5353450606707
],
[
-122.396547204286,
37.5370550010954
],
[
-122.416171645377,
37.5419032857199
],
[
-122.434234707722,
37.5497041916284
],
[
-122.450043630358,
37.5601587989399
],
[
-122.462991337376,
37.5728663476202
],
[
-122.472579697415,
37.5873394864869
],
[
-122.478438749262,
37.6030228512052
],
[
-122.480341142913,
37.6193142800962
],
[
-122.47821120794,
37.6355878717507
],
[
-122.472128250883,
37.6512180112555
],
[
-122.462323895897,
37.6656034461621
],
[
-122.449173511467,
37.6781904821636
],
[
-122.433182002054,
37.6884943936337
],
[
-122.414964476802,
37.696118206112
],
[
-122.395222526485,
37.7007681051901
],
[
-122.374717032867,
37.7022648559564
],
[
-122.354238590336,
37.7005507742444
],
[
-122.334576728553,
37.6956919688051
],
[
-122.31648917989,
37.6878757642694
],
[
-122.300672433108,
37.6774034096114
],
[
-122.287734755215,
37.6646783667437
],
[
-122.278172750676,
37.6501906501729
],
[
-122.272352368298,
37.6344978435407
],
[
-122.270495071032,
37.6182035459562
]
]
]
}
},
{
"name": "Recreational Rules",
"geometry": "{...}"
}
],
"related_geometry": {
"property_boundary": {
"id": "e67294df-e424-4f62-a44b-a265af73941b",
"geometry": "{...}"
}
}
}
}Controlled Airspace
Identifier: controlled_airspace
Controlled Airspace is airspace where air traffic control services are defined. Some countries require authorization prior to flight in controlled airspace. AirMap provides all controlled airspace under 500 ft
{
"status": "success",
"data": {
"id": "94089474-83ff-4f49-88aa-af419a33a54f",
"name": "LOS ANGELES CLASS B AREA A",
"type": "controlled_airspace",
"country": "USA",
"state": "",
"city": "",
"last_updated": "2016-07-20T17:46:08.000Z",
"properties": {},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-118.745277777778,
33.9972222222222
],
[
-118.5425,
34.0063888888889
],
[
-118.456388888889,
33.9616666666667
],
[
-118.369444444444,
33.9616666666667
],
[
-118.25,
34.0166666666667
],
[
-118.231111111111,
33.93
],
[
-118.434722222222,
33.9308333333333
],
[
-118.450277777778,
33.7594444444444
],
[
-118.541388888889,
33.7538888888889
],
[
-118.745277777778,
33.9972222222222
]
]
]
}
}
}Special Use Airspace
Identifier: special_use_airspace
Special Use Airspace includes airspace that is prohibited, restricted or otherwise designated as a dangerous area to operate an aircraft.
{
"status": "success",
"data": {
"id": "e06c06eb-5c9a-47e9-a8fa-db47170dc642",
"name": "R6404A (HILL AFB, UT)",
"type": "special_use_airspace",
"country": "USA",
"state": null,
"city": null,
"last_updated": "2016-07-29T21:23:28.000Z",
"properties": {
"type": "Restricted"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-112.759167,
41.191667
],
[
-112.650833,
41.116667
],
[
-112.650833,
41.016667
],
[
-112.8425,
40.916667
],
[
-114.000833,
40.916667
],
[
-114.0425,
40.925
],
[
-114.0425,
41.141667
],
[
-113.834167,
41.266667
],
[
-113.29636,
41.230422
],
[
-112.759167,
41.191667
]
]
]
}
}
}Wildfires
Identifier: wildfire
The FAA does not issue Temporary Flight Restrictions for the vast majority of fires in the United States, even though many are fought with firefighting aircraft. In many states, interfering with firefighting activity is considered a crime. This object includes realtime wildfires.
{
"status": "success",
"data": {
"id": "e25bed06-ba8e-488c-9ff7-06a54c644ae9",
"name": "Wildfire",
"type": "wildfire",
"country": "USA",
"state": "California",
"city": "Tehachapi",
"last_updated": "2016-08-12T18:45:02.000Z",
"properties": {
"date_effective": "August 11, 2016"
},
"geometry": {
"type": "Point",
"coordinates": [
-118.432234530465,
35.0969494022499
]
}
}
}Hospital
Identifier: hospital
Hospital
{
"status": "success",
"data": {
"id": "dced5845-aa31-4e3e-b232-7eb9071eace6",
"name": "Davis Hospital and Medical Center",
"type": "hospital",
"country": "USA",
"state": "Utah",
"city": "Layton",
"last_updated": "2016-07-20T17:46:08.000Z",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [
-111.995573,
41.09108
]
}
}
}Get Manufacturers
Get a list of aircraft manufacturers.
Use this endpoint to get a list of all available drone manufacturers. You may also include a query string to search based on the provided text.
Get Models
Get a list of aircraft models.
Use this endpoint to get a list of all available drone models. You may also include a query string to search for a manufacturer or model based on the provided text.
Get Model By ID
Get details about a specific aircraft.
Get details on a specific drone model.
Overview
Create and query flights, verify a pilot meets flight requirements, and provide digital notice.
Get Flights
Authentication
| API Key | Token | Result |
|---|---|---|
| Yes | No | Public Flights |
| Yes | Yes - Your Flights | Full Response |
| Yes | Yes - Public Flights | Public Flights |
Note
- Default Sort: Newest to Oldest
- Query Combinations:
••geometry
••country, state, city
Any combination of these can be used, but they will be joined by an AND, not OR. If 'country=Canada' and 'city=Santa Monica' is provided, no results will be sent.
•General Filters: can be used with all query combinations
pilot_id
start_after
start_before
end_after
*end_before
Get Individual Flight
Authentication
| API Key | Token | Result |
|---|---|---|
| Yes | No | Public Response |
| Yes | Yes - Your Flights | Full Response |
| Yes | Yes - Public Flights | Public Response |
Create Flight by Path
GeoJSON Note
When providing geometry as GeoJSON, please provide only the specific geometry consisting of the type and the coordinates.
{
"type": "LineString",
"coordinates": [
[-118.4951663017273,
34.016455319170184
],
[-118.49805235862732,
34.01409867199219
],
[-118.4995651245117,
34.01348504369081
]
]
}Authentication
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes | Allowed |
Create Flight by Polygon
GeoJSON Note
When providing geometry as GeoJSON, please provide only the specific geometry consisting of the type and the coordinates.
{
"type": "Polygon",
"coordinates": [
[
[-118.49572420120239,
34.016330818691884
],
[-118.49572420120239,
34.01732681740577
],
[-118.494393825531,
34.01732681740577
],
[-118.494393825531,
34.016330818691884
],
[-118.49572420120239,
34.016330818691884
]
]
]
}Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes | Allowed |
Delete Flight
Authentication
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Flight | Delete |
| Yes | Yes - Other Flight | 404 |
End Flight
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Flight | Delete |
| Yes | Yes - Other Flight | 404 |
Overview
Premium Feature
The Airspace API is a restricted API intended mainly for manufacturers. Please Contact Us for access.
The Airspace API provides detailed geometry of all the airspace advisories in a given area. Each object includes detailed metadata like properties, rules, requirements, etc. Geometry is returned as either GeoJSON or WKT
For more information on the types of airspace objects, please see the Airspace Types
uuid
Airspace ID
name
Airspace Name
type
Airspace Type
country
Country
state
State
city
City
last_updated
Last Updated Timestamp
properties
Airspace metadata and properties that are unique to each airspace object type
geometry
Basic geometry for the airspace object in GeoJSON
related_geometry
Associated geometries that are related to this geometry (such as a runway at an airport)
rules
List of rules for the airspace object
id
string
Rule ID
name
string
Rule Name
description
string
Rule Description
jurisdiction
string
Rule jurisdiction name
requirements
array
List of requirement objects
restriction_type
string
Rule restriction type
Airspace Search
Search for airspace objects by geometry+buffer in either WKT or GeoJSON format.
Airspace used in above example call:
{
"type": "Polygon",
"coordinates": [
[
[
-118.6578369140625,
34.11180455556899
],
[
-118.43261718749999,
33.694637550483186
],
[
-117.97393798828125,
33.62376800118811
],
[
-117.88330078125,
33.80197351806589
],
[
-118.6578369140625,
34.11180455556899
]
]
]
}Airspace Snapshot Download
The Airspace Snapshot service enables developers to download all airspace objects for a given country. It is called a "snapshot" service because the data is generated monthly and could be out of date anytime after it is generated. The Airspace Snapshot API will return a link to download the airspace file for a provided country.
The "current" snapshot is generated on the 15th of the month and can be accessed with the Airspace Snapshot Download Current .
The "next" snapshot is generated daily starting on the 5th of the month up until the 15th of the month, at which point it is equivalent to the "current" snapshot and will be no longer be available until the next month. The "next" snapshot is intended to give developers a preview of the upcoming changes that will be generated on the 15th. The "next" snapshot can be accessed with the Airspace Snapshot Download Next
Temporary Advisories Note
The Airspace Snapshot service includes all objects, including temporary advisories like TFRs and wildfires. Developers should use discretion in using the data, since many of the temporary advisories will likely change soon after the generation date. In many cases, it is probably better to use the standard Airspace Search to check for temporary airspace and rely on the airspace snapshot for objects that are not as prone to change - like airports and controlled airspace.
Airspace Snapshot Countries
Get all ISO 3166-1 Alpha-3 country codes available for airspace snapshot download
Overview
advisories
A list of all airspace objects intersecting with the proposed flight. Includes status color and distance. See Airspace Objects
max_safe_radius
The distance between a flight's takeoff point and the nearest yellow or red zone.
color
"green", "yellow" or "red". Green means no known advisories, yellow means there are known advisories in the area and the operator may require additional authorization or actions to fly in the area, and red means that flight is strictly regulated and probably not safe to fly for the majority of operators.
weather
A weather object containing condition, wind, humidity, visibility, precipitation and temperature.
color
red/yellow/green
yes
green = no issues, yellow = action required to fly, red = known to be unsafe
distance
0, infinite
yes
Distance in meters between flight and this advisory
latitude
-90, 90
yes
Reference point latitude
longitude
-180, 180
yes
Reference point longitude
country
3-digit country code
yes
Country
state
no
State
city
no
City
id
no
Requirement owner ID
type
yes
Airspace type
name
yes
Airspace name
notice.digital
no
True if D-NAS is accepted
notice.phone
no
Provided if notice can be given by phone
condition
overall weather description like "partly cloudy"
wind
wind object
wind.heading
degrees
direction of wind
wind.speed
km/h
sustained wind speed
wind.gusting
km/h
max wind speed of gusts
humidity
%
relative humidity
visibility
km
range of visibility in meters
precipitation
%
probability of rain
temperature
C
temperature
Get Flight Status by Point
Get flight advisories using a point and radius
Get Airspace Status by Path
Get flight advisories using a line path
Reminder
The starting location (latitude and longitude) must be within the bounds of the provided path and width of path
Example of path before URL encoding:
LINESTRING(-109.05 41.00, -102.06 40.99, -102.03 36.99, -109.04 36.99)
Get Airspace Status by Polygon
Get flight advisories using a polygon
Reminder
The starting location (latitude and longitude) must be within the bounds of the provided polygon
Example of polygon before URL encoding:
POLYGON(-109.05 41.00, -102.06 40.99, -102.03 36.99, -109.04 36.99, -109.05 41.00)
Overview
Get details about a pilot's profile, preferences and provides identity verification (email, phone, etc).
Get User Pilot Profile
Get the pilot profile of the current logged in user.
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | Yes - Your Profile | Full Response |
{
"status": "success",
"data": {
"id": "auth0|abc123",
"email": "r2d2@airmap.com",
"first_name": "R2D2",
"last_name": "Skywalker",
"username": "R2theD2",
"picture_url": "https://lh3.googleusercontent.com/-XdUIqdMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/4252rscbv5M/photo.jpg",
"phone": "+15557779999",
"verification_status": {
"phone": false,
"email": true
},
"user_metadata": {
"faa_registration_number": ,
},
"app_metadata": {
},
"statistics": {
"flight": {
"total": 10,
"last_flight_time": "2016-07-05T10:51:19.000Z"
},
"aircraft": {
"total": 2
}
}
}
}Get Pilot Profile
Get a pilot's profile.
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | Public Response |
| Yes | Yes - Your Profile | Full Response |
| Yes | Yes - Someone Else's Profile | Public Response |
{
"status": "success",
"data": {
"id": "auth0|abc123",
"email": "r2d2@airmap.com",
"first_name": "R2D2",
"last_name": "Skywalker",
"username": "R2theD2",
"picture_url": "https://lh3.googleusercontent.com/-XdUIqdMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/4252rscbv5M/photo.jpg",
"phone": "+15557779999",
"verification_status": {
"phone": false,
"email": true
},
"user_metadata": {
"faa_registration_number": ,
},
"app_metadata": {
},
"statistics": {
"flight": {
"total": 10,
"last_flight_time": "2016-07-05T10:51:19.000Z"
},
"aircraft": {
"total": 2
}
}
}
}{
"status": "success",
"data": {
"id": "auth0|abc123",
"email": "r2d2@airmap.com",
"first_name": "R2D2",
"last_name": "Skywalker",
"username": "R2theD2",
"picture_url": "https://lh3.googleusercontent.com/-XdUIqdMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/4252rscbv5M/photo.jpg",
"phone": "+15557779999",
"verification_status": {
"phone": false,
"email": true
},
"user_metadata": {
"faa_registration_number": ,
},
"app_metadata": {
},
"statistics": {
"flight": {
"total": 10,
"last_flight_time": "2016-07-05T10:51:19.000Z"
},
"aircraft": {
"total": 2
}
}
}
}
Public Response:
{
"status": "success",
"data": {
"id": "auth0|abc123",
"username": "R2theD2",
"picture_url": "https://lh3.googleusercontent.com/-XdUIqdMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/4252rscbv5M/photo.jpg"
}
}Update Pilot Profile
Update a pilot's profile.
If a the phone number is changed the validation status will change to false. A verification token can be sent using the /pilot/v2/:id/phone/send_token route.
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Full Response |
| Yes | Yes - Someone Else's Profile | Public Response |
Send Phone Verification Token
A six digit token will be sent via SMS to the current phone number attached to the pilot's profile. That token can be verified using Verify Phone Token
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Allow |
| Yes | Yes - Someone Else's Profile | 403 |
Verify Phone Token
Failed Verification
If the verification fails another token should be requested via the /pilot/v2/:id/phone/send_token route.
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Allow |
| Yes | Yes - Someone Else's Profile | 403 |
Get Pilot Aircraft
Get details about a pilot's profile, preferences and provides identity verification (email, phone, etc).
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Allow |
| Yes | Yes - Someone Else's Profile | 403 |
Add Pilot Aircraft
Get details about a pilot's profile, preferences and provides identity verification (email, phone, etc).
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Allow |
| Yes | Yes - Someone Else's Profile | 403 |
Update Pilot Aircraft
Get details about a pilot's profile, preferences and provides identity verification (email, phone, etc).
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Looking up themselves | Allow |
| Yes | Yes - Looking up someone else | 403 |
Delete Pilot Aircraft
Authorization
| API Key | Token | Result |
|---|---|---|
| Yes | No | 401 |
| Yes | Yes - Your Profile | Allow |
| Yes | Yes - Someone Else's Profile | 403 |
Vector Tiles
FORMAT: 1A
Tile API
Serves vector map tiles in the OSM slippy format
Tiles [/maps/v4/tiles/:layers/:z/:x/:y]
Get a Tile [GET]
Given a comma separated list of layers and a Z/X/Y position, return a map tile
Parameters
- layers:
airports_recreational,class_b,national_parks(string, required)
Comma separated list of airspace layers - z (integer, required)
Latitude in decimal format - x (integer, required)
Longitude in decimal format - y: (integer, required)
Search radius in meters (default 20,000m)
- layers:
Response 200
- Body
Protocol Buffer in Mapbox Vector Tile format
- Body
TileJSON [/maps/v4/tilejson/:layers]
Provide a TileJSON spec map style for use with MapBox GL
List Geometry Nearby [GET]
Parameters
- layers:
airports_recreational,class_b,national_parks(string, required)
Comma separated list of airspace layers - token: (string, required)
Your API key to append to map requests - theme:
dark(string, optional)
Option to include a themed base layer. Options available:standard, dark, light, satellite
- layers:
Response 200
TileJSON response
- Body
Style according to TileJSON Specification
- Body