API Reference
Basic Estimate

Estimation

Estimation operations are performed to calculate emissions produced by one or more activities, based on multiplying activity data by the appropriate emission factors.

Estimate

POST Calculate total estimated emissions produced for a particular activity, in kgCO2e, using the available emission factors. All requests are performed by sending a POST request to the following endpoint:

https://beta4.api.climatiq.io/estimate

The method of calculating emission estimates can differ depending on the unit type that the factor accepts and the applicability of the emission factor as indicated in the ID, name and description fields, with further detail provided by the source.

Every factor is linked to a unit type that is specified in the emission factors list inside the unit_type attribute. See all available emission factors in our Data Explorer (opens in a new tab).

Request

The following parameters can be defined as JSON-encoded body.

AttributeRequired
emission_factor Selector
Emission factor ID or selection parameters selector.
required
parameters Parameters
Emission factor parameters. The parameter object changes depending on the EF selected.
required
curl --request POST \
--url https://beta4.api.climatiq.io/estimate \
--header 'Authorization: Bearer API_KEY' \
--data '{
"emission_factor": {
"activity_id": "electricity-supply_grid-source_residual_mix",
"data_version": "^6"
},
"parameters": {
"energy": 100,
"energy_unit": "kWh"
}
}'

Response

This endpoint returns an Estimation, which includes the total amount of emissions in kgCO2e and the emission factor used to calculate the emissions.

Attribute
Estimation object
An Estimation that describes the total amount of co2e and the emission factor used.
{
"co2e": 95.42,
"co2e_unit": "kg",
"co2e_calculation_method": "ar4",
"co2e_calculation_origin": "source",
"emission_factor": {
"name": "Electricity supplied from grid - residual mix",
"activity_id": "electricity-supply_grid-source_residual_mix",
"id": "eefd06c3-1c7a-447c-aaf5-fe958bfa470e",
"access_type": "public",
"source": "AIB",
"source_dataset": "European Residual Mix",
"year": 2022,
"region": "RS",
"category": "Electricity",
"source_lca_activity": "electricity_generation",
"data_quality_flags": [
"partial_factor",
"notable_methodological_variance"
]
},
"constituent_gases": {
"co2e_total": 95.42,
"co2e_other": null,
"co2": 95.42,
"ch4": null,
"n2o": null
},
"activity_data": {
"activity_value": 100,
"activity_unit": "kWh"
},
"audit_trail": "selector"
}

Batch Estimate Endpoint

POST Batch endpoints can be used to calculate multiple emission estimations in a single request. Currently limited to maximum 100 operations per request.

https://beta4.api.climatiq.io/batch

Request

AttributeRequired
array
List of estimation operations. Every operation should follow the same syntax followed by the estimate request object.
required
curl --request POST \
--url https://beta4.api.climatiq.io/batch \
--header 'Authorization: Bearer API_KEY' \
--data '[
{
"emission_factor": {
"activity_id": "passenger_vehicle-vehicle_type_car-fuel_source_na-engine_size_na-vehicle_age_na-vehicle_weight_na",
"data_version": "^6"
},
"parameters":{
"distance": 100,
"distance_unit": "km"
}
},
{
"emission_factor": {
"activity_id": "consumer_goods-type_snack_foods",
"data_version": "^6"
},
"parameters": {
"money": 15,
"money_unit": "usd"
}
}
]'

Response

The response includes a list of Estimations.

Attribute
results [Estimation]
List of results for every operation.
{
"results": [
{
"co2e": 16.66,
"co2e_unit": "kg",
"co2e_calculation_method": "ar5",
"co2e_calculation_origin": "source",
"emission_factor": {
"name": "Car (average) - Passenger vehicles",
"activity_id": "passenger_vehicle-vehicle_type_car-fuel_source_na-engine_size_na-vehicle_age_na-vehicle_weight_na",
"id": "12fda2e0-d456-4a94-92d1-8a852d5de3a1",
"access_type": "public",
"source": "BEIS",
"source_dataset": "Greenhouse gas reporting: conversion factors 2023",
"year": 2023,
"region": "GB",
"category": "Vehicles",
"source_lca_activity": "fuel_combustion",
"data_quality_flags": []
},
"constituent_gases": {
"co2e_total": 16.66,
"co2e_other": null,
"co2": 16.55,
"ch4": 0.000679,
"n2o": 0.00037
},
"activity_data": {
"activity_value": 100,
"activity_unit": "km"
},
"audit_trail": "selector"
},
{
"co2e": 2.325,
"co2e_unit": "kg",
"co2e_calculation_method": "ar4",
"co2e_calculation_origin": "source",
"emission_factor": {
"name": "Snack and nonalcoholic beverage bars",
"activity_id": "consumer_goods-type_snack_foods",
"id": "411fd5ac-8e31-439e-898e-1535c16b41ba",
"access_type": "public",
"source": "EPA",
"source_dataset": "Supply Chain Greenhouse Gas Emission Factors v1.2",
"year": 2019,
"region": "US",
"category": "Food and Beverage Services",
"source_lca_activity": "cradle_to_shelf",
"data_quality_flags": []
},
"constituent_gases": {
"co2e_total": 2.325,
"co2e_other": 0.06251,
"co2": 1.785,
"ch4": 0.01151,
"n2o": 0.0006405
},
"activity_data": {
"activity_value": 15,
"activity_unit": "usd"
},
"audit_trail": "selector"
}
]
}