Carbon Estimate of a Transaction.

post https://api.connect.earth/transaction

This endpoint estimates the CO2e of a transaction according to category-level emissions factors.

Body Params

Transaction object needed to provide CO2e estimate

categoryType

string

required

Defaults to mcc

Category type used to estimate the emissions.

categoryValue

string

required

Defaults to 5411

Category value used to estimate the emissions.

currencyISO

string

required

ISO Currency Code of Purchase (see all currencies supported). You can input the string of stringified number code (ex: "USD" or "840").

price

float

required

Defaults to 20.22

Price of purchase

transactionId

string

Unique ID of the transaction

transactionDate

date

Date of the transaction

userType

string

Indicates whether the API should use emissions factors for people or businesses. Either: "PERSONAL"(default), "BUSINESS")

geo

string

required

Defaults to BE

Indicates the specific country that should be used for the CO2 emissions factors (see all countries supported).

user_habits

object

Info about user specified consumption preferences, used to adjust emissions estimates for relevant transactions.

ghgpBreakdown

boolean

Whether to return the GHGP breakdown of the emissions or not. (Note: This is only available for the ces_v2 category type.)

Show Deprecated

Headers

x-api-key

string

required

Responses

Language

URL


xxxxxxxxxx
17
1
curl --request POST \
2
     --url https://api.connect.earth/transaction \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "categoryType": "mcc",
8
  "categoryValue": "5411",
9
  "currencyISO": "USD",
10
  "price": 20.22,
11
  "geo": "BE",
12
  "user_habits": {
13
    "num_people_purchasing_for": 1,
14
    "renewable_electricity": false
15
  }
16
}
17
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK (A JSON object with CO2e estimate data)

400Bad Request (Likely something wrong with the input)

401Unauthorised (API Key is wrong)

429Too Many Requests (API Quota has been exceeded)