Chart Insights API

post https://api.connect.earth/charts/pie

This endpoint allows you to support graphs and analytics of carbon emissions in your apps.

Body Params

Transaction object needed to provide a set of transactions and a geolocation

geo

string

required

Defaults to BE

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

userType

string

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

transactions

array of objects

required

Defaults to [object Object]

transactions*

categoryType

string

required

Category type used to estimate the emissions.

categoryValue

string

required

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

Price of purchase

transactionDate

date

Date of the transaction

group

string

required

Chart group or category of the transaction

mcc

string

deprecated

Merchant Category Code of Merchant.

Headers

x-api-key

string

required

Responses

Language

URL


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://api.connect.earth/charts/pie \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "geo": "BE",
8
  "transactions": [
9
    {
10
      "categoryType": "mcc",
11
      "categoryValue": "5411",
12
      "price": 20,
13
      "currencyISO": "USD",
14
      "group": "Travel and Holidays"
15
    }
16
  ]
17
}
18
'

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

application/json

200OK (A JSON object with graphs and analytics)

400Bad Request (Likely something wrong with the input)

401Unauthorised (API Key is wrong)

429Too Many Requests (API Quota has been exceeded)