Skip to main content

StormSurgeResponse

Complete storm surge API response.

location_info objectnullable

Geocoded location information

formatted_addressFormatted Address (string)nullable
street_addressStreet Address (string)nullable
cityCity (string)nullable
stateState (string)nullable
state_codeState Code (string)nullable
countyCounty (string)nullable
postal_codePostal Code (string)nullable
latitudeLatitude (number)nullable
longitudeLongitude (number)nullable
geohash8Geohash8 (string)nullable
storm_surge objectrequired

Storm surge risk data

in_surge_zoneIn Surge Zone (boolean)required

Whether the location is in a storm surge zone

zones object[]nullable

Storm surge data per hurricane category

  • Array [
  • categoryCategory (integer)required

    Hurricane category (1-5)

    Possible values: >= 1 and <= 5

    depth_ftDepth Ft (integer)nullable

    Storm surge depth in feet

    depth_categoryDepth Category (string)required

    Human-readable depth category

    Example: 3-6 ft
    risk_levelRisk Level (integer)required

    Risk level (0=dry, 1-4=increasing risk)

    Possible values: >= 0 and <= 4

  • ]
  • highest_risk_levelHighest Risk Level (integer)nullable

    Highest risk level across all categories

    Possible values: >= 0 and <= 4

    highest_risk_categoryHighest Risk Category (string)nullable

    Depth category for highest risk

    max_surge_depth_ftMax Surge Depth Ft (integer)nullable

    Maximum surge depth in feet across all categories

    StormSurgeResponse
    {
    "location_info": {
    "formatted_address": "string",
    "street_address": "string",
    "city": "string",
    "state": "string",
    "state_code": "string",
    "county": "string",
    "postal_code": "string",
    "latitude": 0,
    "longitude": 0,
    "geohash8": "string"
    },
    "storm_surge": {
    "in_surge_zone": true,
    "zones": [
    {
    "category": 0,
    "depth_ft": 0,
    "depth_category": "3-6 ft",
    "risk_level": 0
    }
    ],
    "highest_risk_level": 0,
    "highest_risk_category": "string",
    "max_surge_depth_ft": 0
    }
    }