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

Example request

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.example.com/v1/perils"

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 response

{
  "daily": [
    {
      "name": "Rain",
      "default_unit": "mm",
      "description": "Daily rainfall accumulation over selected hours."
    },
    {
      "name": "MaxWindGust",
      "default_unit": "mph",
      "description": "Maximum daily wind gust speed over selected hours."
    }
  ],
  "expanding": [
    {
      "name": "CumulativeRain",
      "default_unit": "mm",
      "description": "Cumulative rainfall over expanding time windows."
    }
  ]
}

Errors

Status	Description
401	Missing or invalid API key.