API Reference
Log In
API Reference

Fetch Carbon Estimate of a Transaction by Open Banking Category Types

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

Estimating the carbon footprint of a transaction based on Open Banking Category Types

Body Params
number
required

Price of purchase.

string
enum
required

Type of category.

Allowed:
categoryValue
array of strings
required

The name of the category used to calculate the co2 emission. We support all plaid categories and the new categorisation for personal_finance_category.

categoryValue*
string
required

ISO Currency Code of Purchase.

string
enum

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

string
enum

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

Allowed:
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

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 6 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago