Discovery

Check — which published factor is each of your numbers, and is it still right?

Open (no key), up to 25 rows per request, limited per IP. Send the factors your inventory already uses, each as a description, the value AS TYPED (a string keeps its precision: "0.207" matches anything that rounds to it) and the unit as written. Each row comes back with the published factor it matches (source, edition, line), a status (current, outdated, fix, review, unverifiable, notcomparable), findings such as an old edition, old IPCC warming values, a 1,000x unit slip, net instead of gross calorific value or an upstream (WTT) factor used for combustion, and the current value to use instead. UK government factors carry every edition 2019-2026 except 2021; other sources are current-edition only, so a non-UK value can be identified but not yet called out of date. Nothing is substituted, and the request body is neither logged nor stored.

post/v1/check

Request

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

Request body

exampleboolean

Optional. Marks a request as a demonstration (our own page sends it for its worked example) so it is not counted as a check.

Example request

{
  "rows": [
    {
      "description": "Purchased electricity",
      "value": "0.19338",
      "unit": "kgCO2e/kWh"
    }
  ]
}

Response

One verdict per row, a status summary, the index the check ran against and its coverage

indexobject

What was checked against: build date, MasterBrain version, DEFRA editions held.

coveragestring

Plain statement of which sources carry edition history and which are current-only.

summaryobject

Row count per status.

Changes

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