API Reference
Models
Estimation

Estimation

Many endpoints return one or more of the Estimation models described below. One Estimation model always uses one Emission Factor (opens in a new tab), but when doing complex estimations, it is often necessary to combine multiple emission factors. In cases like that, endpoints often return multiple Estimation models.

Estimation

The Estimation response model is returned in a variety of estimation-related endpoints.

The model contains the total amount of emissions in kgCO2e, and includes the emission factor used for the calculation.

Attribute
co2e float
Emission factor carbon dioxide equivalent.
co2e_unit string
The unit in which the co2e field is expressed.
co2e_calculation_method string
Which calculation methodology that was used for the calculation. Is always ar4, ar5 or ar6.
Learn more about calculation methods here.
co2e_calculation_origin string
Whether or not the data source or Climatiq made the calculation. Is always source or climatiq.
Learn more about calculation methods here.
emission_factor used emission factor
The emission factor that was used for the calculation.
constituent_gases constituent gases
Indicates which constituent gases the emission factor is composed of.
audit_trail audit trail flag
Indicates whether Audit trail was enabled for this request. Is one of enabled, disabled or selector.
activity_data
Indicates the parameters which were multiplied by the factor to estimate emissions.
{
    "co2e": 81,
    "co2e_unit": "kg",
    "co2e_calculation_method": "ar5",
    "co2e_calculation_origin": "source",
    "emission_factor": {
        "name": "Electricity supplied from grid - residual mix",
        "activity_id": "electricity-supply_grid-source_residual_mix",
        "id": "e4f5fff3-e29a-4cc4-ac67-466705b18b3f",
        "access_type": "public",
        "source": "DISER",
        "source_dataset": "National Greenhouse and Energy Reporting (Measurement) Determination (NGER)",
        "year": 2023,
        "region": "AU-WA",
        "category": "Electricity",
        "source_lca_activity": "electricity_generation",
        "data_quality_flags": []
    },
    "constituent_gases": {
        "co2e_total": 81,
        "co2e_other": null,
        "co2": null,
        "ch4": null,
        "n2o": null
    },
    "activity_data": {
        "activity_value": 100,
        "activity_unit": "kWh"
    },
    "audit_trail": "selector"
}

EstimationWithSourceTrail

The EstimationWithSourceTrail model is the same as Estimation, but includes an additional source_trail field as well.

Extra Attributes
source_trail array of Source Data Points
An array of data points that help explain and provide trust in the calculation. Click to view more details about Source Trail.
{
    "co2e": 0.0007367,
    "co2e_unit": "kg",
    "co2e_calculation_method": "ar5",
    "co2e_calculation_origin": "source",
    "emission_factor": {
        "name": "Electricity supplied from grid",
        "activity_id": "electricity-supply_grid-source_supplier_mix",
        "id": "dfdeec5e-3137-4912-aa2b-1008575cf245",
        "access_type": "public",
        "source": "BEIS",
        "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
        "year": 2023,
        "region": "GB",
        "category": "Electricity",
        "source_lca_activity": "electricity_generation",
        "data_quality_flags": []
    },
    "constituent_gases": {
        "co2e_total": 0.0007367,
        "co2e_other": null,
        "co2": 0.0007292,
        "ch4": 1.138e-7,
        "n2o": 1.637e-8
    },
    "activity_data": {
        "activity_value": 0.003558,
        "activity_unit": "kWh"
    },
    "audit_trail": "enabled",
    "source_trail": [
        {
            "data_category": "emission_factor",
            "name": "Electricity supplied from grid",
            "source": "BEIS",
            "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
            "year": "2023",
            "region": "GB",
            "region_name": "United Kingdom"
        }
    ]
}
ParametersAudit Trail