Skip to content

Available perils

GET /v1/perils

Retrieve the list of perils available to your API key, separated by endpoint type. Use this to discover your key's permissions and to populate peril pickers in your own tooling.

Request

Header Required Value
X-API-Key REQUIRED Your API key 
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/perils"

    import requests

    url = "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/in-depth/batch/f9e8d7c6-b5a4-3210-fedc-ba0987654321"
    headers = {
        "Content-Type": "application/json",
        "Authorization": "Bearer YOUR_API_KEY"
    }

    response = requests.get(url, headers=headers)
    print(response.json())

Response: 200

Field Type Description
in_depth list[Peril] Perils usable with the /v1/in-depth endpoint

Each Peril object: name (identifier used in requests), default_unit (unit for thresholds), description (human-readable).

{
  "in_depth": [
    { "name": "Rain", "default_unit": "mm", "description": "Daily rainfall accumulation" },
    { "name": "MaxWindGust", "default_unit": "mph", "description": "Maximum daily wind gust speed" }
  ]
}

Errors

Status Meaning
401 Missing or invalid API key