Calculate

Scope 2 electricity — location + market (dual reporting)

post/v1/calculate/electricity

Request

  • Base URL: https://api.greencalculus.com
  • URL: https://api.greencalculus.com/v1/calculate/electricity
  • Auth: HTTP bearer

Query parameters

as_ofstring
Example:2026.175

Run this calculation against an ARCHIVED data version. Every factor used is the row as it stood at that version, and meta.gc_version, meta.version_pin, the citation and the receipt all report it. Unlike GET /v1/factors/{key}?as_of=, an unavailable version is REFUSED (400) rather than served from current data with a label: a calculation returns a single figure that goes into a report under a receipt, so it must be the version it claims. A factor key that did not exist yet at that version is refused for the same reason. Archived versions are listed in the error, and by GET /v1/factors/{key}?as_of= on a miss.

Request body

location_factor_keystring required
market_factor_keystring

Optional. Market-based factor (e.g. residual mix) for dual reporting.

countrystring

Optional. The country the ACTIVITY belongs to — ISO3, ISO2 or a name ("deu", "DE", "Germany"). When given, the response carries factor.resolution stating whether the factor used is published for that country (tier: exact), is a global figure applied to it (global), or belongs to a different country (proxy, with proxy_of naming which). Omit it and no geography claim is made — the response is unchanged. A country we do not recognise yields no claim rather than a wrong one.

Example request

{
  "consumption": {
    "unit": "kWh"
  },
  "location_factor_key": "grid.gbr.electricity.location_based",
  "market_factor_key": "grid.gbr.electricity.residual_mix",
  "supplier_factor": {
    "unit": "kg CO2e per kWh"
  },
  "country": "deu"
}

Response

Location- and (if given) market-based emissions + working + source

methodologystring
standardstring
market_basedobject nullable

null when no market instrument was supplied — the absence of a market figure, not a zero.

scopeobject nullable
notestring nullable
proof_urlsstring[]

Every factor used by this answer, as a public proof URL pinned to the data version. A portfolio calculation may list many; cite per line from here. Contains no request data — each URL is a fact about the GreenCalculus corpus and is identical for every caller.

Example response

{
  "methodology": "electricity",
  "standard": "GHG Protocol Scope 2 Guidance — location-based + market-based",
  "location_based": {
    "method": "location-based (grid average)"
  },
  "meta": {
    "gc_version": "2026.180",
    "gc_updated": "2026-08-19"
  },
  "receipt": {
    "id": "gcr_5a7b64dfa501bfea508cba7d0e5d8d03…",
    "algorithm": "sha256",
    "mb_version": "2026.180"
  }
}

Changes

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