AirHub API

Advisory

Deprecated

Sandbox

https://airhub-api-sandbox.airspacelink.com

POST

/v2/advisory

Standard

Last modified:2024-05-17 17:12:15

Scope: advisory:read

DEPRECATED - use Get Advisories BBox or Get Advisories GeoJSON.

Advisories represent geographic areas where special consideration must be made before operating drones. Examples of advisories may range from restricted airspace, where it's illegal to operate a drone, to warnings where it's important for you to understand the context of where you're flying to maximize safety. Additional advisory types will be documented as they're added.

Request

Header Params

Content-Type

enum<string>

required

Allowed value:

application/json;charset=UTF-8

Example:

application/json;charset=UTF-8

Authorization

string

required

Authorization bearer accessToken generated in Authorization step

Default:

Example:

Body Params application/json

geometry

object

required

GeoJSON formatted geometry. Available geometries may be a point, line, or polygon. The resulting bounding box of the geometry can't have a side length greater than 30 nautical miles.

coordinates

array [array]

required

type

string

required

category

string

required

This is the specified rule category under which you'll be flying.

Category	Description
faa_107	FAA Commercial UAS Flight
faa_44809	FAA Recreational UAS Flight

source

string

optional

Represents the source of the advsiory or the authority that created the advisory. Additional sources will be made available in the future.

Source	Description
faa	Federal (FAA) advisories
community	State & Local community advisories
all	All available advisories

startTime

string

optional

Filters advisories that are active at the same time as, or after startTime. Send as YYYY-MM-DDThh:mmZ.

endTime

string

optional

Filters advisories that are active at the same time as, or after endTime. Send as YYYY-MM-DDThh:mmZ.

maxAltitude

integer

optional

The maximimum altitude anticipated for the operation. This helps to determine FAA restrictions.

Example

{
  "category": "faa_com_part_107",
  "geometry": {
    "coordinates": [
      [
        [
          -83.2592354683282,
          42.2395810171841
        ],
        [
          -83.3862648872736,
          42.2395810171841
        ],
        [
          -83.3862648872736,
          42.1378288396814
        ],
        [
          -83.2592354683282,
          42.1378288396814
        ],
        [
          -83.2592354683282,
          42.2395810171841
        ]
      ]
    ],
    "type": "Polygon"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://airhub-api-sandbox.airspacelink.com/v2/advisory' \
--header 'Authorization: ' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "category": "faa_com_part_107",
    "geometry": {
        "coordinates": [
            [
                [
                    -83.2592354683282,
                    42.2395810171841
                ],
                [
                    -83.3862648872736,
                    42.2395810171841
                ],
                [
                    -83.3862648872736,
                    42.1378288396814
                ],
                [
                    -83.2592354683282,
                    42.1378288396814
                ],
                [
                    -83.2592354683282,
                    42.2395810171841
                ]
            ]
        ],
        "type": "Polygon"
    }
}'

Responses

🟢200Success

application/json

Body

data

array [object {3}]

required

geometry

object

optional

properties

object

optional

type

string

optional

message

string

required

statusCode

integer

required

Example

{
  "data": [
    {
      "geometry": {
        "coordinates": [
          []
        ],
        "type": "Polygon"
      },
      "properties": {
        "advisorySource": "faa",
        "advisoryType": "uasfm_ceiling",
        "contactEmail": "john@gov.gov",
        "contactName": "John Doe",
        "contactPhone": "+12345678910",
        "contactUrl": "http://myadvisory.com/1234",
        "effectiveDays": [
          "Mon",
          "Tue",
          "Fri"
        ],
        "endDate": "2020-01-01T00:00:00.0000000+00:00",
        "endTime": "2020-12-16T20:00:00.0000000+00:00",
        "message": "The max altitude exceeds ...",
        "severity": "warning",
        "startDate": "2020-01-01T00:00:00.0000000+00:00",
        "startTime": "2020-12-16T10:10:00.0000000+00:00",
        "timezone": "America/New_York",
        "title": "UASFM Grid"
      },
      "type": "Feature"
    }
  ],
  "message": "success",
  "statusCode": 200
}

🟠400400

🔴500500

Get Oauth Token

Get Advisories BBox