Request structure
Hurricane Vulnerability Score can be requested as a new supplementary data source. The hurricaneScore supplementary data source can be requested along with other supplementary data sources (e.g. roofConditionConfidenceStats, defensibleSpace).
As the Hurricane Vulnerability Score is attached to footprint feature classes (Roof or Building Lifecycle), any pack that returns footprint features needs to be supplied via the packs parameter (i.e. roof_char). Alternatively, the classes parameter can be used to supply the Roof and/or Building Lifecycle feature class IDs instead.
Hurricane Vulnerability Score is only available for Gen 6 resources, so when making date-based features requests, systemVersionPrefix=gen6 will also be needed.
As clipped/unclipped feature geometry is closely linked to the parcelMode request parameter, when wanting to generate hurricane scores for clipped building footprints (e.g. requesting scores for a single property in row houses) parcelMode=true must be supplied.
Example Request using hurricaneScore
curl "https://api.nearmap.com/ai/features/v4/features.json?polygon=-108.083501%2C36.802239%2C-108.083695%2C36.802397%2C-108.084614%2C36.803152%2C-108.083134%2C36.803882%2C-108.082868%2C36.803245%2C-108.082504%2C36.802355%2C-108.082863%2C36.802315%2C-108.083501%2C36.802239&packs=roof_char&include=hurricaneScore&since=2024-06-03&until=2024-06-03&systemVersionPrefix=gen6&parcelMode=true&apikey=$APIKEY"
Response structure
- Response Schema
- For features that will have hurricane score supplementary data (i.e. Roof and Building Lifecycle class), a new field is added called hurricaneScore.
- Only with Roof features, unless the roof has significant damage detected. Then hurricane score will be associated with the Building Lifecycle feature.
- This field contains:
- hurricaneVulnerabilityScore: An integer from 1-5 indicating vulnerability level (1 = most vulnerable, 5 = most resilient)
- hurricaneVulnerabilityProbability: A float between 0 and 1 representing the raw model probability that the building will not be damaged if impacted by hurricane-force winds
- hurricaneRateFactor: A float representing the rate adjustment factor filed with US regulatory authorities that can be used to adjust premium based on vulnerability
- modelInputFeatures: An object containing the features used as inputs to the machine learning model
Sample response (excerpt)
