Skip to main content

General Guidelines

Erguvan API (Application Programming Interface) offers you a way to integrate carbon footprint estimation and offsetting functionalities into your own application. Before starting to use the API, please fill in your company name and set your account currency in the settings page. These settings cannot be changed after you start using the estimation/order endpoints, so please choose carefully.

Our API offers you 3 main ways of usage: Estimations, Footprinting, and Orders.

Estimations​

When you use the API to make an estimation, the API returns the carbon footprint of an activity. You can use this information in any way you want in your application, e.g., to inform your customers or to create marketing campaigns around sustainability.

Footprinting​

When you send a POST request for an estimation, you can also send isForActualEvent: true in your request. These estimations are used to track actual events that have occurred, whether you are offsetting them or not. You can use this information to track your carbon footprint over time.

Orders​

Orders are used to create an order for carbon credits. When you place an order, we will reserve credits from the Erguvan Portfolio for you and add your order to the invoice to be charged at the end of your billing period. You will be able to access carbon credit retirement certificates when you pay your invoice.