Resources for geocoding and looking up hazard data
Overview
The Geohaz API defines operations for geocoding and performing lookups of hazard data for account and portfolio exposures.
geocode
: Ageocode
operation enriches exposures with geolocation data that precisely identifies the global coordinates of a site.hazard
: Ahazard
operation retrieves data about local conditions and potential hazards for an exposure.
Both operation types leverage proprietary data collected in a data product known as layer. Moody's layers enable Intelligent Risk Platform tenants to enrich location exposures with data that will enable them to better assess risk at those locations.
Operations
Operation | Method | Path | Description |
---|---|---|---|
Search Geohaz Job | GET | /platform/geohaz/v1/jobs | Returns list of GEOHAZ jobs. |
Get Geohaz Job | GET | /platform/geohaz/v1/jobs/jobId | Polls GEOHAZ job. |
Create Geohaz Job | POST | /platform/geohaz/v1/jobs | Initiates GEOHAZ job. |
Update Geohaz Job | PATCH | /platform/geohaz/v1/jobs/jobId | Updates GEOHAZ job. |
Data layers
A data layer is data product that contains information about properties in a specific region or the vulnerability of those properties to a specific peril. Data layers are leveraged in geocoding or hazard lookup workflows to enrich the quality of the data available about location exposures and improve the accuracy of risk analysis.
In the Geohaz API, these data layers are collected into two broad types:
- A geocode layer is a geographic database that contains latitude-longitude coordinates for locations.
- A hazard layer is a data product that contains peril- and region-specific hazard data that characterize the vulnerability of a location to a catastrophe event.
A data layer must be specified in every GEOHAZ
job. Every layer is defined by its type
(geocode
or hazard
), name
, engineType
(RL
or HD
), and version
.
Geocode Layers
Geocoding is the process of enriching a location exposure with geolocation data that precisely identifies the global coordinates of a site.
The Geohaz API supports geocoding of locations for catastrophe modeling using either DLM and HD models. Geocoding is a prerequisite for all catastrophe modelling processes. To learn more, see Geocoding in Support Center.
The table identifies geocoding layers supported by the Geohaz API:
name | engineType | version |
---|---|---|
geocode | RL | 18.0 |
geocode | HD | 18.1 |
geocode | RL | 18.1 |
geocode | HD | 21.0 |
geocode | RL | 21.0 |
geocode | HD | 22.0 |
geocode | RL | 22.0 |
geocode | RL or HD | 23.0 |
geocode | RL or HD | 24.0 |
geocode | RL or HD | 25.0 |
Every request to geocode an exposure must specify three parameters: the name
of the data layer, the version
, and the engine type, which corresponds to the engine used to model the account, or portfolio exposure.
Engine types
Valid values for the engineType
parameter differ between the Create Geohaz Job and Create Bulk Geohaz Job operations.
- The
RL
engine type supports geocoding of exposures modeled using detailed loss models (DLM). - The
HD
engine type supports geocoding of exposures modeled using High Definition models (HD).
Beginning with Geocode 23.0, the same layer is used to geocode locations in both DLM and HD cat modeling workflows. These versions of the Geocode layer (versions 23.0
, 24.0
, and 25.0
) all use the Moody's geocoding engine. Either value (RL
or HD
) can be specified.
Geocoding license
The geoLicenseType
parameter identifies the match level that can be achieved during geocoding.
geoLicenseType | Description |
---|---|
0 | If 0 , supports DLM match levels, i.e. resolution levels appropriate for DLM modelling. Recommended if engineType is RL . |
1 | If 1 , supports HD match levels, i.e. resolution levels appropriate for HD modelling. Recommended if engineType is HD . |
In general, the license type specified should correspond to the geocoding engine (RL
or HD
).
Low-resolution geocoding (postal code and lower) is sufficient for Detailed Loss Model (DLM) loss analyses
Note
Two geocode data layers (RL 18.0 and RL 18.1) behave differently depending on the
geoLicenseType
specified in the request.If the DLM
geoLicenseType
(0
) is specified, certain locations in Europe (including Great Britain) are not geocoded when using 18.0 or 18.1 of the Geocode (RL) data layer.
Hazard Layers
A hazard layer is a data product that contains peril- and region-specific hazard data that characterize the vulnerability of a location to a catastrophe event.
A hazard GEOHAZ
job looks up data in the specified hazard layer and enriches location exposures with risk data drawn from a peril model database, a collection of site hazard values that characterize the vulnerability of a location to a catastrophe event.
The Geohaz API supports two types of lookups of hazard data:
- Standard hazard layers identify hazard layer lookup data that is accessible to all licensed Intelligent Risk Platform tenants. This includes all of the layers that are required to perform DLM or HD modeling.
- Enhanced risk data hazard layers provide additional information about a location's risk are available as separately licensed data products.
Standard Hazard Layers
The table identifies standard hazard layers that are supported in the Geohaz API:
Version | Layer | name | engineType | version |
---|---|---|---|---|
1.0 | Default: Flood | fl_hazard | HD | 1.0 |
1.0 | Wildfire | wf_model_hazard | HD | 1.0 |
1.0 | Surge/Flood Elevation (US Only) | surge | HD | 18.1 |
1.1 | Default: Flood | fl_hazard | HD | 1.1 |
1.1 | Surge/Flood Elevation (US Only) | surge | HD | 21.0 |
1.2 | Default: Flood | fl_hazard | HD | 1.2 |
1.2 | Surge/Flood Elevation (US Only) | surge | HD | 21.0 |
1.3 | Default: Flood | fl_hazard | HD | 1.3 |
1.3 | Surge/Flood Elevation (US Only) | surge | HD | 21.0 |
2.0 | Earthquake | hd_earthquake | HD | 2.0 |
2.0 | Wildfire | wf_model_hazard | HD | 2.0 |
3.0 | Earthquake | hd_earthquake | HD | 3.0 |
18.0 | Earthquake | earthquake | RL | 18.0 |
18.0 | Windstorm | windstorm | RL | 18.0 |
18.1 | Earthquake | earthquake | RL | 18.1 |
18.1 | Windstorm | windstorm | RL | 18.1 |
21.0 | Earthquake | earthquake | RL | 21.0 |
21.0 | Windstorm | windstorm | RL | 21.0 |
22.0 | Earthquake | earthquake | RL | 22.0 |
22.0 | Windstorm | windstorm | RL | 22.0 |
23.0 | Earthquake | earthquake | RL | 23.0 |
23.0 | Windstorm | windstorm | RL | 23.0 |
24.0 | Earthquake | earthquake | RL | 24.0 |
24.0 | Windstorm | windstorm | RL | 24.0 |
25.0 | Earthquake | earthquake | RL | 25.0 |
25.0 | Windstorm | windstorm | RL | 25.0 |
The first two columns identify the hazard layer as it is named in the Risk Modeler application and documentation.
Hazard Layers: Enhanced Risk Data
The table identifies Enhanced Risk Data hazard layers that are supported in the Geohaz API:
Version | Option | name | engineType | version |
---|---|---|---|---|
Latest | Earthquake: Risk Scores | eq_risk_score | HD | latest |
Latest | Earthquake: Distance to Fault | distance_to_fault | HD | latest |
Latest | Earthquake: MMI | mmi | HD | latest |
Latest | Earthquake: Subsidence | subsidence | HD | latest |
Latest | Windstorm: Risk Scores | ws_risk_score | HD | latest |
Latest | Windstorm: Windpool Zone | ws_windpool_zone | HD | latest |
Latest | Windstorm: Distance to Inner Coast | distance_to_inner_coast | HD | latest |
Latest | Windstorm: Model Hazard | ws_model_hazard | HD | latest |
Latest | Wildfire: Risk Scores | wf_risk_score | HD | latest |
Latest | Wildfire: Model Hazard | wf_model_hazard | HD | latest |
Latest | Wildfire: Supplemental Hazard | wf_supplemental_hazard | HD | latest |
Latest | Flood: Risk Scores | fl_risk_score | HD | latest |
Latest | Flood: Depth | fl_depth | HD | latest |
Latest | Flood: Global Depth | global_fl_depth | HD | latest |
Latest | Flood | fl_hazard | HD | latest |
Latest | Convective Storm: Risk Scores | cs_risk_score | HD | latest |
Latest | Winterstorm: Risk Scores | wt_risk_score | HD | latest |
Latest | Terrorism: Risk Scores | tr_risk_score | HD | latest |
Entitlements
Client must be assigned one of the following entitlements to use this API:
RI-EXPOSUREIQ
RI-RISKMODELER
RI-UNDERWRITEIQ