Quick Start

The Cooler API: Measuring and Neutralizing Carbon Footprints

Our goal is to directly reduce carbon emissions by providing a seamless process for measuring and neutralizing the carbon footprints of your product sales transactions through our API. Follow these steps to achieve this goal:

1. Gather Data: Collect your product sales transaction data to post to our footprint API. We're also working on integrating directly with a variety of systems like Shopify, BigCommerce, and Quickbooks.

2. Measure Carbon Footprint: Use Cooler's calculator, which combines an Economic-Input-Output (EIO) model with a Life-Cycle-Assessment (LCA) model, to calculate the carbon footprint associated with each transaction. Learn more about our methodology here.

3. Report Carbon Footprint: Generate reports that detail the carbon footprints of your transactions.

4. Neutralize Carbon Footprint: Mark transactions for neutralization—up to 100% of your transactions can be marked to move your closer to true carbon neutrality. The total footprints of marked transactions are calculated quarterly, and the necessary funds to neutralize them are set aside in a holding account. At the cap-and-trade auction, we use these funds to purchase emissions permits and retire them, ensuring that no polluter can use them to emit carbon.

This process ensures that your business actively contributes to reducing overall carbon emissions by neutralizing the carbon impact of your transactions.

Get your API keys

Your API requests are authenticated using API keys. Any request that does not include an API key will return an error. Sign up for Cooler today to get started and navigate to the Accounts tab to retrieve your test and production API keys.

Note: We provide a rate-limited API test key in our examples so you can explore the API without an account, but encourage you to sign up for a free Cooler account.

Make your first footprint request

Send an authenticated request to the products footprint endpoint to calculate the carbon footprint of your product or products in a transaction. You can footprint up to 1000 products at a time.

Calculate footprint for a given product

POSThttps://api.cooler.dev/v1/footprint/products

Header parameters

Body

application/json

automaticallyNeutralizeboolean

on successful footprint the transaction will be marked for neutralization

items*array of TransactionItemV1Dto (object)

array of transaction items to footprint

Response

200400401404500

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cooler.dev/v1/footprint/products', {
    method: 'POST',
    headers: {
      "COOLER-API-KEY": "cooler_test_84f6bb10-a377-4873-b54b-f36579326357",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "items": [
        {
          "price": 99,
          "sku": "de6879ee"
        }
      ]
    }),
});
const data = await response.json();

Take a look at how you might call this method via curl:

curl

curl -X 'POST' \
  'http://api.cooler.dev/v1/footprint/products' \
  -H 'accept: */*' \
  -H 'COOLER-API-KEY: YOUR_COOLER_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "automaticallyNeutralize": false,
  "processSyncronously": true,
  "items": [
    {
      "price": 999,
      "sku": "123",
      "currency": "USD",
      "manufacturer": "Apple",
      "title": "iPhone X",
      "category": "consumer electronics",
      "zip": "02119",
      "isUsed": false
    }
  ],
  "currency": "USD"
}'

Make your first neutralization request

Mark this transaction for neutralization

POSThttps://api.cooler.dev/v1/neutralize/transactions/{id}

Path parameters

id*string

the transaction to neutralize

Header parameters

Response

200400401404500

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cooler.dev/v1/neutralize/transactions/{id}', {
    method: 'POST',
    headers: {
      "COOLER-API-KEY": "cooler_test_84f6bb10-a377-4873-b54b-f36579326357"
    },
});
const data = await response.json();

Take a look at how you might call this method via curl:

curl

curl -X 'POST' \
  'http://api.cooler.dev/v1/neutralize/transactions/8a3c06b4-0840-46f2-9634-557ce041037a' \
  -H 'accept: */*' \
  -H 'COOLER-API-KEY: YOUR_COOLER_API_KEY'
}'