Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Carbon Intensity API

Carbon Intensity API Regional API

Regional carbon intensity and generation mix data (beta)

Documentation Provider Profile APIs.io OpenAPI GitHub

Carbon Intensity API Regional API is one of 5 APIs that Carbon Intensity API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Regional. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, rate-limit docs, and 4 JSON Schemas.

This API exposes 13 operations across 13 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.carbonintensity.org.uk.

13 operations 13 paths 12 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.carbonintensity.org.uk
Contact
Carbon Intensity API Support
License
Creative Commons Attribution 4.0 International (CC BY 4.0)
Terms of Service
View terms
Resource Areas
1

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

Regional 13

Regional carbon intensity and generation mix data (beta)

GET
/regional
Get current carbon intensity for all regions
getAllRegionsIntensity → 200400500
GET
/regional/england
Get current carbon intensity for England
getEnglandIntensity → 200400500
GET
/regional/scotland
Get current carbon intensity for Scotland
getScotlandIntensity → 200400500
GET
/regional/wales
Get current carbon intensity for Wales
getWalesIntensity → 200400500
GET
/regional/postcode/{postcode}
Get carbon intensity for a specific postcode
getIntensityByPostcode 1 param → 200400500
GET
/regional/regionid/{regionid}
Get carbon intensity for a specific region ID
getIntensityByRegionId 1 param → 200400500
GET
/regional/{from}/{to}
Get regional carbon intensity for a date/time range
getRegionalIntensityRange 2 params → 200400500
GET
/regional/intensity/{from}/fw24h/postcode/{postcode}
Get 24-hour forward regional intensity forecast by postcode
getRegionalForward24hByPostcode 2 params → 200400500
GET
/regional/intensity/{from}/fw24h/regionid/{regionid}
Get 24-hour forward regional intensity forecast by region ID
getRegionalForward24hByRegionId 2 params → 200400500
GET
/regional/intensity/{from}/fw48h/postcode/{postcode}
Get 48-hour forward regional intensity forecast by postcode
getRegionalForward48hByPostcode 2 params → 200400500
GET
/regional/intensity/{from}/fw48h/regionid/{regionid}
Get 48-hour forward regional intensity forecast by region ID
getRegionalForward48hByRegionId 2 params → 200400500
GET
/regional/intensity/{from}/pt24h/postcode/{postcode}
Get 24-hour historical regional intensity by postcode
getRegionalPast24hByPostcode 2 params → 200400500
GET
/regional/intensity/{from}/pt24h/regionid/{regionid}
Get 24-hour historical regional intensity by region ID
getRegionalPast24hByRegionId 2 params → 200400500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Region (5 properties), RegionByPostcode (5 properties), RegionById (4 properties), RegionDataPeriod (4 properties). Each schema is shown below with its type and property counts.

RegionDataPeriod
object
Carbon intensity and generation mix for a single time period within a region
4 properties
RegionById
object
Data for a specific DNO region with time-series data
4 properties
RegionByPostcode
object
Data for the DNO region containing the specified postcode
5 properties
Region
object
Data for a single DNO region
5 properties
GenerationMixItem
object
Generation percentage for a single fuel type
2 properties
RegionalResponse
object
Response containing regional carbon intensity data
1 property
PostcodeResponse
object
Response containing data for the region matching a postcode
1 property
RegionalIntensity
object
Regional carbon intensity data
2 properties
ErrorResponse
object
Error response wrapper
1 property
RegionIdResponse
object
Response containing data for a specific region
1 property
RegionalPeriod
object
Regional carbon intensity data for a time period
3 properties
Error
object
Error response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

carbon-intensity-regional-api-openapi.yml Raw ↑

Other APIs Carbon Intensity API publishes across the network.

Carbon Intensity API Factors API
AE Profile APIs.io
Carbon Intensity API Generation Mix API
AE Profile APIs.io
Carbon Intensity API National Intensity API
AE Profile APIs.io
Carbon Intensity API Statistics API
AE Profile APIs.io
#Regional
← Back to C APIs
API Details
ID
carbon-intensity:carbon-intensity-regional-api
Base URL
https://api.carbonintensity.org.uk
Docs
https://carbonintensity.org.uk/
Provider
Carbon Intensity API
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network