AirHub API

Get Advisories GeoJSON

POST/v4/advisory/query

Last modified: 5 months ago

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 geometry as described by a GeoJSON geometry. May be a point, line, or polygon.

Request

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:

geometry

object

required

GeoJSON formatted geometry. Must be a point, line, or polygon. The resulting bounding box of the geometry can't have a side length greater than 100 miles.

type

string

required

coordinates

array[number]

required

geoIDs

array[string]

required

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

>= 0 items<= 5 items

altitudeUpper

integer

optional

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

altitudeLower

integer

optional

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

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

{
  "geometry": {
    "type": "Point",
    "coordinates": [
      -84.695,
      44.695
    ]
  },
  "geoIDs": [
    "1300021",
    "13"
  ],
  "altitudeUpper": 500,
  "altitudeLower": -100,
  "startTime": "2022-06-01T23:39:00Z",
  "endTime": "2022-06-30T23:39:00Z"
}

Request samples

Responses

200 Response(200)

500 Response(500)

HTTP Code: 200

Content Type : JSONapplication/json

statusCode

integer

required

message

string

required

data

object

required

type

string

required

features

array [object {3}]

required

{
  "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
        }
      }
    ]
  }
}

Last modified: 5 months ago