The Climate API returns location-based climate risk data for coordinates in the contiguous United States or Canada. The Climate widget requests this data from the Proximitii API; it does not call ClimateCheck directly.
Endpoint: https://api.proximitii.com/v1/climate/
Authenticate with your Proximitii Public-Key and Private-Key headers from your server. Keep your private key out of browser code. The ClimateCheck provider key is used only by the Proximitii API and is not part of a widget installation or client API request.
Displaying this API's data on a public page? Show the Powered by Proximitii logo directly below it. See API Attribution.
Request
GET https://api.proximitii.com/v1/climate/?lat=40.7788&lon=-73.9810&radius=500&munit=m&country=us
Public-Key: YOUR_PUBLIC_KEY
Private-Key: YOUR_PRIVATE_KEY| Parameter | Description | Default |
|---|---|---|
lat | Latitude, from -90 to 90 (required). | N/A |
lon | Longitude, from -180 to 180 (required). | N/A |
country | us or ca. | us |
radius | Positive search radius. | 50 |
munit | Radius unit: meters (m) or miles (mi). | m |
Response
A successful response contains climate fields in data and a status object. This abbreviated U.S. example is illustrative; available fields and values depend on the location.
{
"data": {
"heat_rating": 71,
"precip_rating": 97,
"heat_events_2050_rcp85": 30,
"precip_annual_2050_rcp85_in": 49.1
},
"status": { "code": "200", "message": "OK" }
}Common fields include:
| Category | Examples | What they describe |
|---|---|---|
| Risk ratings | heat_rating, precip_rating, drought_rating, fire_rating, flood_rating | Independent modeled risk ratings; see the rating guide below. |
| Heat and rain | heat_events_2050_rcp85, precip_annual_2050_rcp85_in | Projected hot days and annual rainfall. Canada uses _mm for rainfall and heat_threshold_c instead of heat_threshold_f. |
| Fire and flood | fire_chance_30yr, flood_chance_30yr, flood_expected_depth_30yr_in | Longer-term probabilities and expected flood depth. Canada reports depth with _cm. |
| Regional measures | drought_wassi_2050_rcp85 (U.S.), drought_frequency_2050_rcp85 (Canada), wind_rating (U.S.) | Drought measures differ by country; wind fields are available for U.S. locations. |
Format fractional probability fields as percentages when displaying them. Fields ending in _2050_rcp85 are modeled projections, not guaranteed future conditions. Check that a field is present before using it in your interface.
How to read the rating
1-20: Low; 21-40: Significant; 41-60: High; 61-80: Very High; 81-100: Extreme.
Each hazard is rated independently. A higher rating means greater modeled risk relative to the data provider's coverage area; it is not the percentage chance of an event. A rating of 1 does not mean no risk.