Resources for geocoding and hazarding risk data
Overview
The Geohaz API defines operations that enable client applications to use a library of data products to perform geocode and hazard lookups for account and portfolio resources.
The Geohaz API supports two basic types of operations using different versions of a variety of data products (layers):
geocode
: Ageocode
job enriches a location exposure with geolocation data that precisely identifies the global coordinates of a site.hazard
: Ahazard
job retrieves data about local conditions and potential hazards for the locations associated with the specified account or portfolio exposure.
Depending on the type
of operation (geocode
or hazard
) and the data product (layer) specified, the Geohaz API may require that different parameters and parameter values be specified in the request.
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. |
Layers
A layer (data product) is a data asset that is designed to provide actionable insights with minimal overhead and latency.
Moody's geocode and hazard layers enable Intelligent Risk Platform tenants to enrich location exposures with Moody's proprietary data that will enable them to more accurately assess risk at those locations. These layers can can be used to improve location data in geocoding operations and hazard lookups by providing risk scores, and loss cost lookups.
A 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. Geocoding is a prerequisite for all catastrophe modelling processes.
The table identifies standard geocoding layers that are supported by the Geohazard API:
Version | Layer | name | engineType | version |
---|---|---|---|---|
18.0 | Geocode (DLM) | geocode | RL | 18.0 |
18.1 | Geocode (HD) | geocode | HD | 18.1 |
18.1 | Geocode (DLM) | geocode | RL | 18.1 |
21.0 | Geocode (HD) | geocode | HD | 21.0 |
21.0 | Geocode (DLM) | geocode | RL | 21.0 |
22.0 | Geocode (HD) | geocode | HD | 22.0 |
22.0 | Geocode (DLM) | geocode | RL | 22.0 |
23.0 | Geocode (DLM & HD) | geocode | RL | 23.0 |
24.0 | Geocode (DLM & HD) | geocode | RL | 24.0 |
25.0 | Geocode (DLM & HD) | geocode | RL | 25.0 |
The Geohazard API supports geocoding of locations for catastrophe modeling using either DLM and HD models.
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, which is identified as RL
in the Geohazard API.
Prior versions of the Geocode layer are available in distinct DLM and HD versions. These versions of the Geocode layer require distinct geocoding engines:
- DLM Geocode layers: Versions
18.0
,18.1
,21.0
, and22.0
of the DLM Geocode layer use the RiskLink (RL
) geocoding engine. - HD Geocode layers: Versions
18.1
,21.0
, and22.0
of theHD
of the HD Geocode layer use the Location Intelligence (HD
) geocoding engine.
Hazard Layers
A hazard layer is a data product that contains peril-specific information about local conditions and potential hazards.
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. Depending on the the peril, a hazard look up may be required before a location can be modeled.
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.
To learn more, see the Climate Hazard Models: Climate Variability and Change white paper in Support Center.
Standard Hazard Layers
Standard hazard layers are data products that offer peril-specific information about locations in modelled countries.
During a hazard lookup job, proprietary Moody's data in the layer is added to the location enriching the available information about that location and enabling the tentant to better assess risk to a particular peril. In some workflows, a location must be both geocoded and enriched with hazard data before it can be modeled using DLM or HD models.
Standard hazard layers are available to all licensed Intelligent Risk Platform tenants.
The table identifies standard hazard layers that are supported in the Geohazard 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 Risk Modeler documentation. See Overview of HD Models in Risk Modeler in Help Center.
The final three columns identify these hazard layers as they are identified in the Geohazard API by name
, engineType
, and version
. All three of these parameters must be specified in a Create Geohaz Job request. Note that the version
that identifies the layer in Geohaz API does not always match the layer version.
Flood
The Flood layer (fl_hazard
) option initiates a GEOHAZ
job that looks up hazard data in the Flood data product.
The option uses the HD engine to calculate risk for a location exposure based on the Flood data product.
This layer is available in the following versions: 1.0
, 1.1
, 1.2
, 1.3
.
Surge/Flood Elevation
The Surge/Flood Elevation layer (surge
) option initiates a GEOHAZ
job using a version of the Surge/Flood data product.
"For analyzing surge losses with the U.S. Inland Flood HD Model, you must run hazard lookup by selecting the Surge/Flood Elevation (US Only) hazard layer. If you do not run this hazard lookup, surge results will be incorrect. Select the HD Version that corresponds to the version of the model selected in the HD model profile, e.g., for an analysis using version HDv1.2 in the model profile, run hazard lookup using HD Version 1.2."
This layer can be used to define jobs using the HD
engine. Note that the version
that identifies the layer in Geohaz API does not always match the layer version. This layer is available in the following versions: 18.1
(1.0) and 21.0
(1.1, 1.2, 1.3).
Earthquake (HD)
The Earthquake layer (hd_earthquake
) option initiates a GEOHAZ
job using a version of the Earthquake HD data product.
This layer can be used to define hazard
jobs using the HD
engine.
This layer is available in the following versions: 2.0
, 3.0
.
Earthquake (RL)
The Earthquake layer (earthquake
) initiates a GEOHAZ
job using a version of the Earthquake data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
This layer is available in the following versions: 18.0
, 18.1
, 21.0
, 22.0
, 23.0
, 24.0
, 25.0
.
Wildfire
The Wildfire layer (wf_model_hazard
) defines a GEOHAZ
job using a version of the specified version of the Windstorm layer.
The WildFire layer can be used to define jobs using the HD
engine.
This layer is available in the following versions: 1.0
, 2.0
.
Windstorm
The Windstorm layer (windstorm
) initiates a GEOHAZ
job using a version of the specified version of the Windstorm layer.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
This layer is available in the following versions: 18.0
, 18.1
, 21.0
, 22.0
, 23.0
, 24.0
, 25.0
.
Hazard Layers: Enhanced Risk Data
Enhanced Risk Data requires an additional license.
The table identifies Enhanced Risk Data hazard layers that are supported in the Geohazard API. The first two columns identify the hazard layer as it is named in the Risk Modeler application and Risk Modeler documentation. The final three columns identify these hazard layers as they are identified in the Geohazard API by name
, engineType
, and version
. All three of these parameters must be specified in a Create Geohaz request.
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 |
Earthquake: Risk Scores
The Earthquake: Risk Scores layer (eq_risk_score
)
The eq_risk_score
option initiates a GEOHAZ
job using a version of the Earthquake HD data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Earthquake: Distance to Fault
The Earthquake: Distance to Fault layer (distance_to_fault
) option initiates a GEOHAZ
job using a version of the Distance to Fault data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Earthquake: MMI
The Earthquake: MMI layer (mmi
) option initiates a GEOHAZ
job using a version of the Modified Mercalli Intensity (MMI)
data product.
The operation assesses earthquake risk for exposures over an array of return periods using the Modified Mercalli Intensity (MMI) scale. For each return period the service returns a measurement of seismic intensity ranging between 1 (not felt) and 12 (extreme risk) enabling the user to understand the implications of earthquake risk in United States.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Earthquake: Subsidence
The Earthquake: Subsidence layer (subsidence
) option initiates a GEOHAZ
job using a version of the Subsidence data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Windstorm: Risk Scores
The Windstorm: Risk Scoreslayer (ws_risk_score
) option initiates a GEOHAZ
job using a version of the Windstorm Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Windstorm: Windpool Zone
The Windstorm: Windpool Zone layer (ws_windpool_zone
) option initiates a GEOHAZ
job using a version of the Windstorm data product.
The data product enriches geocoded locations with site hazard values that characterize the vulnerability of that location.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Windstorm: Distance to Inner Coast
The Windstorm: Distance to Inner Coast layer (distance_to_inner_coast
) option initiates a GEOHAZ
job using a version of the Distance to Inner Coast data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Windstorm: Model Hazard
The Windstorm: Model Hazard layer (ws_model_hazard
) option initiates a GEOHAZ
job using a version of the Windstorm Hazard data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Wildfire: Risk Scores
The Wildfire: Risk Scores layer (wf_risk_score
) option initiates a GEOHAZ
job using a version of the Wildfire Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Wildfire: Model Hazard
The Wildfire: Model Hazard layer (wf_model_hazard
) option initiates a GEOHAZ
job using a version of the Wildfire Model Hazard data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Wildfire: Supplemental Hazard
The Wildfire: Supplemental Hazard layer (wf_supplemental_hazard
) option initiates a GEOHAZ
job using a version of the Wildfire Supplemental Hazard data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Flood: Risk Scores
The Flood: Risk Scores layer (fl_risk_score
) option initiates a GEOHAZ
job using a version of the Flood Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Flood: Depth
The Flood: Depth layer (fl_depth
) initiates a GEOHAZ
job using a version of the Flood Depth data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Flood: Global Depth
The Flood: Global Depth layer (global_fl_depth
)
The global_fl_depth
option initiates a GEOHAZ
job using a version of the Global Flood Depth data product.
Flood
The Flood layer (fl_hazard
) option initiates a GEOHAZ
job using a version of the Flood Hazard data product.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Convective Storm: Risk Scores
The Convective Storm: Risk Scores layer (cs_risk_score
) initiates a GEOHAZ
job using a version of the Convection Storm Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Winterstorm: Risk Scores
The Winterstorm: Risk Scores layer (wt_risk_score
) option initiates a GEOHAZ
job using a version of the Winterstorm Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Terrorism: Risk Scores
The Terrorism: Risk Scores layer (tr_risk_score
) option initiates a GEOHAZ
job using a version of the Terrorism Risk Score data product.
The job calculates risk score metrics for exposures based on their location and building attributes using the Earthquake Risk Score data product. Using risk score metrics, you can evaluate both the severity of the hazard at a particular location and the vulnerability of buildings to that hazard based on their building attributes (characteristics).
The data product contains pre-calculated risk scores for earthquakes that are derived from simulated catastrophe event using probabilistic models. A risk score is a value between 1-10 that represents the projected risk to a location exposure.
This layer can be used to define hazard
jobs using the RL
engine. The overrideUserDef
and skipPrevHazard
parameters must be specified in the layerOptions
object.
Entitlements
Client must be assigned one of the following entitlements to use this API:
RI-EXPOSUREIQ
RI-RISKMODELER
RI-UNDERWRITEIQ