List emission factors
HTTPGET
to /v1/emission-factors
Query parameters
limitstring
Pattern: ^\d+$
Maximum number of resources to return, between 1 and 100.
afterstring
A cursor for use in pagination.
The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.
namestring
Search for emission factors (case insensitive). A combination of semantic and keyword search is used to provide the most relevant results.
sourcestring
Filter emission factors based on source. When omitted, all sources are returned.
publication_yearstring
Filter emission factors based on the publication year.
regionstring
Filter emission factors based on region (case insensitive). When omitted, all regions are returned.
The region_fallback
parameter controls how region
is interpreted, by default
an exact match is required.
Countries are included in regions but there are also broader geographic regions like Europe or Asia.
region_fallbackstring
Controls how region
is interpreted and if region fallback is performed.
Region fallback is looking up emission factors for regions related to the specified regions.
never
(the default) means no region fallback is performed and only emission factors that match the specified region(s) are returned.always
means the emission factors for related regions are unconditionally included in the results.
never
always
unitstring
Filter emission factors based on the logical unit. When omitted, all units are returned.
currency
distance
item
time
area
Response
has_morebooleanrequired
Whether or not there are more elements available after this set.
If false, this set comprises the end of the array.
Part of a paginated response.
next_cursorstringrequirednullable
The cursor value to be used as the after parameter for fetching the next page of results.
null
if has_more
is false
.
dataarrayrequired
An array of Emission Factor objects, ordered by best match.
Part of a paginated response.
object
An emission factors is a coefficient representing the amount of emissions per unit of activity, eg 0.354kgCO₂/USD.
The source
property describes what database the emission factor has been ingested from.
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epa
exiobase
ecoinvent
beis
lune
source_versionstringrequired
Source version of the emission factor.
publication_yearnumberrequired
Publication year of the emission factor
numerator_unitstringrequired
Unit, t
for tonne, kg
for kilogram, g
for gram
g
kg
t
denominator_unitoneOfrequiredCurrency code
Currency code
Denominator unit of the emission factor
created_atstring (date-time)required
Date of creation of the emission factor
regionstringrequired
The name of the region that the emission factor covers.
categorystringrequirednullable
A category that describes the emission factor.
Errors
This API operation can return the following errors:400
api_version_invalid
400
bundle_selection_ratios_invalid
400
bundle_selection_bundle_invalid
400
order_value_invalid
400
bundle_id_invalid
400
id_invalid
400
distance_invalid
400
test_account_name_update_disallowed
400
bundle_selection_ratios_invalid_format
400
address_not_found
List all emission factor regions
HTTPGET
to /v1/emission-factors/regions
Response
array
An array of regions.
string
An array of regions.
The name of the country or region of the emission factor.
Errors
This API operation can return the following errors:400
api_version_invalid
400
bundle_selection_ratios_invalid
400
bundle_selection_bundle_invalid
400
order_value_invalid
400
bundle_id_invalid
400
id_invalid
400
distance_invalid
400
test_account_name_update_disallowed
400
bundle_selection_ratios_invalid_format
400
address_not_found