Get Hazard Ground Type

Scope: hazar:read

Represents the population classification(s) for the input geometry. Returns an array of the population densities and their respective geometries over the input geometry.

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

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.

Example

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

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.0971153280792,
                            42.3468433551722
                        ],
                        [
                            -83.0990819025849,
                            42.3457255397794
                        ],
                        [
                            -83.0986596481642,
                            42.343953004577
                        ],
                        [
                            -83.0962709796127,
                            42.3432982541788
                        ],
                        [
                            -83.0943044328186,
                            42.3444159892449
                        ],
                        [
                            -83.0947265268601,
                            42.3461885550334
                        ],
                        [
                            -83.0971153280792,
                            42.3468433551722
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "density": "Rural",
                "popPerSqKm": 9.49374599482591
            },
            "type": "Feature"
        },
        {
            "geometry": {
                "coordinates": [
                    [
                        [
                            -83.0973930778594,
                            42.338635600087
                        ],
                        [
                            -83.0993592954725,
                            42.337517896699
                        ],
                        [
                            -83.098937105593,
                            42.3357455276407
                        ],
                        [
                            -83.0965488584177,
                            42.3350908313854
                        ],
                        [
                            -83.0945826685047,
                            42.336208454456
                        ],
                        [
                            -83.0950046980627,
                            42.3379808540969
                        ],
                        [
                            -83.0973930778594,
                            42.338635600087
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "density": "Sparsely Populated",
                "popPerSqKm": 237.343649870648
            },
            "type": "Feature"
        },
        {
            "geometry": {
                "coordinates": [
                    [
                        [
                            -83.0728087834202,
                            42.3385206954732
                        ],
                        [
                            -83.0747756573681,
                            42.3374033949034
                        ],
                        [
                            -83.0743543975546,
                            42.3356309081094
                        ],
                        [
                            -83.0719664241671,
                            42.3349756913728
                        ],
                        [
                            -83.0699995780665,
                            42.3360929116356
                        ],
                        [
                            -83.070420677502,
                            42.3378654289395
                        ],
                        [
                            -83.0728087834202,
                            42.3385206954732
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "density": "Suburban",
                "popPerSqKm": 1414.56815322906
            },
            "type": "Feature"
        },
        {
            "geometry": {
                "coordinates": [
                    [
                        [
                            -83.0764625982752,
                            42.3163289986922
                        ],
                        [
                            -83.0784284294438,
                            42.315211953569
                        ],
                        [
                            -83.0780072339503,
                            42.3134399305004
                        ],
                        [
                            -83.0756203674996,
                            42.3127849220433
                        ],
                        [
                            -83.0736545641296,
                            42.3139018868832
                        ],
                        [
                            -83.0740755994075,
                            42.3156739404609
                        ],
                        [
                            -83.0764625982752,
                            42.3163289986922
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "density": "Rural",
                "popPerSqKm": 9.49374599482591
            },
            "type": "Feature"
        },
        {
            "geometry": {
                "coordinates": [
                    [
                        [
                            -83.0605958766704,
                            42.3152867996007
                        ],
                        [
                            -83.06256208984,
                            42.3141700281476
                        ],
                        [
                            -83.0621415031927,
                            42.3123979487249
                        ],
                        [
                            -83.0597548636166,
                            42.3117426102911
                        ],
                        [
                            -83.0577886783393,
                            42.3128593014687
                        ],
                        [
                            -83.0582091047415,
                            42.3146314113531
                        ],
                        [
                            -83.0605958766704,
                            42.3152867996007
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "density": "None",
                "popPerSqKm": 0
            },
            "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