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 a variety of data products:

• geocode: A geocode job enriches a location exposure with geolocation data that precisely identifies the global coordinates of a site.
• hazard: A hazardjob 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 layer (data product) specified, the Geohaz API may require that different parameters and parameter values be specified in the request.

Operations

Layers

A layer (data product) is a tool that processes data and delivers actionable insights. Moody's data products deliver accurate assessment with minimal overhead and latency. Data products include geocoding operations, hazard lookups, risk scores, and loss cost lookups.

The table identifies required type and engine parameter values for each data product (name). If the name parameter is cs_risk_score, the engineType parameter must be RL and the type parameter mus be hazard.

Convection Storm Risk Score

The cs_risk_score option initiates a GEOHAZ job using 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 data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Distance to Fault

The distance_to_fault option initiates a GEOHAZ job using the Distance to Fault data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Distance to Fire Station

The distance_to_fire_station option initiates a GEOHAZ job using the Distance to Fire Station data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Distance to Inner Coast

The distance_to_inner_coast option initiates a GEOHAZ job using the Distance to Inner Coast data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Earthquake

The earthquake option initiates a GEOHAZ job using the Earthquake data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Earthquake Risk Score

The eq_risk_score option initiates a GEOHAZ job using 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 data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

ExposureDatabase (ESDB) Building Atttributes

The esdb_building_attributes option initiates a GEOHAZ job using the ExposureDatabase (ESDB) data product.

The ExposureSource Database (ESDB) compiles comprehensive building attribute data based on a combination of analytics, validation heuristics, and industry exposure data. ESDB data products support a wide variety of applications including the validation and enrichment of location exposure data. ESDB data products are available for locations in the United States only. Using the ESDB, you can both assess and enhance the quality of your current exposure data and provide a solid foundation where no data exists.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

FEMA Flood Zone

FEMA Flood Zones, published by the Federal Emergency Management Authority (FEMA), are the primary method that emergency planners and some insurers gauge flood risk. RMS has digitized these maps to enable side-by-side comparison of their outputs with much higher resolution flood analytics. This will enable insurers to identify the best business out of the National Flood Insurance Plan (NFIP).

This data product 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 fl_depth option initiates a GEOHAZ job using the Flood Depth data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Flood Hazard

The fl_hazard option initiates a GEOHAZ job using the Flood Hazard data product.

This data product 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 Score

The fl_risk_score option initiates a GEOHAZ job using 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 data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Global Flood Depth

The global_fl_depth option initiates a GEOHAZ job using the Global Flood Depth data product.

Earthquake HD

The hd_earthquake option initiates a GEOHAZ job using the Earthquake HD data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Modified Mercalli Intensity (MMI)

The mmi option initiates a GEOHAZ job using 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 data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Subsidence

The subsidence option initiates a GEOHAZ job using the Subsidence data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Surge

The surge option initiates a GEOHAZ job using the Surge data product.

This data product 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 Score

The tr_risk_score option initiates a GEOHAZ job using 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 data product 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 wf_model_hazard option initiates a GEOHAZ job using the Wildfire Model Hazard data product.

This data product 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 Score

The wf_risk_score option initiates a GEOHAZ job using 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 data product 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 wf_supplemental_hazard option initiates a GEOHAZ job using the Wildfire Supplemental Hazard data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Windstorm

The windstorm option initiates a GEOHAZ job using the Windstorm data product.

This data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Windstorm Hazard

The ws_model_hazard option initiates a GEOHAZ job using the Windstorm Hazard data product.

This data product 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 Score

The ws_risk_score option initiates a GEOHAZ job using 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 data product can be used to define hazard jobs using the RL engine. The overrideUserDef and skipPrevHazard parameters must be specified in the layerOptions object.

Windstorm

The ws_windpool_zone option initiates a GEOHAZ job using the Windstorm data product.

The data product enriches geocoded locations with site hazard values that characterize the vulnerability of that location.

This data product 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 Score

The wt_risk_score option initiates a GEOHAZ job using 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 data product 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