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://api.climatiq.io/data/v1/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

This endpoint accepts the following parameters:

Request parametersShould be sent as a JSON object in the body
  • emission_factorrequired Selector

    Emission factor ID or selection parameters selector.

  • parametersrequired Parameters

    Emission factor parameters. The parameter object changes depending on the EF selected.

curl --request POST \
  --url https://api.climatiq.io/data/v1/estimate \
  --header "Authorization: Bearer $CLIMATIQ_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": 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"
}

Batch Estimate Endpoint

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://api.climatiq.io/data/v1/estimate/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.

ClassificationsCloud Computing