Get Advisories BBox - AirHub API

Scope: advisory:read

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.

Find advisories that intersect the input bbox as described by an array coordinate pairs as described by the upper-left and lower-right coordinates of the box.

Request

Query Params

bbox

string

required

Bounding box of area to query advisory. bbox and geoIDs cannot both be omitted.

Example:

[-84.3,43.04,-86.26,45.75]

geoIDs

array[string]

required

Filter advisories that are present in the following geo-IDs. Limit of 5 IDs.

>= 0 items<= 5 items

Example:

[""]

altitudeUpper

number

optional

Filter advisories that are flying at or below the specified altitude.

Example:

400

altitudeLower

number

optional

Filter advisories that are flying at or above the specified altitude.

Example:

startTime

string <date-time>

optional

Lower bound of the time range filter. Returns advisories that are active at the same time as, or after startTime.

Match pattern:

YYYY-MM-DDThh:mmZ

endTime

string <date-time>

optional

Upper bound of the time range filter. Returns advisories that are active at the same time as, or before endTime.

Match pattern:

YYYY-MM-DDThh:mmZ

Header Params

Content-Type

enum<string>

required

Allowed value:

application/json;charset=UTF-8

Example:

application/json;charset=UTF-8

Authorization

string

optional

Authorization bearer accessToken generated in Authorization step

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 Response

application/json

Body

statusCode

integer

required

message

string

required

data

object

required

type

string

required

features

array [object {3}]

required

Example

{
  "statusCode": 200,
  "message": "success",
  "data": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -84.69289659570808,
                44.68428721296152
              ],
              [
                -84.69476557152252,
                44.69483277365174
              ],
              [
                -84.67317443855015,
                44.70036706219832
              ],
              [
                -84.67203280238344,
                44.67752066765469
              ],
              [
                -84.686540954764,
                44.67911058319509
              ],
              [
                -84.69289659570808,
                44.68428721296152
              ]
            ]
          ]
        },
        "properties": {
          "advisoryCategory": "admin",
          "altitudeLower": 0,
          "altitudeUpper": 400,
          "contactEmail": "example@email.com",
          "contactFirstName": "Example",
          "contactLastName": "User",
          "contactPhone": "+3135551234",
          "countryGeoID": "1000",
          "description": "Example Advisory to communicate events, conditions, activities relevant to UAS operations or planning",
          "endTime": "2024-02-23T16:12:00Z",
          "geoID": "26",
          "id": "311343de-7526-444e-9cc5-bdc9d785bae3",
          "lastEditDate": "2024-02-22T15:59:07.097661Z",
          "name": "UAS Operation Coordination",
          "published": true,
          "referenceNumber": null,
          "startTime": "2024-02-22T16:12:00Z",
          "tags": [],
          "timezoneName": "America/New_York",
          "url": null
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -84.66588398881683,
                44.71657210650567
              ],
              [
                -84.60743044011728,
                44.716572106505666
              ],
              [
                -84.60743044011728,
                44.683243709601655
              ],
              [
                -84.66588398881683,
                44.68324370960165
              ],
              [
                -84.66588398881683,
                44.71657210650567
              ]
            ]
          ]
        },
        "properties": {
          "advisoryCategory": "admin",
          "altitudeLower": 0,
          "altitudeUpper": 400,
          "contactEmail": "example@email.com",
          "contactFirstName": "Example",
          "contactLastName": "User",
          "contactPhone": "+13135551234",
          "countryGeoID": "1000",
          "description": "Example live fire exercise",
          "endTime": "2024-03-06T19:57:00Z",
          "geoID": "26",
          "id": "73c9ddff-366b-4372-b4c2-daaea5a90199",
          "lastEditDate": "2024-03-05T19:43:51.178522Z",
          "name": "Demonstration Activities",
          "published": true,
          "referenceNumber": null,
          "startTime": "2024-03-05T19:57:00Z",
          "tags": [],
          "timezoneName": "America/New_York",
          "url": null
        }
      }
    ]
  }
}

🔴500500 Response