Carbon intensity of Great Britain's electricity (gCO2/kWh) with index (very low to very high) and generation mix, national or for a region or outward postcode: now, from a time, or a half-hourly forecast up to 48 hours.
Every response includes credits_used: the credits this call cost.
Parameters
name
type
description
postcode
string
Outward postcode (e.g. SW1A, RG10) for its region. Example: SW1A
region_id
integer
Region id 1-17 (see /energy/v1/carbon-regions).
hours
integer
Forecast hours ahead (1-48, half-hourly periods).
from
string
Start time (YYYY-MM-DDTHH:MMZ, default now); national with no hours: the 24 hours to this time.
import os, requests
res = requests.get(
"https://api.api.sh/energy/v1/carbon-intensity",
params={"postcode": "SW1A"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json()
const url = new URL("https://api.api.sh/energy/v1/carbon-intensity");
url.searchParams.set("postcode", "SW1A");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();
Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).
The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.