Greenspark API

Introduction
How it works
SDKs

Overview

Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact

Impacts

Projects

Projects

Estimations

Estimations

Reporting

Reports

Email

Widget API

Localisation
Widgets

Account Management

Account
- Public Accountget

Greenspark API

Introduction
How it works
SDKs

Overview

Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact

Impacts

Projects

Projects

Estimations

Estimations

Reporting

Reports

Email

Widget API

Localisation
Widgets

Account Management

Account
- Public Accountget

Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Types

post https://api.getgreenspark.com/v1/estimations/transaction/category-type/bulk

Estimating the carbon footprint of multiple transactions based on Open Banking Category Types

URL Expired

The URL for this request expired after 30 days.

Body Params

geo

string

Indicates the specific country that should be used for the CO2 emissions factors.

userType

string

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

transactions

array of objects

required

Array of transactions.

transactions*

metadata

array of objects

In the metadata array you can store up to 10 key-value pairs. You can use them to associate arbitrary data with your estimation.

metadata

Responses

Response body

object

emissionsLevel

string

required

Either "category" or "merchant" depending on whether there is emissions data available on that merchant or only on the mcc category.

category merchant

name

string

required

In the case of "category" this is the mcc code string (Ex: Supermarkets), and if emissions_level is "merchant" it returns the name of the merchant you entered (ex: "Superstore"). Full list of merchant categories.

kgOfCO2Emissions

number

required

Estimated carbon footprint In Kg of CO2 equivalent.

mtOfCO2Emissions

number

required

Estimated carbon footprint In metric tons (mt) of CO2 equivalent.

similarTo

array of strings

required

Random list of relatable actions with similar footprint.

similarTo*

400

Bad request.

401

Provide your API key.

403

Please upgrade to a premium or enterprise plan.

404

Not found.

429

Too Many Requests

Updated 11 months ago

Fetch Carbon Estimate of a Transaction by Open Banking Category Types

Reports

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.getgreenspark.com/v1/estimations/transaction/category-type/bulk \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

Updated 11 months ago

Fetch Carbon Estimate of a Transaction by Open Banking Category Types

Reports

Did this page help you?

Greenspark API
Introduction
How it works
SDKs

Overview
Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact
Impacts
Fetch Impact Purchaseget
Fetch Impact Purchasesget
Create Impact in Batchpost
Create Tailored Impactpost
Create Impactpost

Projects
Projects
Fetch project by idget
Fetch projectsget
Fetch project categoriesget

Estimations
Estimations
Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Typespost
Fetch Carbon Estimate of a Transaction by Open Banking Category Typespost
Fetch Carbon Estimate of Multiple Transactions by MCCpost
Fetch Carbon Estimate of a Transaction by MCCpost

Reporting
Reports
Fetch Total Impacts Countget
Fetch Average Spend Per Impactget
Fetch Total Spend On Impactsget
Fetch Total Impact By Triggersget
Fetch Total Impact By Sourcesget
Fetch Impacts By Intervalget
Fetch Trees By Intervalget
Fetch Plastic By Intervalget
Fetch Carbon By Intervalget
Fetch Impact Amount By Type Per Trigger Reportget
Fetch Impact Amount By Type Per Source Reportget
Fetch Total Impact By Type Reportget
Fetch a Report Pageget
Fetch Raw Reportget
Fetch Raw Report v2get

Email
Email
Test Templatepost
Delete Templatedelete
Update Templateput
Add Templatepost
Fetch Templatesget
Fetch Templates Defaultsget
Delete Domaindelete
Verify Domainpost
Add Domainpost
Fetch Domainsget

Widget API
Localisation
Widgets
Full width banner v2post
Full width bannerpost
Top stats widget v2post
Top stats widgetpost
Cart widget v2post
Cart widgetpost
Per product widget v2post
Per product widgetpost
Tiered spend level widget v2post
Tiered spend level widgetpost
By percentage of revenue widget v2post
By percentage widget v2post
By percentage widgetpost
Per order widget v2post
Per order widgetpost
Spend level widget v2post
Spend level widgetpost

Account Management
Account
Public Accountget

Greenspark API
Introduction
How it works
SDKs

Overview
Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact
Impacts
Fetch Impact Purchaseget
Fetch Impact Purchasesget
Create Impact in Batchpost
Create Tailored Impactpost
Create Impactpost

Projects
Projects
Fetch project by idget
Fetch projectsget
Fetch project categoriesget

Estimations
Estimations
Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Typespost
Fetch Carbon Estimate of a Transaction by Open Banking Category Typespost
Fetch Carbon Estimate of Multiple Transactions by MCCpost
Fetch Carbon Estimate of a Transaction by MCCpost

Reporting
Reports
Fetch Total Impacts Countget
Fetch Average Spend Per Impactget
Fetch Total Spend On Impactsget
Fetch Total Impact By Triggersget
Fetch Total Impact By Sourcesget
Fetch Impacts By Intervalget
Fetch Trees By Intervalget
Fetch Plastic By Intervalget
Fetch Carbon By Intervalget
Fetch Impact Amount By Type Per Trigger Reportget
Fetch Impact Amount By Type Per Source Reportget
Fetch Total Impact By Type Reportget
Fetch a Report Pageget
Fetch Raw Reportget
Fetch Raw Report v2get

Email
Email
Test Templatepost
Delete Templatedelete
Update Templateput
Add Templatepost
Fetch Templatesget
Fetch Templates Defaultsget
Delete Domaindelete
Verify Domainpost
Add Domainpost
Fetch Domainsget

Widget API
Localisation
Widgets
Full width banner v2post
Full width bannerpost
Top stats widget v2post
Top stats widgetpost
Cart widget v2post
Cart widgetpost
Per product widget v2post
Per product widgetpost
Tiered spend level widget v2post
Tiered spend level widgetpost
By percentage of revenue widget v2post
By percentage widget v2post
By percentage widgetpost
Per order widget v2post
Per order widgetpost
Spend level widget v2post
Spend level widgetpost

Account Management
Account
Public Accountget

200The estimated carbon footprint has been successfully fetched.