API Reference

Multiple Transactions Estimate (Bulk API)

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

This endpoint estimates the CO2e of up to 1000 transactions according to category-level emissions factors.

Body Params

Object with transaction array needed to provide CO2e estimates. Note that geo and userType can be defined at the root level for all transactions or to individual transactions. If they are defined at the transaction level then this will take precendence over the root level.

string
enum
Defaults to BE

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

string
enum

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

Allowed:
transactions
array
required
Defaults to [object Object]

Array of transactions

transactions*
string
required
Defaults to mcc

Category type used to estimate the emissions.

string
required
Defaults to 5411

Category value used to estimate the emissions.

string
enum
required

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

float
required
Defaults to 20.22

Price of purchase

string

Unique ID of the transaction

date

Date of the transaction

string
enum

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

Allowed:
string
enum
Defaults to BE

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

string
deprecated

Merchant Category Code of Merchant.

user_habits
object

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

boolean

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

Headers
string
required
Responses

Updated over 1 year ago

What’s Next
Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago 
What’s Next