Skip to main content

Introduction | Climes API

Welcome to the Climes API Documentation.
Our APIs are RESTful, stateless and use a simple API Key based Authorization mechanism.

We have 4 Categories of APIs

  • Carbon Accounting
    • These are APIs build on top of well-researched and detailed methodologies that enable our partners to calculate the emissions from different types of activites at the level of granularity that they choose to calculate it at.
  • Cart Management
    • APIs to track the opt-in state of your users carts
  • Order Management
    • APIs through which orders for climes can be managed and tracked during and post checkout
  • User Experience
    • APIs to provide the UX that you want for your users by retreiving their impact and building innovative experiences by using our Climate Impact Project information within your platform

Walkthroughs​

To make life easier for our partners we've setup simple walkthroughs for 3 different scenarios :

  1. Standard Emissions based Climate Action
    • This is in the scenario where a standard emission value is calculated for you and your user to opt in to climes at checkout
  2. Dynamic Emissions based Climate Action
    • This is in the scenation where the carbon emissions associated with an order or an activity is calculated dynamically by calling our Carbon Accounting APIs before checkout and then the user opts in to climes.
  3. Only Emissions Calculation
    • In case you only want to calculate emissions based on information available to you

All the APIs are documented and listed in the sidebar but, we'd recommend going through the relevant walkthrough first.

To get access to our APIs please drop a mail to our API Growth Team