Request structure
Both Wind Vulnerability and Risk scores can be requested as a supplementary data source. The windScore supplementary data source can be requested along with other supplementary data sources such as hurricaneScore and defensibleSpace.
As the Wind Vulnerability Score is attached to footprint feature classes, such as 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.
Wind scores are only available for Gen 6 AI resources, so when making date-based features requests, you will need to use systemVersionPrefix=gen6.
As clipped/unclipped feature geometry is closely linked to the parcelMode request parameter, when wanting to generate wind scores for clipped building footprints. For example, when requesting scores for a single property in row houses.
Example Request using windScore
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=windScore&since=2024-06-03&until=2024-06-03&systemVersionPrefix=gen6&parcelMode=true&apikey=$APIKEY"
Response structure
- For features that will have wind score supplementary data (i.e. Roof and Building Lifecycle class), a new field called
windScore has been added. - Wind score data is included only with Roof features. If the roof has significant damage detected, the wind score will be associated with the Building Lifecycle feature.
- The
windScore field contains Vulnerability and Risk data.
Vulnerability data
vulnerabilityScore: An integer from 1-5 indicating the vulnerability level with 1 = most vulnerable and 5 = most resilientvulnerabilityProbability: A float between 0 and 1 representing the raw model probabilityvulnerabilityRateFactor: A float representing the rate adjustment factor that can be used to adjust premium based on vulnerabilitymodelInputFeatures: An object containing the features used as inputs to the machine learning model
Risk data (includes hazard):
riskScore: An integer from 1-5 combining vulnerability and FEMA hazard frequency with 1 = most likely to have a claim and 5 = least likely to have a claimriskRateFactor: A float representing the rate adjustment factor for the risk scorefemaAnnualWindFrequency: Annual wind frequency from FEMA National Risk IndexfemaVersion: Version of FEMA dataset used
Sample response (excerpt)
