API Reference

Overview

The goal of the Cooler API is to give you the ability to eliminate the carbon emissions you generate in the course of serving your customers by neutralizing them; you mark your transactions to be neutralized, and we purchase an emissions permits about equal to your emissions ion your behalf. To do that, you must know the carbon footprint of your transactions. You can calculate the carbon footprint of your goods and services as part of transactions individually in real time or as a batch. Ultimately the goal is to reduce power plant emissions by an amount equal to your periodic aggregated footprint. For example, if your aggregate carbon footprint last quarter was 1,000 tons of carbon, you can remove (or to use our term, neutralize) those emissions by using us to purchase emissions permits from regulated markets (read more about that here). To do that, you'd calculate your emissions using the Footprint endpoint, then mark the transactions that comprise the footprint to be neutralized using the Neutralize endpoint.

Footprint

The Footprint endpoint calculates and returns the carbon footprint(s) for one or more products (up to 1000 at a time), given a well-formed JSON request containing properties, as shown in the examples below. All footprint requests must include your API key from your Cooler account.

Request Parameters

KEY	TYPE	DESCRIPTION
price	number	price of the product
sku	string	code assigned by a retailer to the product
store	string	retailer, if applicable
title	string	generic name of the product
currency	string	USD only*
zip	string	postal code
isUsed	boolean	is the product used? defaults to false.

*other currencies planned for near future

Calculate footprint for a given product

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

Header parameters

Body

application/json

items*array of TransactionItemV2Dto (object)

array of transaction items to footprint

dateCreatedstring (date-time)

The timestamp we want to set this transaction to be, by default will be time.Now()

Response

200400401404500

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cooler.dev/v2/footprint/products', {
    method: 'POST',
    headers: {
      "COOLER-API-KEY": "cooler_test_84f6bb10-a377-4873-b54b-f36579326357",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "items": [
        {
          "productPrice": 500,
          "productName": "Samsung A7 Galaxy",
          "productDescription": "Samsung A7 Galaxy"
        }
      ]
    }),
});
const data = await response.json();

Transactions

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();

Mark the specified transactions for neutralization

POSThttps://api.cooler.dev/v1/neutralize/transactions

Header parameters

Response

200400401404500

OK

Request

JavaScriptCurlPython

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

Fetch aggregated transaction stats for account

This endpoint returns various Cooler account metrics to surface

GEThttps://api.cooler.dev/v1/counts

Query parameters

Header parameters

Response

200400401500

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cooler.dev/v1/counts?env=text', {
    method: 'GET',
    headers: {
      "COOLER-API-KEY": "cooler_test_84f6bb10-a377-4873-b54b-f36579326357"
    },
});
const data = await response.json();

Fetch transaction

GEThttps://api.cooler.dev/v1/transactions/{id}

Path parameters

id*string

Header parameters

Response

200400401500

OK

Request

JavaScriptCurlPython

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

Fetch a collection of transactions

GEThttps://api.cooler.dev/v1/transactions

Query parameters

Header parameters

Response

200400401500

OK

Request

JavaScriptCurlPython

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