Just five steps!
Step 1: Ensure you have adequate in-app permissions
You can easily check this in your designated microsite. Once logged in, navigate to the upper right-hand corner of the page.
Note: Not seeing what you're looking for? Contact support.
Step 2: Navigate to Designated API Documentation Page
Copy & paste the following link into your browser: https://app.climatealpha.ai/api/documentation
Quick Tip: Unfamiliar with this proxy? Check out our article "Why Swagger?"
Step 3: Enter Your Token, i.e., Authorization Key
Copy the token found upon clicking "API" in the upper-right section of your microsite:
Note: The "download" icon only appears when you're in Data Manager.
Step 4: Satisfy the Required Parameters
Similar to when uploading your data via CSV or XLS file format, there are certain data fields which cannot be omitted (indicated by a red asterisk followed by "required"):
Step 5: Execute
Click "Execute" located at the bottom of the product (Climate Price, Resilience Index) section you're querying:
Warning: When querying the Climate Price dataset, clients are only able to call from what has uploaded to the Data Room within their designated microsite.
While strongly discouraged, Climate Alpha is not responsible for the sharing of personalized API tokens (we recommend that clients routinely "refresh" their token as an added security measure).
Please monitor/ govern access to sensitive property information at your own discretion.