Get Hazard Ground Risk

Scope: hazar:read

Ground Risk is modeled from a combination of ground-based hazards, altitude, and drone characteristics (e.g. weight, speed, etc). Risk assessments are based on the SORA 2.5 model.

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

Example:

Body Params application/json

controlledGroundArea

boolean

required

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.

coordinates

array [array]

required

type

string

required

resolution

integer

required

Hex grid resolution.

uavDimensionImperial

boolean

required

uavMaxDimensionSize

number

required

Maximum size of the drone.

uavMaxSpeed

integer

required

Maximum speed of the drone.

uavWeight

number

required

Describes the weight of the drone.

Example

{
  "controlledGroundArea": false,
  "geometry": {
    "coordinates": [
      [
        [
          -83.097153,
          42.310006
        ],
        [
          -83.097153,
          42.343955
        ],
        [
          -83.031235,
          42.343955
        ],
        [
          -83.031235,
          42.310006
        ],
        [
          -83.097153,
          42.310006
        ]
      ]
    ],
    "type": "Polygon"
  },
  "resolution": 9,
  "uavDimensionImperial": true,
  "uavMaxDimensionSize": 10.4,
  "uavMaxSpeed": 100
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200success

application/json

Body

data

array [object {3}]

required

geometry

object

required

properties

object

required

type

string

required

message

string

required

statusCode

integer

required

Example

{
  "data": [
    {
      "geometry": {
        "coordinates": [
          [
            [
              -83.0475361731786,
              42.3166702773875
            ],
            [
              -83.0495027960014,
              42.315553699439
            ],
            [
              -83.0490826901295,
              42.3137815286693
            ],
            [
              -83.0466961217155,
              42.3131259054218
            ],
            [
              -83.0447295268648,
              42.3142424030989
            ],
            [
              -83.0451494724517,
              42.3160146042923
            ],
            [
              -83.0475361731786,
              42.3166702773875
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "density": "None",
        "popPerSqKm": 0,
        "score": 7
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            [
              -83.0867122343183,
              42.3125155396005
            ],
            [
              -83.0886776277423,
              42.3113983814916
            ],
            [
              -83.0882560799036,
              42.3096264851038
            ],
            [
              -83.0858692988019,
              42.3089717162851
            ],
            [
              -83.0839039331106,
              42.3100887941108
            ],
            [
              -83.0843253207841,
              42.311860721036
            ],
            [
              -83.0867122343183,
              42.3125155396005
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "density": "Suburban",
        "popPerSqKm": 294.306125839603,
        "score": 8
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            [
              -83.0615736686261,
              42.3288094992409
            ],
            [
              -83.0635404311016,
              42.3276925198757
            ],
            [
              -83.0631196843689,
              42.3259201734114
            ],
            [
              -83.0607323354932,
              42.3252647758383
            ],
            [
              -83.0587656009204,
              42.3263816749123
            ],
            [
              -83.0591861873164,
              42.3281540518482
            ],
            [
              -83.0615736686261,
              42.3288094992409
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "density": "Urban",
        "popPerSqKm": 3218.37989224598,
        "score": 9
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            [
              -83.0534357406362,
              42.313320494788
            ],
            [
              -83.0554020624543,
              42.3122038680975
            ],
            [
              -83.0549817641796,
              42.3104317933705
            ],
            [
              -83.0525953043307,
              42.3097763148922
            ],
            [
              -83.0506290104454,
              42.3108928613125
            ],
            [
              -83.051049148472,
              42.3126649664789
            ],
            [
              -83.0534357406362,
              42.313320494788
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "density": "None",
        "popPerSqKm": 0,
        "score": 7
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            [
              -83.0379646863298,
              42.3422119818712
            ],
            [
              -83.0399326538863,
              42.3410951979837
            ],
            [
              -83.0395126774702,
              42.3393224674647
            ],
            [
              -83.037124893978,
              42.3386664904221
            ],
            [
              -83.035156954482,
              42.339783194013
            ],
            [
              -83.0355767704135,
              42.3415559549407
            ],
            [
              -83.0379646863298,
              42.3422119818712
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "density": "Suburban",
        "popPerSqKm": 2316.47402273752,
        "score": 8
      },
      "type": "Feature"
    }
  ],
  "message": "success",
  "statusCode": 200
}

🟠400Your request was invalid JSON or is using invalid types

🟠408Your request timed out; try reducing the size of the request

🟠422Part of your request had invalid values

🔴500Database error