Climatiq · Schema

Climatiq Emission Estimate

Schema for the JSON object returned by Climatiq estimation endpoints. An emission estimate quantifies CO2-equivalent emissions for a single activity by combining a chosen emission factor with caller-supplied activity parameters such as energy used, distance travelled, money spent, or weight moved.

Carbon AccountingCarbon EmissionsClimateEnergyEnvironmentGHG ProtocolSustainability

Properties

Name	Type	Description
co2e	number	Total CO2-equivalent emissions for the activity, expressed in co2e_unit.
co2e_unit	string	Unit of measure for co2e (typically 'kg').
co2e_calculation_method	string	Calculation methodology used for the estimate (for example, ar4, ar5, ar6).
co2e_calculation_origin	string	Source of the calculation (for example, source for factors derived directly from a referenced source).
emission_factor	object	Metadata describing the emission factor used to produce this estimate.
constituent_gases	object	Breakdown of the estimate into constituent greenhouse gases.
activity_data	object	Echo of the activity inputs used in the calculation.
audit_trail	string	Reference to the audit-trail entry recorded for this estimate when audit-trail is enabled.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://www.climatiq.io/schemas/emission-estimate.json",
  "title": "Climatiq Emission Estimate",
  "description": "Schema for the JSON object returned by Climatiq estimation endpoints. An emission estimate quantifies CO2-equivalent emissions for a single activity by combining a chosen emission factor with caller-supplied activity parameters such as energy used, distance travelled, money spent, or weight moved.",
  "type": "object",
  "required": ["co2e", "co2e_unit"],
  "properties": {
    "co2e": {
      "type": "number",
      "description": "Total CO2-equivalent emissions for the activity, expressed in co2e_unit."
    },
    "co2e_unit": {
      "type": "string",
      "description": "Unit of measure for co2e (typically 'kg').",
      "examples": ["kg"]
    },
    "co2e_calculation_method": {
      "type": "string",
      "description": "Calculation methodology used for the estimate (for example, ar4, ar5, ar6).",
      "enum": ["ar4", "ar5", "ar6"]
    },
    "co2e_calculation_origin": {
      "type": "string",
      "description": "Source of the calculation (for example, source for factors derived directly from a referenced source)."
    },
    "emission_factor": {
      "type": "object",
      "description": "Metadata describing the emission factor used to produce this estimate.",
      "properties": {
        "name": {"type": "string"},
        "activity_id": {"type": "string"},
        "id": {"type": "string"},
        "access_type": {"type": "string"},
        "source": {"type": "string"},
        "source_dataset": {"type": "string"},
        "year": {"type": "integer"},
        "region": {"type": "string"},
        "category": {"type": "string"},
        "source_lca_activity": {"type": "string"},
        "data_quality_flags": {
          "type": "array",
          "items": {"type": "string"}
        }
      }
    },
    "constituent_gases": {
      "type": "object",
      "description": "Breakdown of the estimate into constituent greenhouse gases.",
      "properties": {
        "co2e_total": {"type": ["number", "null"]},
        "co2e_other": {"type": ["number", "null"]},
        "co2": {"type": ["number", "null"]},
        "ch4": {"type": ["number", "null"]},
        "n2o": {"type": ["number", "null"]}
      }
    },
    "activity_data": {
      "type": "object",
      "description": "Echo of the activity inputs used in the calculation.",
      "properties": {
        "activity_value": {"type": "number"},
        "activity_unit": {"type": "string"}
      }
    },
    "audit_trail": {
      "type": "string",
      "description": "Reference to the audit-trail entry recorded for this estimate when audit-trail is enabled."
    }
  },
  "additionalProperties": true
}