Search
GET Allows you to determine what emission factors are available to be used in your estimates.
You can search for free-text queries with the query parameter, or filter by parameters such as category, source, region, year calculation_method,
source_lca_activity or id.
If you are using the query parameter, the results will be returned in order of how well they match your free-text query.
This endpoint is paginated, and will return current_page and last_page so you can determine which page you are on.
You switch pages by using the page query parameter.
https://beta4.api.climatiq.io/searchRequest
| Attribute | Required | Default |
|---|---|---|
| data_version string The required Data Version string for this request. | required | |
| query string A free-text query that will match ids, names, descriptions, etc. of emission factors. This uses fuzzy matching, so your query does not need to be precise. Spaces need to be encoded as + or %20 | optional | |
| activity_id string Filter by the id of a specific activity. Multiple emission factors might share the same activity. You may specify an asterisk ( *) at the end of the activity id to act as a wildcard character, matching any ids that begin with the string before the asterisk. | optional | |
| category string Filters by emission factor category | optional | |
| sector string Filters by emission factor sector | optional | |
| source string Filters emission factors by data source | optional | |
| source_dataset string Filters emission factors by a given dataset from a source | optional | |
| year number Filters emission factors by the year in which the emission factor is considered most relevant, according to the source. | optional | |
| region string Filters emission factors by geographic region to which it applies. You may specify an asterisk ( *) at the end of the region to act as a wildcard character, matching any regions, such as sub-regions, that begin with the string before the asterisk. | optional | |
| unit_type string Filters emission factors by what unit (such as money, energy or volume) the factor accepts. | optional | |
| source_lca_activity string The Life Cycle Assessment (LCA) activity with which this factor is associated. | optional | |
| calculation_method string The calculation method that is used to calculate the emission factor. Can be either ar4, ar5 or ar6. Not providing a value means that this defaults to the latest calculation methodology the source supports. Learn more about calculation methods here. | optional | |
| allowed_data_quality_flags [string] A list of data quality flags that you are willing to allow for this query. You can provide a comma-separated list of data quality flags you want to allow, or the value none if you only want emission factors without detected data quality issues. See the guide on data quality flags for more information. | optional | View defaults |
| access_type string Filters by the access type of the emission factors. Allowed values are public, private and premium | optional | |
| page number Which page of results to retrieve. | optional | 1 |
| results_per_page number How many results to return per page. Max is 100. | optional | 20 |
curl --request GET \ --url 'https://beta4.api.climatiq.io/search?query=light+duty+trucks&data_version=^3&year=2021&results_per_page=1' \ --header 'Authorization: Bearer API_KEY' \Response
The response includes a paginated list of emission factors filtered by the request parameters above.
| Attribute |
|---|
| results array A list of emission factors for this page. See below. |
| current_page number The current page you have retrieved |
| last_page number The last page that there are results for. |
| total_results number How many results there are in total across all pages. |
| possible_filters object A list of potential filters you can use to further narrow down your query. See below. |
results
Every emission factor returned in the list of results is formed by the following properties:
| Attribute |
|---|
| id string The unique ID describing this particular emission factor. |
| activity_id string The ID describing the activity that this emission factor applies to. Multiple emission factors can share the same activity_id, e.g. if they are from a different source or apply to a different region. |
| access_type string Whether or not the data is publicly available or private to your project. Can be either private or public. Public emission factors are available to all, while private emission factors are only accessible to you. |
| name string Emission factor name. |
| category string Emission factor category. |
| sector string Emission factor sector. |
| source string Emission factor publisher. |
| source_link string Link to emission factor publisher. |
| uncertainty number or null Emission factor uncertainty factor (%). |
| year number The year in which the emission factor is considered most relevant, according to the source. |
| year_released number The year in which the emission factor was released by the source. |
| region string Geographic region to which the emission factor applies (UN/LOCODE (opens in a new tab)). |
| region_name string Geographic region to which the emission factor applies (in English). |
| description string Emission factor description. |
| unit_type array A list of Unit types that this emission factor accepts. |
| unit string The unit in which the factor field is expressed. |
| source_lca_activity string Which LCA activity the emission factor corresponds to. Read more about life cycle assessments here. |
| supported_calculation_methods array of strings The methods of CO2e calculation supported for this emission factor |
| factor number CO2e emission factor value, expressed in kgCO2e emitted per unit of activity provided in the unit field |
factor_calculation_method ar4, ar5 or ar6 Indicates which conversion values were used (IPCC 4th or 5th Assessment Report) to generate the returned CO2e emission factor |
factor_calculation_origin climatiq or source Indicates whether the CO2e emission factor provided in this response was provided by the source or calculated by Climatiq |
| constituent_gases constituent gases Indicates which gases the CO2e emission factor is composed of. |
{ "current_page": 1, "last_page": 3, "total_results": 3, "results": [ { "activity_id": "fuel-type_diesel-fuel_use_diesel_light_duty_trucks", "id": "cc614c7b-01cd-491b-b12a-2b468c31657d", "name": "Diesel fuel - diesel light-duty trucks", "category": "Fuel", "sector": "Energy", "source": "GHG Protocol", "source_link": "https://ghgprotocol.org/ghg-emissions-calculation-tool", "source_dataset": "GHG Emissions Calculation Tool", "uncertainty": null, "year": 2021, "year_released": 2021, "region": "US", "region_name": "United States", "description": "Emission intensity of mobile combustion of fuel. Includes fuel consumption by vehicles that are owned or leased by the company. The primary source is EPA Emission Factors for Greenhouse Gas Inventories - March 9 2018 - WRI - GHG Protocol - Emission Factors from Cross-Sector Tools - April 2014. NOTE: This dataset has been deprecated by the source and will be removed soon.", "unit_type": "Volume", "unit": "kg/gal (US)", "source_lca_activity": "fuel_combustion", "data_quality_flags": [ "notable_methodological_variance" ], "access_type": "public", "supported_calculation_methods": [ "ar4", "ar5" ], "factor": 10.2168931, "factor_calculation_method": "ar5", "factor_calculation_origin": "source", "constituent_gases": { "co2e_total": 10.2168931, "co2e_other": null, "co2": 10.21, "ch4": 0.0000162, "n2o": 0.0000243 } } ], "possible_filters": { "year": [ 2021 ], "source": [ { "source": "EPA", "datasets": [ "GHG Emission Factors Hub" ] }, { "source": "GHG Protocol", "datasets": [ "GHG Emissions Calculation Tool" ] } ], "region": [ { "id": "US", "name": "United States" } ], "category": [ "Fuel", "Vehicles" ], "sector": [ "Energy", "Transport" ], "unit_type": [ "Distance", "Volume" ], "source_lca_activity": [ "fuel_combustion", "use_phase" ], "access_type": [ "public" ], "data_quality_flags": [ "notable_methodological_variance" ] }}possible_filters
The field possible_filters includes aggregated metadata about the results of your search request, to help you to choose further filters which would narrow down your results.
Most of the fields (year, category, sector, unit_type, source_lca_activity, access_type) contain a list enumerating each of the values present for the given field in the response. The values can be used verbatim in those fields of the search request to narrow down the results. If there is only one value, all results have the same value for this field.
The values of region contain a JSON object, the id field is the ISO 3166-1 alpha-2 code (opens in a new tab) for the country and can be used as the value for further filtering, the name is provided for the convenience of interactive apps to show the full name of the country.
The source contain a JSON object, the source field inside it is the source name, corresponding to the source for an emission factor. The datasets field is what datasets that belong to this particular source, is a valid source_dataset filter for this query.
data_quality_flags is named differently from its search request parameter equivalent allowed_data_quality_flags as it can't be used in the same way as the other filters.
- Each emission factor can have multiple, or (usually) no data quality flags, so each of your results may have the same 2 flags, then if you select only one of them you would have no more results.
- When a search doesn't specify an
allowed_data_quality_flagslist, we allow some flags by default. See here for more information about data quality. Also see the documentation for the search request above for how to useallowed_data_quality_flagswhile searching.
If you're curious about how to use possible_filters to narrow down your searches, the search refinement how-to has you covered.