Request structure
Hail scores (vulnerability and risk) can be requested as a supplementary data source. The hailScore supplementary data source can be requested along with other supplementary data sources such ashurricaneScore and defensibleSpace.
As the Hail 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.
Hail scores (vulnerability and risk) 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 hail scores for clipped building footprints (e.g. requesting scores for a single property in row houses) parcelMode=true must be supplied.
Example Request using hailScore
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=hailScore&since=2024-06-03&until=2024-06-03&systemVersionPrefix=gen6&parcelMode=true&apikey=$APIKEY"
Response structure
- For features that will have hail score supplementary data (i.e. Roof and Building Lifecycle class), a new field called
hailScore has been added. - Only with Roof features, unless the roof has significant damage detected. Then the hail score will be associated with the Building Lifecycle feature.
- The hailScore field contains Vulnerability and Risk data.
Vulnerability data
vulnerabilityScore: An integer from 1-5 indicating vulnerability level (1 = most vulnerable, 5 = most resilient)vulnerabilityProbability: 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 (1 = most likely to have a claim, 5 = least likely)riskRateFactor: A float representing the rate adjustment factor for the risk scorefemaAnnualHailFrequency: Annual hail frequency from FEMA National Risk IndexfemaVersion: Version of FEMA dataset used
Sample response (excerpt)
