Skip to main content
GET
What a unit of a commodity carries in carbon, effective-dated and with its source named — so a grid that decarbonises never restates a year already reported.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
commodity_id
string
commodity_name
string
unit_code
string
site_id
string
site_name
string
effective_from
string
effective_to
string
kg_co2e_per_unit
string
source
string
in_force
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

commodity_id
string<uuid>

Note: This is a Foreign Key to commodities.id.

commodity_name
string<character varying>
Maximum string length: 120
effective_from
string<date>
effective_to
string<date>
id
string<uuid>

Note: This is a Primary Key.

in_force
boolean<boolean>
kg_co2e_per_unit
number<numeric>
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

site_name
string<character varying>
Maximum string length: 200
source
string<character varying>
Maximum string length: 200
unit_code
string<character varying>
Maximum string length: 30