Geohaz API Overview

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: A geocode operation enriches exposures with geolocation data that precisely identifies the global coordinates of a site.
  • hazard: A hazard 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

OperationMethodPathDescription
Search Geohaz JobGET/platform/geohaz/v1/jobsReturns list of GEOHAZ jobs.
Get Geohaz JobGET/platform/geohaz/v1/jobs/jobIdPolls GEOHAZ job.
Create Geohaz JobPOST/platform/geohaz/v1/jobsInitiates GEOHAZ job.
Update Geohaz JobPATCH/platform/geohaz/v1/jobs/jobIdUpdates 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:

nameengineTypeversion
geocodeRL18.0
geocodeHD18.1
geocodeRL18.1
geocodeHD21.0
geocodeRL21.0
geocodeHD22.0
geocodeRL22.0
geocodeRL or HD23.0
geocodeRL or HD24.0
geocodeRL or HD25.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.

geoLicenseTypeDescription
0If 0, supports DLM match levels, i.e. resolution levels appropriate for DLM modelling. Recommended if engineType is RL.
1If 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:

VersionLayernameengineTypeversion
1.0Default: Floodfl_hazardHD1.0
1.0Wildfirewf_model_hazardHD1.0
1.0Surge/Flood Elevation (US Only)surgeHD18.1
1.1Default: Floodfl_hazard HD1.1
1.1Surge/Flood Elevation (US Only)surgeHD21.0
1.2Default: Floodfl_hazard HD1.2
1.2Surge/Flood Elevation (US Only)surgeHD21.0
1.3Default: Floodfl_hazardHD1.3
1.3Surge/Flood Elevation (US Only)surgeHD21.0
2.0Earthquakehd_earthquakeHD2.0
2.0Wildfirewf_model_hazardHD2.0
3.0Earthquakehd_earthquakeHD3.0
18.0EarthquakeearthquakeRL18.0
18.0WindstormwindstormRL18.0
18.1EarthquakeearthquakeRL18.1
18.1WindstormwindstormRL18.1
21.0EarthquakeearthquakeRL21.0
21.0WindstormwindstormRL21.0
22.0EarthquakeearthquakeRL22.0
22.0WindstormwindstormRL22.0
23.0EarthquakeearthquakeRL23.0
23.0WindstormwindstormRL23.0
24.0EarthquakeearthquakeRL24.0
24.0WindstormwindstormRL24.0
25.0Earthquakeearthquake RL25.0
25.0Windstormwindstorm RL25.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:

VersionOptionnameengineTypeversion
LatestEarthquake: Risk Scoreseq_risk_scoreHDlatest
LatestEarthquake: Distance to Faultdistance_to_faultHDlatest
LatestEarthquake: MMImmiHDlatest
LatestEarthquake: SubsidencesubsidenceHDlatest
LatestWindstorm: Risk Scoresws_risk_scoreHDlatest
LatestWindstorm: Windpool Zonews_windpool_zoneHDlatest
LatestWindstorm: Distance to Inner Coastdistance_to_inner_coastHDlatest
LatestWindstorm: Model Hazardws_model_hazardHDlatest
LatestWildfire: Risk Scoreswf_risk_scoreHDlatest
LatestWildfire: Model Hazardwf_model_hazardHDlatest
LatestWildfire: Supplemental Hazardwf_supplemental_hazardHDlatest
LatestFlood: Risk Scoresfl_risk_scoreHDlatest
LatestFlood: Depthfl_depthHDlatest
LatestFlood: Global Depthglobal_fl_depthHDlatest
LatestFloodfl_hazardHDlatest
LatestConvective Storm: Risk Scorescs_risk_scoreHDlatest
LatestWinterstorm: Risk Scoreswt_risk_scoreHDlatest
LatestTerrorism: Risk Scorestr_risk_scoreHDlatest

Entitlements

Client must be assigned one of the following entitlements to use this API:

  • RI-EXPOSUREIQ
  • RI-RISKMODELER
  • RI-UNDERWRITEIQ