Getting started with our API

See what you can do with ClimateKit, and how to get started quickly.

Authentication

All requests to the API needs to successfully authenticate or will be rejected. Authentication is performed with your unique API key via the authentication parameter, like this:

				
					"authentication": IXoe2rckfkWDTUn5YxgE6KllCbfLrEhp7crJ628uG4lVpBdGOq,
				
			

You can find, revoke and replace your API key from your dashboard.

Validate your API key

Pass your API key with the authentication parameter to check if your key is valid.

				
					POST https://app.climatekit.co/api/1.1/wf/validate
{
 "authentication": {TOKEN}
}
				
			

Plant trees

Pass your API key with the authentication parameter and specify how many trees you want to plant with the quantity parameter.

Optionally add a description for your own future reference with the description parameter.

				
					POST https://app.climatekit.co/api/1.1/wf/trees
{
 "authentication": {TOKEN},
 "description": earthday,
 "quantity": 1000
}
				
			

Offset carbon emissions

Pass your API key with the authentication parameter and specify how many kilograms (Kg) of CO2 you want to neutralize with the quantity parameter.

Optionally add a description for your own future reference with the description parameter.

				
					POST https://app.climatekit.co/api/1.1/wf/carbon
{
 "authentication": {TOKEN},
 "description": offset_new_customer,
 "quantity": 250
}
				
			

Offset % of purchase

Pass your API key with the authentication parameter. Specify the order value with the amount parameter and the percentage with the percentage parameter.

Optionally add a description for your own future reference with the description parameter.

				
					POST https://app.climatekit.co/api/1.1/wf/fractional
{
 "authentication": {TOKEN},
 "amount": 79,
 "percentage": 1,
  "description": order #1234
}
				
			

Calculate carbon emissions

Pass your API key with the authentication parameter. Specify what you want to measure with the activity parameter, including the relevant amount with the quantity parameter.

ClimateKit returns the estimated emissions in Kg CO2e, rounded up to the nearest kilogram.

				
					POST https://app.offsetta.com/api/1.1/wf/calculate
{
 "authentication": {TOKEN},
 "activity": ground_shipping,
 "quantity": 1234
}
				
			

Join the waitlist

Reserve your spot in line and we'll reach out with an invite as soon as possible.