API Reference
Energy (preview 2)

Energy v1 (preview 2)

⚠️
Preview Feature

This feature is currently in preview. That means that we believe the feature is good enough to start using, but:

  • There might still be bugs or edge cases we haven't covered.
  • The documentation and error messages might be less detailed.
  • We might need to make further changes in the API surface.

We need the ability to iterate quickly on preview versions, so we offer less guarantees of stability. When we make changes to the preview version, we will release a new version, and you must migrate to this new version within one month. Read more about API versioning at Climatiq here.For this reason, preview endpoints are not available without explicitly opting in. If you would like to opt-in to this preview feature, please contact us.

To see the changes since v1-preview1, see our changelog

The energy endpoints automatically calculate the greenhouse gas emissions associated with the consumed energy based on relevant emission factors. These factors are determined based on the specific type of energy and the region where it is consumed, ensuring accurate carbon footprint calculations for your organization.

This feature can be used to help businesses estimate and report their scope 1, 2 and associated scope 3 emissions under the GHG Protocol. It also meets the requirements of the SBTi and covers market-based and location-based approaches for electricity use.

For extra information about our methodology for GHG Protocol scopes 2 and 3.3 calculation, please view the scope 2 and scope 3.3 FERA guides.

Electricity use

POST Calculate the estimated greenhouse gas emissions for electricity use, including both grid electricity and direct-line electricity. This endpoint allows you to obtain accurate carbon footprint calculations for your organization's purchased electricity.

IEA data

By default the Electricity calculator uses publicly published emission factors from various official sources covering 63 countries. For greater coverage and consistency you also have the option to purchase a premium license to emission factors from the International Energy Agency (IEA) increasing coverage to 149 countries. Contact us (opens in a new tab)

https://preview.api.climatiq.io/energy/v1-preview2/electricity

Request

This endpoint accepts the following parameters:

Request parametersShould be sent as a JSON object in the body
    • regionrequired string

      The region or country where the electricity was consumed, usually a country but could be US / Australian / Canadian state / province or US eGrid. A US zip code can be provided in the format US-XXXXX or a UN/LOCODE in the format XX-YYY. See also choosing a region below.

    • yearinteger
      Default value: Latest year available

      The year for which the greenhouse gas emissions are being calculated.

    • amountEnergy object
      Default value: Sum of the components

      The total electricity used.

    • recsEnergy object

      Quantity of RECs (Renewable Energy Certificates) to apply.

    • source_setstring
      Default value: "iea" if the API key used has access to the premium IEA dataset, otherwise "core"

      Specifies which set of emission factors the caller would like to use. Valid values are core or iea

    • componentsarray of Component objects

      An array containing the different components of the electricity consumption and their associated details.

An implied residual component will be added to make up any difference between the total amount of energy in the request and the sum of the amount of energy in each component.

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/electricity \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "year": 2023,
    "region": "GB",
    "source_set": "core",
    "amount": {
        "energy": 5000,
        "energy_unit": "kWh"
    },
    "recs": {
        "energy": 1000,
        "energy_unit": "kWh"
    },
    "components": [
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "connection_type": "grid",
            "supplier": "british_gas"
        },
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "connection_type": "direct",
            "loss_factor": 0.05,
            "energy_source": "natural_gas"
        },
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "connection_type": "direct",
            "energy_source": "renewable"
        }
    ]
}'

Response

The response includes estimates for the greenhouse gas emissions associated with electricity use.

Response parameters
    • locationEnergy reporting quad

      The estimates for greenhouse gas emissions based on the location of consumption.

    • marketEnergy reporting quad

      The estimates for greenhouse gas emissions based on market method (purchases).

    • noticesarray of Notices

      Any notices about deficiencies or peculiarities of the calculation.

{
    "location": {
        "consumption": {
            "co2e": 1007,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar6_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"combustion-NaturalGas\" = F_\"14066219-ddb5-463a-b6d1-b5a277c5abe0\" = 0.2042\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2072\"kgco2e/kWh\"`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"gen\"^\"grid\" = I_\"grid-energy\"*F_\"grid-generation\"`<br />\n`E_\"fossil\" = (E_\"gen\"^\"grid\"+E_\"gen\"^\"component-1\"+E_\"gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 999.4,
                "ch4": 0.1169,
                "n2o": 0.01451
            }
        },
        "well_to_tank": {
            "co2e": 200.9,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar5_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"grid-WTT\" = F_\"f0cd3fdd-533e-41d1-828d-fd4d103dc2ad\" = 0.0459\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"ref-grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"8248d37e-257b-44d5-a0bd-c4fbc0df1046\" = 0.03347\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"wtt-gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"wtt-gen\"^\"grid\" = I_\"grid-energy\"*F_\"grid-generation\"*F_\"grid-WTT\"/F_\"ref-grid-generation\"`<br />\n`E_\"fossil\" = (E_\"wtt-gen\"^\"grid\"+E_\"wtt-gen\"^\"component-1\"+E_\"wtt-gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        },
        "transmission_and_distribution": {
            "co2e": 74.07,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar6_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid: T&D losses",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"TnD-loss-factor\" = 0.010`<br />\n`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"combustion-NaturalGas\" = F_\"14066219-ddb5-463a-b6d1-b5a277c5abe0\" = 0.2042\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"grid-TnD\" = F_\"54badec0-d6dc-4d6a-9a80-289059750e39\" = 0.01793\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2072\"kgco2e/kWh\"`<br />\n`F_\"grid-generation-ref\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2072\"kgco2e/kWh\"`<br />\n`I_\"TnD-loss-factor\"^\"grid\" = F_\"grid-TnD\"/F_\"grid-generation-ref\"`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-C_\"TnD-loss-factor\")`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.050`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*C_\"TnD-loss-factor\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"tnd\"^\"grid\" = I_\"grid-energy\"*I_\"TnD-loss-factor\"^\"grid\"*F_\"grid-generation\"`<br />\n`E_\"fossil\" = (E_\"tnd\"^\"grid\"+E_\"tnd\"^\"component-1\"+E_\"tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 73.45,
                "ch4": 0.00941,
                "n2o": 0.001232
            }
        },
        "well_to_tank_of_transmission_and_distribution": {
            "co2e": 15.24,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar5_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid: T&D losses",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"TnD-loss-factor\" = 0.010`<br />\n`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"grid-TnD\" = F_\"54badec0-d6dc-4d6a-9a80-289059750e39\" = 0.01792\"kgco2e/kWh\"`<br />\n`F_\"grid-WTT\" = F_\"f0cd3fdd-533e-41d1-828d-fd4d103dc2ad\" = 0.0459\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"grid-generation-ref\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"ref-grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"8248d37e-257b-44d5-a0bd-c4fbc0df1046\" = 0.03347\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`I_\"TnD-loss-factor\"^\"grid\" = F_\"grid-TnD\"/F_\"grid-generation-ref\"`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-C_\"TnD-loss-factor\")`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.050`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"wtt-tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*C_\"TnD-loss-factor\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"wtt-tnd\"^\"grid\" = I_\"grid-energy\"*I_\"TnD-loss-factor\"^\"grid\"*F_\"grid-generation\"*F_\"grid-WTT\"/F_\"ref-grid-generation\"`<br />\n`E_\"fossil\" = (E_\"wtt-tnd\"^\"grid\"+E_\"wtt-tnd\"^\"component-1\"+E_\"wtt-tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        }
    },
    "market": {
        "consumption": {
            "co2e": 889.6,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar4_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid - residual mix",
                    "source": "AIB",
                    "source_dataset": "European Residual Mix",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid - supplier British Gas",
                    "source": "Electricity Info",
                    "source_dataset": "Fuel Mix of UK Domestic Electricity Suppliers",
                    "year": "2022",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"british_gas\" = F_\"70889b28-cef0-4dce-9af4-25cce6a88eb3\" = 0.116\"kgco2e/kWh\"`<br />\n`F_\"combustion-NaturalGas\" = F_\"14066219-ddb5-463a-b6d1-b5a277c5abe0\" = 0.2042\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"grid-residual\" = F_\"3bf35117-1ad2-42ba-a403-c5fa92db0925\" = 0.3884\"kgco2e/kWh\"`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"recs\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"gen\"^\"component-0\" = P_\"energy\"^\"component-0\"*F_\"british_gas\"`<br />\n`E_\"gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"gen\"^\"residual\" = (I_\"residual-energy\"-P_\"recs\")*F_\"grid-residual\"`<br />\n`E_\"fossil\" = (E_\"gen\"^\"component-0\"+E_\"gen\"^\"residual\"+E_\"gen\"^\"component-1\"+E_\"gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 888.9,
                "ch4": null,
                "n2o": null
            }
        },
        "well_to_tank": {
            "co2e": 175,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_mixed_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid - residual mix",
                    "source": "AIB",
                    "source_dataset": "European Residual Mix",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid - supplier British Gas",
                    "source": "Electricity Info",
                    "source_dataset": "Fuel Mix of UK Domestic Electricity Suppliers",
                    "year": "2022",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"british_gas\" = F_\"70889b28-cef0-4dce-9af4-25cce6a88eb3\" = 0.116\"kgco2e/kWh\"`<br />\n`F_\"grid-WTT\" = F_\"f0cd3fdd-533e-41d1-828d-fd4d103dc2ad\" = 0.0459\"kgco2e/kWh\"`<br />\n`F_\"grid-residual\" = F_\"3bf35117-1ad2-42ba-a403-c5fa92db0925\" = 0.3884\"kgco2e/kWh\"`<br />\n`F_\"ref-grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"8248d37e-257b-44d5-a0bd-c4fbc0df1046\" = 0.03347\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"recs\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"wtt-gen\"^\"component-0\" = P_\"energy\"^\"component-0\"*F_\"british_gas\"*ubrace(F_\"grid-WTT\"/F_\"ref-grid-generation\")_\"Applying regional well to tank percentage to the market factor for named supplier 'british_gas'. For more accurate well to tank emissions, explicitly provide a fuel mix.\"`<br />\n`E_\"wtt-gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"wtt-gen\"^\"residual\" = (I_\"residual-energy\"-P_\"recs\")*F_\"grid-residual\"*F_\"grid-WTT\"/F_\"ref-grid-generation\"`<br />\n`E_\"fossil\" = (E_\"wtt-gen\"^\"component-0\"+E_\"wtt-gen\"^\"residual\"+E_\"wtt-gen\"^\"component-1\"+E_\"wtt-gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        },
        "transmission_and_distribution": {
            "co2e": 74.07,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar6_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid: T&D losses",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"TnD-loss-factor\" = 0.010`<br />\n`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"combustion-NaturalGas\" = F_\"14066219-ddb5-463a-b6d1-b5a277c5abe0\" = 0.2042\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"grid-TnD\" = F_\"54badec0-d6dc-4d6a-9a80-289059750e39\" = 0.01793\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2072\"kgco2e/kWh\"`<br />\n`F_\"grid-generation-ref\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2072\"kgco2e/kWh\"`<br />\n`I_\"TnD-loss-factor\"^\"grid\" = F_\"grid-TnD\"/F_\"grid-generation-ref\"`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-C_\"TnD-loss-factor\")`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.050`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*C_\"TnD-loss-factor\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"tnd\"^\"grid\" = I_\"grid-energy\"*I_\"TnD-loss-factor\"^\"grid\"*F_\"grid-generation\"`<br />\n`E_\"fossil\" = (E_\"tnd\"^\"grid\"+E_\"tnd\"^\"component-1\"+E_\"tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 73.45,
                "ch4": 0.00941,
                "n2o": 0.001232
            }
        },
        "well_to_tank_of_transmission_and_distribution": {
            "co2e": 15.24,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar5_gwp100",
            "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"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Electricity supplied from grid: T&D losses",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                    "year": "2023",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"TnD-loss-factor\" = 0.010`<br />\n`C_\"combustion-efficiency-NaturalGas\" = 0.530`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"grid-TnD\" = F_\"54badec0-d6dc-4d6a-9a80-289059750e39\" = 0.01792\"kgco2e/kWh\"`<br />\n`F_\"grid-WTT\" = F_\"f0cd3fdd-533e-41d1-828d-fd4d103dc2ad\" = 0.0459\"kgco2e/kWh\"`<br />\n`F_\"grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"grid-generation-ref\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"ref-grid-generation\" = F_\"d53d2fff-6f3e-4a7d-aa78-e05b3a59ee57\" = 0.2071\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"8248d37e-257b-44d5-a0bd-c4fbc0df1046\" = 0.03347\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`I_\"TnD-loss-factor\"^\"grid\" = F_\"grid-TnD\"/F_\"grid-generation-ref\"`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-C_\"TnD-loss-factor\")`<br />\n`I_\"grid-energy\" = (P_\"energy\"^\"component-0\"+I_\"residual-energy\")`<br />\n`I_\"residual-energy\" = (P_\"total-consumed\"-(P_\"energy\"^\"component-0\"+(P_\"energy\"^\"component-1\"+P_\"energy\"^\"component-2\")))`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.050`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`P_\"total-consumed\" = 5000\"kWh\"`<br />\n`E_\"wtt-tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*C_\"TnD-loss-factor\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"wtt-tnd\"^\"grid\" = I_\"grid-energy\"*I_\"TnD-loss-factor\"^\"grid\"*F_\"grid-generation\"*F_\"grid-WTT\"/F_\"ref-grid-generation\"`<br />\n`E_\"fossil\" = (E_\"wtt-tnd\"^\"grid\"+E_\"wtt-tnd\"^\"component-1\"+E_\"wtt-tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        }
    },
    "notices": [
        {
            "severity": "warning",
            "code": "general_wtt_used_for_specific_factor",
            "message": "Applying regional well to tank percentage to the market factor for named supplier 'british_gas'. For more accurate well to tank emissions, explicitly provide a fuel mix."
        },
        {
            "severity": "info",
            "code": "recs_subtracted_market_generation",
            "message": "Market generation components were subtracted for RECs"
        }
    ]
}

Choosing a region

Regions are currently only available where grid emission data is available, and we plan to expand this coverage over time. In countries where we have coverage, you can use the ISO-3166-1-alpha2 country code, a country code and an ISO3166-2 subdivision code in the format XX-YY, or a UN/LOCODE in the format XX-YYY to resolve to the enclosing subregion or country, and in the US the preferred method is to use a zip code in the format US-XXXXX in order to most accurately choose both eGrid and state-based factors.

The suggested way to find available regions is to make a request without setting a region and see which ones are indicated as being available in the error response.

Request

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/electricity \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "region": "",
    "source_set": "core"
}'

Response

{
    "error": "bad_request",
    "error_code": "no_location_found",
    "message": "The supplied region is not supported",
    "valid_values": {
        "region": [
            "AT",
            "AU",
            "AU-ACT",
            "AU-NSW",
            "AU-NT",
            "AU-QLD",
            "AU-SA",
            "AU-TAS",
            "AU-VIC",
            "AU-WA",
            "BE",
            "BG",
            "BR",
            "CA",
            "CA-AB",
            "CA-BC",
            "CA-MB",
            "CA-NB",
            "CA-NL",
            "CA-NS",
            "CA-NT",
            "CA-NU",
            "CA-ON",
            "CA-QC",
            "CA-SK",
            "CA-YT",
            "CH",
            "CN",
            "CY",
            "CZ",
            "DE",
            "DK",
            "EE",
            "ES",
            "EU",
            "FI",
            "FR",
            "GB",
            "GR",
            "HR",
            "HU",
            "ID",
            "IE",
            "IN",
            "IS",
            "IT",
            "JP",
            "KR",
            "LT",
            "LU",
            "LV",
            "MT",
            "MX",
            "NL",
            "NO",
            "NZ",
            "PL",
            "PT",
            "RO",
            "RU",
            "SA",
            "SE",
            "SI",
            "SK",
            "TR",
            "US",
            "US-AK",
            "US-AKGD",
            "US-AKMS",
            "US-AL",
            "US-AR",
            "US-AZ",
            "US-AZNM",
            "US-CA",
            "US-CAMX",
            "US-CO",
            "US-CT",
            "US-DC",
            "US-DE",
            "US-ERCT",
            "US-FL",
            "US-FRCC",
            "US-GA",
            "US-HI",
            "US-HIMS",
            "US-HIOA",
            "US-IA",
            "US-ID",
            "US-IL",
            "US-IN",
            "US-KS",
            "US-KY",
            "US-LA",
            "US-MA",
            "US-MD",
            "US-ME",
            "US-MI",
            "US-MN",
            "US-MO",
            "US-MROE",
            "US-MROW",
            "US-MS",
            "US-MT",
            "US-NC",
            "US-ND",
            "US-NE",
            "US-NEWE",
            "US-NH",
            "US-NJ",
            "US-NM",
            "US-NV",
            "US-NWPP",
            "US-NY",
            "US-NYCW",
            "US-NYLI",
            "US-NYUP",
            "US-OH",
            "US-OK",
            "US-OR",
            "US-PA",
            "US-PR",
            "US-PRMS",
            "US-RFCE",
            "US-RFCM",
            "US-RFCW",
            "US-RI",
            "US-RMPA",
            "US-SC",
            "US-SD",
            "US-SPNO",
            "US-SPSO",
            "US-SRMV",
            "US-SRMW",
            "US-SRSO",
            "US-SRTV",
            "US-SRVC",
            "US-TN",
            "US-TX",
            "US-UT",
            "US-VA",
            "US-VT",
            "US-WA",
            "US-WI",
            "US-WV",
            "US-WY",
            "ZA"
        ]
    }
}

Choosing a supplier

Suppliers are currently only available in US states and in the United Kingdom. The suggested way to find available suppliers's is to make a request without setting a supplier (but setting amount and region) and see which suppliers are indicated as being available in the error response.

Request

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/electricity \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "region": "US-CA",
    "components": [
        {
            "amount": {
                "energy": 0,
                "energy_unit": "kWh"
            },
            "supplier": ""
        }
    ]
}'

Response

The available suppliers will depend on the region.

{
    "error": "bad_request",
    "error_code": "invalid_input",
    "message": "No emission factors exist with the given supplier `` in the specified region. This error will contain the valid suppliers in the requested region.",
    "valid_values": {
        "supplier": [
            "algonquin_power_and_utilities_corp_liberty_utilities",
            "edison_international_southern_california_edison",
            "pgande_corporation_pacific_gas_and_electric_company",
            "puget_sound_energy"
        ]
    }
}

Batch Electricity Use

POST For bulk data-processing, this endpoint has a batch endpoint variant allowing for up to 100 calculations with one API call.

The batch endpoint is available at:

https://preview.api.climatiq.io/energy/v1-preview2/electricity/batch

Provide this endpoint with an array of objects, where each object is a valid body for the non-batch endpoint. See the batch endpoint documentation for more information about how batch endpoints work and how to handle errors.

Heat and Steam use

POST Calculate the estimated greenhouse gas emissions for heat and steam use. This endpoint allows you to obtain accurate carbon footprint calculations for your organization's purchased heat and steam.

https://preview.api.climatiq.io/energy/v1-preview2/heat

Request

This endpoint accepts the following parameters:

Request parametersShould be sent as a JSON object in the body
    • regionrequired string

      The country where the heat and steam was consumed.

    • componentsrequired array of Component objects

      An array containing the different components of the heat and steam consumption and their associated details.
      Each component within the components array corresponds to a purchase of heat and steam under some contract, it should include the following parameters: (outside of DE / GB / US, either the energy_source or the co2e_kg_per_kwh must be provided)

      components[x].amountrequired Energy object

      The total heat and steam purchased

      components[x].co2e_kg_per_kwhfloat

      Contract emission factor for the component in kg per kWh

      components[x].energy_sourcestring

      The source that the heat is generated from. Valid values are renewable or specific fuel types such as natural_gas, coal, biomass

      components[x].loss_factorfloat or string
      Default value: medium

      The distribution loss factor for this component. Can either be a number or one of the strings "low", "medium" or "high"

    • yearinteger
      Default value: Latest year available

      The year for which the greenhouse gas emissions are being calculated.

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/heat \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "year": 2021,
    "region": "DE",
    "components": [
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "loss_factor": 0.06
        },
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "loss_factor": 0.1,
            "energy_source": "natural_gas"
        },
        {
            "amount": {
                "energy": 1000,
                "energy_unit": "kWh"
            },
            "energy_source": "renewable"
        }
    ]
}'

Response

The response includes estimates for the greenhouse gas emissions associated with heat and steam use.

Response parameters
    • estimatesEnergy reporting quad

      The estimates for greenhouse gas emissions.

    • noticesarray of Notices

      Any notices about deficiencies or peculiarities of the calculation.

{
    "estimates": {
        "consumption": {
            "co2e": 479.9,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar6_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "District heating",
                    "source": "UBA",
                    "source_dataset": "Emissionsbilanz erneuerbarer Energietraeger",
                    "year": "2021",
                    "region": "DE",
                    "region_name": "Germany"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2021",
                    "year": "2021",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.900`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"combustion-NaturalGas\" = F_\"1e1ffef5-6478-4356-a13b-fa0f66d962d1\" = 0.2044\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2529\"kgco2e/kWh\"`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`E_\"gen\"^\"component-0\" = P_\"energy\"^\"component-0\"*F_\"location-generation\"`<br />\n`E_\"gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"fossil\" = (E_\"gen\"^\"component-0\"+E_\"gen\"^\"component-1\"+E_\"gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 475.9,
                "ch4": 0.08444,
                "n2o": 0.00541
            }
        },
        "well_to_tank": {
            "co2e": 78.89,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar4_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "District heating",
                    "source": "UBA",
                    "source_dataset": "Emissionsbilanz erneuerbarer Energietraeger",
                    "year": "2021",
                    "region": "DE",
                    "region_name": "Germany"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2021",
                    "year": "2021",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.900`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"location-WTT\" = F_\"21035a1d-f1df-452b-b673-c69895065b1c\" = 0.04029\"kgco2e/kWh\"`<br />\n`F_\"location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2526\"kgco2e/kWh\"`<br />\n`F_\"ref-location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2526\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"aa9240f8-ca36-4405-bed9-083678faa694\" = 0.03474\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`E_\"wtt-gen\"^\"component-0\" = P_\"energy\"^\"component-0\"*F_\"location-generation\"*F_\"location-WTT\"/F_\"ref-location-generation\"`<br />\n`E_\"wtt-gen\"^\"component-1\" = P_\"energy\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-gen\"^\"component-2\" = P_\"energy\"^\"component-2\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"fossil\" = (E_\"wtt-gen\"^\"component-0\"+E_\"wtt-gen\"^\"component-1\"+E_\"wtt-gen\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        },
        "transmission_and_distribution": {
            "co2e": 41.37,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar6_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "District heating",
                    "source": "UBA",
                    "source_dataset": "Emissionsbilanz erneuerbarer Energietraeger",
                    "year": "2021",
                    "region": "DE",
                    "region_name": "Germany"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2021",
                    "year": "2021",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.900`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"combustion-NaturalGas\" = F_\"1e1ffef5-6478-4356-a13b-fa0f66d962d1\" = 0.2044\"kgco2e/kWh\"`<br />\n`F_\"combustion-Renewable\" = F_\"4f80b533-b3ef-43d3-b51b-fddcd3e4b754\" = 0\"kgco2e/kWh\"`<br />\n`F_\"location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2529\"kgco2e/kWh\"`<br />\n`I_\"generated-energy\"^\"component-0\" = P_\"energy\"^\"component-0\"/(1-P_\"TnD-loss-factor\"^\"component-0\")`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-P_\"TnD-loss-factor\"^\"component-2\")`<br />\n`P_\"TnD-loss-factor\"^\"component-0\" = 0.060`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.100`<br />\n`P_\"TnD-loss-factor\"^\"component-2\" = 0.120`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`E_\"tnd\"^\"component-0\" = I_\"generated-energy\"^\"component-0\"*P_\"TnD-loss-factor\"^\"component-0\"*F_\"location-generation\"`<br />\n`E_\"tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"combustion-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*P_\"TnD-loss-factor\"^\"component-2\"*F_\"combustion-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"fossil\" = (E_\"tnd\"^\"component-0\"+E_\"tnd\"^\"component-1\"+E_\"tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": 41.09,
                "ch4": 0.005978,
                "n2o": 0.0003647
            }
        },
        "well_to_tank_of_transmission_and_distribution": {
            "co2e": 6.861,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar4_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "District heating",
                    "source": "UBA",
                    "source_dataset": "Emissionsbilanz erneuerbarer Energietraeger",
                    "year": "2021",
                    "region": "DE",
                    "region_name": "Germany"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Natural gas - 100% mineral blend (net CV)",
                    "source": "BEIS",
                    "source_dataset": "Greenhouse gas reporting: conversion factors 2021",
                    "year": "2021",
                    "region": "GB",
                    "region_name": "United Kingdom"
                },
                {
                    "data_category": "emission_factor",
                    "name": "Renewables",
                    "source": "Climatiq",
                    "source_dataset": "Climatiq",
                    "year": "2022",
                    "region": "GLOBAL",
                    "region_name": "Global"
                }
            ],
            "co2_biogenic": null,
            "audit_trail": "`C_\"combustion-efficiency-NaturalGas\" = 0.900`<br />\n`C_\"combustion-efficiency-Renewable\" = 1`<br />\n`F_\"location-WTT\" = F_\"21035a1d-f1df-452b-b673-c69895065b1c\" = 0.04029\"kgco2e/kWh\"`<br />\n`F_\"location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2526\"kgco2e/kWh\"`<br />\n`F_\"ref-location-generation\" = F_\"1e66f532-ec59-4f23-9606-0c63d4add4a1\" = 0.2526\"kgco2e/kWh\"`<br />\n`F_\"wtt-NaturalGas\" = F_\"aa9240f8-ca36-4405-bed9-083678faa694\" = 0.03474\"kgco2e/kWh\"`<br />\n`F_\"wtt-Renewable\" = F_\"775f78bb-3d1e-499b-a95f-3fbbf4ba12e9\" = 0\"kgco2e/kWh\"`<br />\n`I_\"generated-energy\"^\"component-0\" = P_\"energy\"^\"component-0\"/(1-P_\"TnD-loss-factor\"^\"component-0\")`<br />\n`I_\"generated-energy\"^\"component-1\" = P_\"energy\"^\"component-1\"/(1-P_\"TnD-loss-factor\"^\"component-1\")`<br />\n`I_\"generated-energy\"^\"component-2\" = P_\"energy\"^\"component-2\"/(1-P_\"TnD-loss-factor\"^\"component-2\")`<br />\n`P_\"TnD-loss-factor\"^\"component-0\" = 0.060`<br />\n`P_\"TnD-loss-factor\"^\"component-1\" = 0.100`<br />\n`P_\"TnD-loss-factor\"^\"component-2\" = 0.120`<br />\n`P_\"energy\"^\"component-0\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-1\" = 1000\"kWh\"`<br />\n`P_\"energy\"^\"component-2\" = 1000\"kWh\"`<br />\n`E_\"wtt-tnd\"^\"component-0\" = I_\"generated-energy\"^\"component-0\"*P_\"TnD-loss-factor\"^\"component-0\"*F_\"location-generation\"*F_\"location-WTT\"/F_\"ref-location-generation\"`<br />\n`E_\"wtt-tnd\"^\"component-1\" = I_\"generated-energy\"^\"component-1\"*P_\"TnD-loss-factor\"^\"component-1\"*F_\"wtt-NaturalGas\"/C_\"combustion-efficiency-NaturalGas\"`<br />\n`E_\"wtt-tnd\"^\"component-2\" = I_\"generated-energy\"^\"component-2\"*P_\"TnD-loss-factor\"^\"component-2\"*F_\"wtt-Renewable\"/C_\"combustion-efficiency-Renewable\"`<br />\n`E_\"fossil\" = (E_\"wtt-tnd\"^\"component-0\"+E_\"wtt-tnd\"^\"component-1\"+E_\"wtt-tnd\"^\"component-2\")`<br />\n",
            "constituent_gases": {
                "co2": null,
                "ch4": null,
                "n2o": null
            }
        }
    }
}

Batch Heat and Steam Use

POST For bulk data-processing, this endpoint has a batch endpoint variant allowing for up to 100 calculations with one API call.

The batch endpoint is available at:

https://preview.api.climatiq.io/energy/v1-preview2/heat/batch

Provide this endpoint with an array of objects, where each object is a valid body for the non-batch endpoint. See the batch endpoint documentation for more information about how batch endpoints work and how to handle errors.

Fuel Use

POST Calculate the estimated greenhouse gas emissions for fuel combustion.

https://preview.api.climatiq.io/energy/v1-preview2/fuel

Request

The request to the fuel combustion endpoint accepts the following parameters included in the request body. Except for fuel_type and amount, which must match exactly, any parameters that cannot be matched to an emission factor will be ignored, e.g. this means that the emission factors might be for a different region than you selected. In the event of a mismatch, a notice will be included in the response.

Request parametersShould be sent as a JSON object in the body
    • fuel_typerequired string

      The type of fuel burned. See choosing a fuel_type for how to choose this.

    • amountrequired Energy/Volume/Weight object

      The amount of fuel burned.

    • regionstring

      The region or country where the fuel was burned.

    • yearinteger
      Default value: Latest year available

      The year in which the fuel was burned.

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/fuel \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "fuel_type": "biodiesel_bio_100",
    "amount": {
        "volume": 5000,
        "volume_unit": "l"
    },
    "region": "GB",
    "year": 2023
}'

Response

The response includes estimates for the greenhouse gas emissions associated with fuel combustion.

Response parameters
    • combustionEnergy estimate

      Estimate of emissions from fuel combustion

    • well_to_tankEnergy estimate

      Estimate of upstream emissions. (This could be empty in cases where we can't estimate the WTT but can estimate the combustion, a notice will be included in this case)

    • noticesarray of Notices

      Any notices about deficiencies or peculiarities of the calculation.

{
    "combustion": {
        "co2e": 837.6,
        "co2e_unit": "kg",
        "co2e_calculation_method": "ipcc_ar5_gwp100",
        "source_trail": [
            {
                "data_category": "emission_factor",
                "name": "Off road biodiesel",
                "source": "BEIS",
                "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                "year": "2023",
                "region": "GB",
                "region_name": "United Kingdom"
            }
        ],
        "co2_biogenic": 11950,
        "audit_trail": "`F_\"combustion\" = F_\"414c53d5-8844-4250-8b4d-09a8a1133535\" = 0.1675\"kgco2e/l\"`<br />\n`E_\"fossil\" = F_\"combustion\"*5000\"l\"`<br />\n`F_\"biogenic-combustion\" = F_\"c1c8c8f9-38f4-4057-a245-49e9d8c93798\" = 2.39\"kgco2e/l\"`<br />\n`E_\"biogenic\" = F_\"biogenic-combustion\"*5000\"l\"`<br />\n",
        "constituent_gases": {
            "co2": null,
            "ch4": null,
            "n2o": null
        }
    },
    "well_to_tank": {
        "co2e": 2238,
        "co2e_unit": "kg",
        "co2e_calculation_method": "ipcc_ar5_gwp100",
        "source_trail": [
            {
                "data_category": "emission_factor",
                "name": "Off road biodiesel",
                "source": "BEIS",
                "source_dataset": "Greenhouse gas reporting: conversion factors 2023",
                "year": "2023",
                "region": "GB",
                "region_name": "United Kingdom"
            }
        ],
        "co2_biogenic": null,
        "audit_trail": "`F_\"WTT\" = F_\"b4d508d5-d6c5-48e0-a86d-3cca2b268657\" = 0.4476\"kgco2e/l\"`<br />\n`E_\"fossil\" = F_\"WTT\"*5000\"l\"`<br />\n",
        "constituent_gases": {
            "co2": null,
            "ch4": null,
            "n2o": null
        }
    },
    "notices": []
}

Choosing a fuel_type

The suggested way to find the available fuel_types is to make a request without setting the fuel_type (but setting amount and region) and see which fuel_types are indicated as being available in the error response. region can also be omitted to see all fuel_types available globally.

Request

curl --request POST \
  --url https://preview.api.climatiq.io/energy/v1-preview2/fuel \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "amount": {
        "weight": 0,
        "weight_unit": "g"
    },
    "region": "US"
}'

Response

The available fuel_types will depend on the unit and region.

{
    "error": "bad_request",
    "error_code": "invalid_input",
    "message": "No emission factors exist with the given fuel type. This error will contain the valid fuel types for the provided unit type and for this region.",
    "valid_values": {
        "fuel_type": [
            "agricultural_byproducts_bio_100",
            "coal_and_coke_mixed",
            "coal_anthracite",
            "coal_bituminous",
            "coal_coke",
            "coal_lignite",
            "coal_sub_bituminous",
            "peat_bio_100",
            "petroleum_coke",
            "plastics",
            "solid_byproducts",
            "tires",
            "waste_solid_municipal",
            "wood_and_wood_residuals_bio_100"
        ]
    }
}

Batch Fuel Use

POST For bulk data-processing, this endpoint has a batch endpoint variant allowing for up to 100 calculations with one API call.

The batch endpoint is available at:

https://preview.api.climatiq.io/energy/v1-preview2/fuel/batch

Provide this endpoint with an array of objects, where each object is a valid body for the non-batch endpoint. See the batch endpoint documentation for more information about how batch endpoints work and how to handle errors.

Response models

Response formats shared between the above endpoints.

Energy reporting quad

For electricity (market and location) and heat and steam, the API reports 4 estimates, one for scope 2 (consumption) emissions and each of the 3 scope 3.3 (FERA) emissions estimates:

AttributeTypeDescription
consumptionEnergy estimateEstimates of the greenhouse gas emissions that result from generating the consumed energy.
transmission_and_distributionEnergy estimateEstimates of the greenhouse gas emissions that result from generating the energy which is subsequently lost during the processes of transmission and distribution.
well_to_tankEnergy estimateEstimates of the greenhouse gas emissions that result from obtaining the fuel used for generating the consumed energy.
well_to_tank_of_transmission_and_distributionEnergy estimateEstimates of the greenhouse gas emissions that result from obtaining the fuel used for generating the energy which is subsequently lost during the processes of transmission and distribution.

Energy estimate

Response parameters
    • co2efloat

      The total greenhouse gas emissions associated with the consumed energy, expressed in kilograms (kg).

    • co2e_unitstring

      The unit in which the CO2e field is expressed. The value of this is always kg

    • co2e_calculation_methodstring

      Which calculation methodology that was used for the calculation. The value of this is either "ipcc_ar4_gwp100", "ipcc_ar5_gwp100", "ipcc_ar6_gwp100" or "ipcc_mixed_gwp100". Learn more about calculation methods here.

    • source_trailarray 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.

    • co2_biogenicfloat or null

      The biogenic CO2 emissions associated with the consumed energy, expressed in kilograms (kg). This is not included in the co2e total.

    • audit_trailstring or absent

      Only present with "audit trail" feature. See Advanced audit trail. Not to be confused with our existing audit trail on other endpoints.

    • constituent_gasesEnergy constituent gases or null

      Breakdown of the main 3 greenhouse gases which constitute the co2e estimate, they may not sum to the whole co2e value in the case of other, non-itemized gases. A null means the emission factor used only provided co2e without a constituent gase breakdown.

Absence of Estimation model

Our older calculation endpoints always return the Estimation model which gives information about the emission factor that was used in the calculation and how it was applied, but we haven't implemented that for our newest features. This is because the complexity of the calculations performed by our new emissions calculators means that we are unable to explain the calculations adequately using the estimation model. Below are the new features which replace the Estimation model and which we are trialing on the Energy feature. If you have some requirements for calculation transparency please get in contact (opens in a new tab).

Constituent Gases

AttributeTypeDescription
co2numberEstimation of kg of CO2 emissions for the activity
ch4numberEstimation of kg of CH4 emissions for the activity
n2onumberEstimation of kg of N2O emissions for the activity

Advanced audit trailADD-ONADD-ON

A string containing all the information about the calculation we made, this can be stored for future verification purposes.

Audit trail feature

This is not included by default with the energy feature, and requires additionally the "audit trail" premium feature.

This is a trial format for recording information about our calculations for audit purposes that we are trialing for the energy feature. The intention for this data is for use by people who are verifying the estimations, so it contains all the important information about the calculation which was actually performed and which would make reproduction easy.

We intend to improve this feature over time and that will involve changing the format of the data within string in undefined ways, and so the audit_trail string should not be used in a programmatic way in a live application which is sensitive to breakage. Instead, we recommend that you only store the string, alongside the result and your parameters, and it is used offline in conjunction with our documentation.

Usage

We don't currently provide any tooling for this audit trail, currently we recommend that you take your unescaped audit_trail string and paste it into the MathJAX demo tool (opens in a new tab). The tool will format the Asciimath markup into mathematical notation in your browser, which should be enough to understand the calculation which was made.

It will show a number of variable assignments with subscript descriptions.

Key to variable symbols:

SymbolDescription
EEstimation result, showing how it was calculated, Efossil or Ebiogenic for the final estimation and with other subscripts for any component estimations which are summed to the final one.
IIntermediate calculation, separated to make the E formula easier to read
FEmissions factor, with a subscript either explaining it's role in the calculation or it's Climatiq ID
COther constant, with a subscript explaining it's role in the calculation
PParameter, something that the client provided in the request, with a subscript explaining which parameter it is

The other thing you may see is a notice, which are likely the same as the notices described below in a more machine-readable way. In audit trail, they identify a specific part of the calculation or a specific parameter and give more details as to why it is being used. It is usually for where we have incomplete data or edge cases of our methodology.

Here is an example of how a rendered audit trail could look, this is more complicated than most outputs and is intended to show all the features you could encounter. This example has also been edited to fit more easily on the page:

Rendered audit trail example

Notice

The notices array can contain objects like these:

Notice attributesTypeDescription
severitystringEither warning or info. warning is for messages that might lead to inaccurate calculations. You should check these to make sure the results are fit for your intended purpose. info is for information that will help you understand the calculation result better.
messagestringAn explanation of the notice.
codestringA machine-readable categorization of the notice to allow automatic handling.

The different possible values for code are as follows. You should not treat this list as exhaustive as more values may be added with time:

For Electricity

Notice code valuedescription
supplier_mix_used_for_residualA grid mix factor was used in place of a residual factor, this will lead to an underestimated market estimate.
general_wtt_used_for_specific_factorThe generic regional WTT% was used for a specific market factor, an energy_source should be provided for a better WTT estimate
ignored_parameterA parameter in the request was ignored in favor of some more precise piece of data
recs_subtracted_market_generationMarket components were subtracted for recs
recs_subtracted_market_transmission_and_distributionMarket T&D components were subtracted for recs

For Fuel Combustion

Notice code valuedescription
no_region_matchThe requested region was not matched
no_fuel_use_matchThe requested fuel_use was not matched
wtt_not_estimatedError when trying to estimate WTT, WTT estimate will be empty
Autopilot (preview 1)Energy v1 (preview 1)