Skip to content

Lite Score

A synchronous endpoint that provides a rapid risk assessment for a single location across all available perils. Results can be returned in two forms: as a return period derived from a pre-determined severity threshold applied consistently for each peril, or as a globally relative score that compares every land-based 0.1° grid cell against all others to express relative risk. Each peril returns a numeric score and a corresponding risk band, offering a standardised, lightweight alternative to the In-Depth endpoints suitable for quick triage and portfolio screening.

Request

GET /v1/lite

Headers

Header Required Description
X-API-Key Yes Your API key

Query parameters

Parameter Type Required Default Description
location string Conditional Location name, e.g. "London UK". Required if latitude/longitude not provided.
latitude float Conditional Latitude. Required with longitude if location not provided.
longitude float Conditional Longitude. Required with latitude if location not provided.
flood_plus boolean No false Enable the FATHOM combined flood model (FloodLivePlus), which incorporates pluvial, fluvial, and coastal flood hazard. See Perils Reference for details.
tag string No null Label for the risk.
calculation_method string No globally_relative Selects the scoring method: either return_period or globally_relative.

Example request

By location:

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.example.com/v1/lite?location=London%20UK"

By coordinates:

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.example.com/v1/lite?latitude=51.5074&longitude=-0.1278"

By location:

import httpx

headers = {"X-API-Key": "YOUR_API_KEY"}
response = httpx.get(
    "https://api.example.com/v1/lite?location=London%20UK",
    headers=headers,
)

By coordinates:

import httpx

headers = {"X-API-Key": "YOUR_API_KEY"}
response = httpx.get(
    "https://api.example.com/v1/lite?latitude=51.5074&longitude=-0.1278",
    headers=headers,
)

Note

Replace api.example.com with the actual base URL provided to you.

Response

Success (200)

Field Type Description
lat float Resolved latitude.
lon float Resolved longitude.
scores object Map of peril name to score object.

Note

The Lite endpoint returns the abbreviated field names lat and lon instead of latitude and longitude.

Score object

Field Type Description
score integer Numeric risk score.
band string Risk band label (e.g. "Low", "Moderate", "High").

Example response

{
  "lat": 51.5074,
  "lon": -0.1278,
  "scores": {
    "Rain": { "score": 3, "band": "Low" },
    "MaxWindGust": { "score": 5, "band": "Moderate" },
    "Lightning": { "score": 2, "band": "Low" },
    "Earthquake": { "score": 1, "band": "Low" },
    "Flood": { "score": 4, "band": "Moderate" }
  }
}

Note

Lite mode requires specific API key permissions. Contact your account manager if you receive a 403 error.

Return period severity thresholds

When using the return-period method, results are expressed as the return period of a pre-determined severity threshold, applied consistently for each peril. The thresholds are listed below.

Peril Threshold Description
Earthquake MMI5 Return period of a Modified Mercalli Intensity ≥ 5.
USTornado EF2 Return period of an Enhanced Fujita Scale ≥ 2 tornado. Available in the US only.
TropicalCyclone CAT3 Return period of a Saffir–Simpson Category ≥ 3 cyclone.
Wildfire Severe Return period of a wildfire exceeding 5 hectares in area.
Flood 1m Return period of a 1 m flood from the GloFAS flood model.
FloodLivePlus 1m Return period of a 1 m flood from the FATHOM combined flood model.

Errors

Status Description
401 Missing or invalid API key.
403 API key not authorised for lite mode.
422 Missing location — provide either location or both latitude and longitude.