Data APIs
Overview
The AlphaGeo API suite offers powerful tools to access climate risk scoring data for global locations programmatically. With these APIs, you can seamlessly integrate climate risk information into your applications, enabling data-driven decision-making and risk assessment.
The AlphaGeo APIs are structured into three primary services: Scores, Physical Risk, and Resilience-adjusted Risk. Each service provides distinct capabilities tailored to address specific climate risk assessment needs.
Access Tokens
To access AlphaGeo APIs, you need to obtain an access token. Access tokens are unique identifiers that grant you permission to use our services. Follow these steps to obtain and use your access token:
Sign Up or Log In
If you haven't already, sign up for an AlphaGeo account. If you already have an account, log in to the AlphaGeo dashboard. (You will need an Enterprise Subscription to access this feature!)
Ensure you have adequate in-app permissions
You can easily check this in your account. Once logged in, navigate to the upper right-hand corner of the dashboard.
Get Access Token
Copy the token found upon clicking "API" in the upper-right section of your account. Treat this token as sensitive information and keep it secure.
Use Access Token in Requests
In your API requests, include the access token in the headers. Add an Authorization header with the value "[your_access_token]". Replace "[your_access_token]" with the actual access token you obtained.
Refresh Token (Optional)
we recommend that clients routinely "refresh" their token as an added security measure.
Rate Limits
Every interaction with AlphaGeo APIs is subject to rate limits, which restrict the number of requests allowed per endpoint. These limits are in place to ensure fair usage and maintain system performance. Here's what you need to know about rate limits:
What Happens If You Exceed the Limit?
If you exceed the rate limit, you'll receive an HTTP 429 Too Many Requests response from the API. This response indicates that your request cannot be processed immediately due to exceeding the allowed rate.
| API | Default requests per minute |
|---|---|
Scores | 60 requests per minute |
Physical Risk | 60 requests per minute |
Resilience-adjusted Risk | 60 requests per minute |
Analytics | 60 requests per minute |
Need a Higher Limit?
If your application requires a higher rate limit than the default – don't worry! Simply reach out to our dedicated support team, and we'll be happy to assist you.
Last updated
