Carbon Intensity GB data contract

Provenance

PublisherCarbon Intensity GB

API basehttps://api.carbonintensity.org.uk/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationNo credentials required

Methods (3)

getIntensity

read

Get GB national carbon intensity (actual + forecast), optional time range.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "date": {
      "type": "string"
    },
    "period": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getRegionalIntensity

read

Get GB regional carbon intensity by region id or postcode.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "postcode": {
      "type": "string"
    },
    "regionid": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getGenerationMix

read

Get GB generation mix by fuel type, optional time range.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "window": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "fw24h"
          ]
        },
        {
          "type": "string",
          "enum": [
            "fw48h"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pt24h"
          ]
        }
      ]
    }
  },
  "additionalProperties": false
}