Lite score

GET /v1/lite

Give it a location and nothing else. There is no peril list to build: every peril available on your key runs automatically in one call, including all the cat perils, and each comes back as a return period in years against fixed severity thresholds. Use the in-depth endpoint when you want to choose specific perils and receive the full distribution.

Query parameters

Request and Response

# One location in, a return period for every cat peril out
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/lite?latitude=26.142&longitude=-81.7948"

import httpx
headers = {"X-API-Key": "YOUR_API_KEY"}
r = httpx.get(
    "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/lite",
    params={"latitude": 26.142, "longitude": -81.7948},
    headers=headers,
)

from bev_cera import Client

with Client() as client:
    score = client.lite.score(latitude=51.5, longitude=-0.1)
    print(score.scores.root)

Response

# score = return period in years at the fixed severity threshold
{
  "lat": 26.142,
  "lon": -81.7948,
  "scores": {
    "TropicalCyclone": { "score": 20,  "band": "Severe" },
    "Wildfire":        { "score": 83,  "band": "Low" },
    "Earthquake":      { "score": 333, "band": "Negligible" },
    "FloodLivePlus":   { "score": 56,  "band": "Low" },
    "Hail":            { "score": 2,   "band": "Extreme" }
  }
}

Scores and bands

• score: the return period, in years, of the peril at its fixed severity threshold.
• band: a risk descriptor derived from the return period, per the table below.

Risk descriptor bands

Return-period severity thresholds

The score is the return period of the peril at these fixed severities:

Errors