Calculate

Resolve — plain-text description → ranked factor keys + confidence

post/v1/calculate/resolve

Request

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

Request body

descriptionstring required

Plain-language description of the factor you need.

sectionstring

Optional. Restrict candidates to one MB section.

limitinteger

Optional. Number of ranked candidates to return.

Example request

{
  "description": "uk grid electricity",
  "section": "fuels"
}

Response

Ranked candidate factor keys with confidence scores. Each match carries country_iso3 and geo_match ("exact" | "global" | "proxy"); a "proxy" match is a factor from a different country than the one asked for, and its confidence is discounted accordingly.

methodologystring
querystring

The description as received.

country_iso3string nullable

The country parsed out of the description, or null.

tokensstring[]

How the description was tokenised — shown so a bad parse is visible rather than mysterious.

countinteger
absenceobject nullable

Present when nothing matched AND we hold a reasoned absence record explaining why — including the case where we DO hold it under another name.

notestring nullable
metaobject

Example response

{
  "methodology": "resolve",
  "matches": [
    {
      "confidence": 0.92,
      "scope": {
        "ghg_protocol": "scope2",
        "category": "purchased_electricity"
      },
      "basis": "direct combustion at the generator; generation basis — transmission and distribution losses EXCLUDED"
    }
  ]
}

Changes

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