Factors

Browse/search the corpus (open — no key, values included)

get/v1/factors

Request

  • Base URL: https://api.greencalculus.com
  • URL: https://api.greencalculus.com/v1/factors
  • Auth: none required

Query parameters

searchstring

Free text. Every whitespace-separated word must appear in the row name or canonical key (dots/underscores/hyphens read as separators, so a pasted canonical key finds its own row). Results are relevance-ranked.

sectionstring
key_prefixstring

Anchors at the START of the dotted key — "electricity" matches nothing; use search for words appearing anywhere.

familystring

Taxonomy family slug (hyphenated). An unknown value returns 200 with an empty result and the valid families listed in meta.warnings.

limitinteger
offsetinteger
cursorstring

base64(canonical_key) from meta.next_cursor. Preferred over offset — stable across data-version bumps, and required for paging relevance-ordered search results.

Response

Matching factor keys, names, sections. meta.warnings explains any filter that matched nothing.

Example response

{
  "meta": {
    "gc_version": "2026.180",
    "gc_updated": "2026-08-19",
    "total": 82,
    "canonical_total": 16554
  },
  "factors": [
    {
      "key": "grid.gbr.electricity.location_based",
      "section": "grid",
      "activity_type": "purchased_energy",
      "factor": {
        "unit": "kg CO2e per kWh",
        "gas": "CO2e",
        "gwp_set": "AR5_100",
        "country_iso3": "gbr",
        "uncertainty": {
          "basis": "published"
        }
      },
      "source": {
        "id": "DEFRA_2026",
        "cell_ref": "'UK electricity'!E25",
        "retrieved": "2026-06-18"
      },
      "scope": {
        "ghg_protocol": "scope2"
      },
      "citation": {
        "text": "UK grid electricity — location-based (generation). UK Government GHG Conversion Factors 2026 — Department for Energy Security and Net Zero (DESNZ), cell 'UK electricity'!E25, retrieved 2026-06-18. via GreenCalculus data version 2026.186, factor grid.gbr.electricity.location_based. https://verify.greencalculus.com/grid.gbr.electricity.location_based@2026.186",
        "source_id": "DEFRA_2026",
        "cell_ref": "'UK electricity'!E25",
        "version": "2026.186",
        "proof_url": "https://verify.greencalculus.com/grid.gbr.electricity.location_based@2026.186"
      },
      "licence": {
        "name": "Open Government Licence v3.0"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.