Skip to content

Perils

Retrieve the list of available perils for your API key, separated by endpoint type.

Request

GET /v1/perils

Headers

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

Response

Success (200)

Field Type Description
daily list[Peril] Perils available for the Daily endpoint.
expanding list[Peril] Perils available for the Expanding endpoint.

Peril object

Field Type Description
name string Peril identifier used in requests.
default_unit string Default unit for thresholds.
description string Human-readable description.

Example

Example request

curl -X 'GET' \
  'https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/perils' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \

Example response

{
  "daily": [
    {
      "name": "Rain",
      "default_unit": "mm",
      "description": "Daily rainfall accumulation over selected hours. This is retrieved in increments of 1 mm from 0 mm up to 10 mm, and then increments of 5 mm up to the 99.9999th percentile."
    },
    {
      "name": "MaxWindGust",
      "default_unit": "mph",
      "description": "Maximum daily wind gust speed over selected hours. This is retrieved in increments of 5 mph up to the 99.9999th percentile."
    }
  ],
  "expanding": [
    {
      "name": "CumulativeSnowfall",
      "default_unit": "mm",
      "description": "Cumulative snowfall over expanding time windows (at most 7 days). This is retrieved in increments of 5 mm up to the 99.9999th percentile."
    }
  ]
}

Errors

Status Description
401 Missing or invalid API key.