Usage
Our APIs provide weather and natural catastrophe (NatCat) risk assessment through probabilistic models covering a wide range of natural perils.
The API offers two main modes of weather and NatCat risk analysis:
| Mode | Endpoint | Description |
|---|---|---|
| In-Depth | /v1/in-depth/daily |
Full probabilistic model with daily granularity |
| In-Depth | /v1/in-depth/expanding |
Expanding time-window analysis for cumulative perils |
| In-Depth | /v1/in-depth/batch |
Asynchronous batch processing for large schedules |
| Lite | /v1/lite |
Globally Relative or Return period-based risk scores across all available perils for a single location. Return period-based risk scores are calculated using pre-determined severity thresholds |
We then also offer user info endpoints for your API key
| Mode | Endpoint | Description |
|---|---|---|
| Utility | /v1/perils |
List available perils for your API key |
Quick start
All requests require an API key passed via the X-API-Key header.
curl -H "X-API-Key: YOUR_API_KEY" \
"https://api.example.com/v1/perils"
See Authentication for details.
Base URL
https://api.example.com
Note
Replace api.example.com with the actual base URL provided to you.