Carbon Intensity - Ismena website

info@ismena.com

Carbon Intensity

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Carbon Intensity Connector facilitates seamless integration with the Carbon Intensity API for Great Britain developed by National Energy System Operator (NESO), providing access to national and regional carbon intensity data, generation mix, factors, and statistics. This connector acts as a proxy to streamline data retrieval, supporting actions for retrieving intensity, factors, statistics, generation mix, and regional data. This supports JSON response format and is tailored for Google Cloud Platform (GCP) deployments.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Carbon Intensity Connector for GCP.

Supported Integration Action Points

getCurrentIntensity: Retrieves carbon intensity for the current half hour.
getTodayIntensity: Retrieves carbon intensity for today.
getDateIntensity: Retrieves carbon intensity for a specific date.
getDatePeriodIntensity: Retrieves carbon intensity for a specific date and period.
getSpecificPeriodIntensity: Retrieves carbon intensity for a specific half-hour period.
get24hForwardIntensity: Retrieves carbon intensity 24 hours forward from a datetime.
get48hForwardIntensity: Retrieves carbon intensity 48 hours forward from a datetime.
get24hPastIntensity: Retrieves carbon intensity 24 hours past from a datetime.
getRangeIntensity: Retrieves carbon intensity between two datetimes.
getRangeStats: Retrieves carbon intensity statistics between two datetimes.
getBlockStats: Retrieves block average carbon intensity statistics.
getIntensityFactors: Retrieves carbon intensity factors for each fuel type.
getCurrentGeneration: Retrieves generation mix for the current half hour.
get24hPastGeneration: Retrieves generation mix for the past 24 hours.
getRangeGeneration: Retrieves generation mix between two datetimes.
getCurrentRegional: Retrieves carbon intensity for current half hour for GB regions.
getCurrentEngland: Retrieves carbon intensity for current half hour for England.
getCurrentScotland: Retrieves carbon intensity for current half hour for Scotland.
getCurrentWales: Retrieves carbon intensity for current half hour for Wales.
getCurrentPostcode: Retrieves carbon intensity for current half hour for a postcode.
get48hForwardRegional: Retrieves carbon intensity for next 48 hours for a region.
get24hPastRegional: Retrieves carbon intensity for past 24 hours for all GB regions.
get24hPastPostcode: Retrieves carbon intensity for past 24 hours for a postcode.
get24hPastRegionID: Retrieves carbon intensity for past 24 hours for a specific region.
getRangeRegional: Retrieves carbon intensity between datetimes for GB regions.
getRangePostcode: Retrieves carbon intensity between datetimes for a postcode.
getRangeRegionID: Retrieves carbon intensity between datetimes for a specific region.
getCurrentRegionalByID: Retrieves carbon intensity for current half hour by region ID.
getCurrentPostcodeByID: Retrieves carbon intensity for current half hour by postcode and region ID.
get48hForwardPostcode: Retrieves carbon intensity for next 48 hours for a postcode.
get48hForwardRegionID: Retrieves carbon intensity for next 48 hours for a region ID.
get24hPastPostcodeByID: Retrieves carbon intensity for past 24 hours for a postcode by region ID.
getRangePostcodeByID: Retrieves carbon intensity between datetimes for a postcode by region ID.

Detailed Integration Documentation

Current Intensity Retrieval

Action	getCurrentIntensity
Purpose	Retrieves carbon intensity data for the current half-hour period in Great Britain, useful for real-time energy monitoring on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable (default: https://api.carbonintensity.org.uk).
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T03:00Z) to: End time (string, e.g., 2025-08-18T03:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentIntensity with no parameters. Process the response to display real-time carbon intensity in a GCP dashboard. Use the data for immediate energy usage decisions.

Today Intensity Retrieval

Action	getTodayIntensity
Purpose	Retrieves carbon intensity data for today, useful for daily energy planning on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T00:00Z) to: End time (string, e.g., 2025-08-18T00:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getTodayIntensity with no parameters. Process the response to analyze daily intensity trends. Integrate into a GCP-based energy report.

Specific Date Intensity Retrieval

Action	getDateIntensity
Purpose	Retrieves carbon intensity data for a specific date, useful for historical analysis on GCP.
Parameters	Required: date (string, YYYY-MM-DD, e.g., 2025-08-18) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T00:00Z) to: End time (string, e.g., 2025-08-18T00:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid date"})
Workflow Example	Execute getDateIntensity with date=2025-08-18. Process the response to review historical intensity data. Use in a GCP analytics pipeline for trend analysis.

Specific Date and Period Intensity Retrieval

Action	getDatePeriodIntensity
Purpose	Retrieves carbon intensity data for a specific date and half-hour settlement period, useful for granular historical analysis on GCP.
Parameters	Required: date: Date in YYYY-MM-DD format (string, e.g., 2025-08-18) period: Half-hour settlement period (integer, 1-48, e.g., 42) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T20:30Z) to: End time (string, e.g., 2025-08-18T21:00Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid period"})
Workflow Example	Execute getDatePeriodIntensity with date=2025-08-18 and period=42. Process the response to analyze specific period intensity. Integrate into a GCP-based energy audit tool.

Specific Period Intensity Retrieval

Action	getSpecificPeriodIntensity
Purpose	Retrieves carbon intensity data for a specific half-hour period, useful for targeted analysis on GCP.
Parameters	Required: from (string, ISO8601, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute getSpecificPeriodIntensity with from=2025-08-18T12:00Z. Process the response to monitor specific period intensity. Use in a GCP real-time monitoring system.

24-Hour Forward Intensity Retrieval

Action	get24hForwardIntensity
Purpose	Retrieves carbon intensity data for 24 hours forward from a specific datetime, useful for short-term forecasting on GCP.
Parameters	Required: from (string, ISO8601, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute get24hForwardIntensity with from=2025-08-18T12:00Z. Process the response to forecast energy usage. Integrate into a GCP predictive analytics tool.

48-Hour Forward Intensity Retrieval

Action	get48hForwardIntensity
Purpose	Retrieves carbon intensity data for 48 hours forward from a specific datetime, useful for medium-term forecasting on GCP.
Parameters	Required: from (string, ISO8601, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute get48hForwardIntensity with from=2025-08-18T12:00Z. Process the response to plan energy consumption. Use in a GCP-based forecasting dashboard.

24-Hour Past Intensity Retrieval

Action	get24hPastIntensity
Purpose	Retrieves carbon intensity data for 24 hours past from a specific datetime, useful for historical analysis on GCP.
Parameters	Required: from (string, ISO8601, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-17T12:00Z) to: End time (string, e.g., 2025-08-17T12:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute get24hPastIntensity with from=2025-08-18T12:00Z. Process the response to analyze past intensity trends. Integrate into a GCP historical data pipeline.

Range Intensity Retrieval

Action	getRangeIntensity
Purpose	Retrieves carbon intensity data between two datetimes (up to 14 days), useful for custom range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) intensity: Object with forecast (integer, e.g., 266), actual (integer, e.g., 263), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Date range exceeds 14 days"})
Workflow Example	Execute getRangeIntensity with from=2025-08-18T00:00Z and to=2025-08-19T00:00Z. Process the response to analyze intensity over the period. Use in a GCP analytics application.

Range Statistics Retrieval

Action	getRangeStats
Purpose	Retrieves carbon intensity statistics (max, average, min) between two datetimes (up to 30 days), useful for trend analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) intensity: Object with max (integer, e.g., 320), average (integer, e.g., 266), min (integer, e.g., 180), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid date range"})
Workflow Example	Execute getRangeStats with from=2025-08-18T00:00Z and to=2025-08-19T00:00Z. Process the response to calculate statistical trends. Use in a GCP-based reporting tool.

Block Statistics Retrieval

Action	getBlockStats
Purpose	Retrieves block average carbon intensity statistics (max, average, min) between two datetimes (up to 30 days), useful for aggregated analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) block: Block length in hours (integer, 1-24, e.g., 2) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T14:00Z) intensity: Object with max (integer, e.g., 320), average (integer, e.g., 266), min (integer, e.g., 180), index (string, e.g., moderate) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid block length"})
Workflow Example	Execute getBlockStats with from=2025-08-18T00:00Z, to=2025-08-19T00:00Z, and block=2. Process the response to analyze block averages. Integrate into a GCP analytics dashboard.

Intensity Factors Retrieval

Action	getIntensityFactors
Purpose	Retrieves carbon intensity factors for each fuel type, essential for emissions calculations on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing fuel types and factors, e.g., Biomass: 120, Coal: 937, Dutch Imports: 474 Failure: Returns error details (e.g., error: {code: "500 Internal Server Error", message: "Server unavailable"})
Workflow Example	Execute getIntensityFactors with no parameters. Parse the factors to compute emissions for a generation mix. Integrate into a GCP sustainability report.

Current Generation Mix Retrieval

Action	getCurrentGeneration
Purpose	Retrieves the generation mix for the current half hour, useful for real-time energy source analysis on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T03:00Z) to: End time (string, e.g., 2025-08-18T03:30Z) generationmix: Array of objects with fuel (string, e.g., gas) and perc (float, e.g., 41.6) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentGeneration with no parameters. Process the response to visualize current fuel mix. Use in a GCP energy monitoring tool.

24-Hour Past Generation Mix Retrieval

Action	get24hPastGeneration
Purpose	Retrieves the generation mix for the past 24 hours, useful for historical source analysis on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-17T12:00Z) to: End time (string, e.g., 2025-08-17T12:30Z) generationmix: Array of objects with fuel (string, e.g., gas) and perc (float, e.g., 41.6) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute get24hPastGeneration with from=2025-08-18T12:00Z. Process the response to analyze past fuel mix trends. Integrate into a GCP historical data pipeline.

Range Generation Mix Retrieval

Action	getRangeGeneration
Purpose	Retrieves the generation mix between two datetimes (up to 14 days), useful for custom range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) generationmix: Array of objects with fuel (string, e.g., gas) and perc (float, e.g., 41.6) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Date range exceeds 14 days"})
Workflow Example	Execute getRangeGeneration with from=2025-08-18T00:00Z and to=2025-08-19T00:00Z. Process the response to analyze fuel mix over the period. Use in a GCP analytics application.

Current Regional Intensity Retrieval

Action	getCurrentRegional
Purpose	Retrieves carbon intensity data for the current half hour for all GB regions, useful for regional energy monitoring on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T03:00Z) to: End time (string, e.g., 2025-08-18T03:30Z) regions: Array of objects with regionid (integer, e.g., 3), dnoregion (string, e.g., Electricity North West), shortname (string, e.g., North West England), intensity (object with forecast and index), and generationmix (array of fuel/perc objects) Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentRegional with no parameters. Process the response to display regional intensity data. Integrate into a GCP regional energy dashboard.

Current England Intensity Retrieval

Action	getCurrentEngland
Purpose	Retrieves carbon intensity data for the current half hour for England, useful for country-specific analysis on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 15) dnoregion: String (e.g., England) shortname: String (e.g., England) data: Array of objects with from, to, intensity (object with forecast and index), and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentEngland with no parameters. Process the response to monitor England’s intensity. Use in a GCP country-specific dashboard.

Current Scotland Intensity Retrieval

Action	getCurrentScotland
Purpose	Retrieves carbon intensity data for the current half hour for Scotland, useful for country-specific analysis on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 16) dnoregion: String (e.g., Scotland) shortname: String (e.g., Scotland) data: Array of objects with from, to, intensity (object with forecast and index), and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentScotland with no parameters. Process the response to monitor Scotland’s intensity. Use in a GCP country-specific dashboard.

Current Wales Intensity Retrieval

Action	getCurrentWales
Purpose	Retrieves carbon intensity data for the current half hour for Wales, useful for country-specific analysis on GCP.
Parameters	Required: None Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 17) dnoregion: String (e.g., Wales) shortname: String (e.g., Wales) data: Array of objects with from, to, intensity (object with forecast and index), and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid request"})
Workflow Example	Execute getCurrentWales with no parameters. Process the response to monitor Wales’ intensity. Use in a GCP country-specific dashboard.

Current Postcode Intensity Retrieval

Action	getCurrentPostcode
Purpose	Retrieves carbon intensity data for the current half hour for a specified postcode, useful for localized analysis on GCP.
Parameters	Required: postcode: Outward postcode (string, e.g., RG41) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity (object with forecast and index), and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute getCurrentPostcode with postcode=RG41. Process the response to monitor local intensity. Integrate into a GCP localized energy app.

48-Hour Forward Regional Intensity Retrieval

Action	get48hForwardRegional
Purpose	Retrieves carbon intensity data for the next 48 hours for a specific region, useful for regional forecasting on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) data: Array of objects with from, to, intensity (object with forecast and index), and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid region ID"})
Workflow Example	Execute get48hForwardRegional with from=2025-08-18T12:00Z and regionid=3. Process the response to forecast regional intensity. Use in a GCP regional planning tool.

24-Hour Past Regional Intensity Retrieval

Action	get24hPastRegional
Purpose	Retrieves carbon intensity data for the past 24 hours for all GB regions, useful for historical regional analysis on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-17T12:00Z) to: End time (string, e.g., 2025-08-17T12:30Z) regions: Array of objects with regionid, dnoregion, shortname, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid datetime"})
Workflow Example	Execute get24hPastRegional with from=2025-08-18T12:00Z. Process the response to analyze past regional trends. Integrate into a GCP historical data pipeline.

24-Hour Past Postcode Intensity Retrieval

Action	get24hPastPostcode
Purpose	Retrieves carbon intensity data for the past 24 hours for a specific postcode, useful for localized historical analysis on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) postcode: Outward postcode (string, e.g., RG41) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute get24hPastPostcode with from=2025-08-18T12:00Z and postcode=RG41. Process the response to analyze local historical trends. Use in a GCP localized analytics app.

24-Hour Past Region ID Intensity Retrieval

Action	get24hPastRegionID
Purpose	Retrieves carbon intensity data for the past 24 hours for a specific region ID, useful for regional historical analysis on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid region ID"})
Workflow Example	Execute get24hPastRegionID with from=2025-08-18T12:00Z and regionid=3. Process the response to analyze regional historical trends. Integrate into a GCP regional analytics tool.

Range Regional Intensity Retrieval

Action	getRangeRegional
Purpose	Retrieves carbon intensity data between two datetimes for all GB regions (up to 14 days), useful for regional range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: from: Start time (string, e.g., 2025-08-18T12:00Z) to: End time (string, e.g., 2025-08-18T12:30Z) regions: Array of objects with regionid, dnoregion, shortname, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Date range exceeds 14 days"})
Workflow Example	Execute getRangeRegional with from=2025-08-18T00:00Z and to=2025-08-19T00:00Z. Process the response to analyze regional trends. Use in a GCP regional analytics application.

Range Postcode Intensity Retrieval

Action	getRangePostcode
Purpose	Retrieves carbon intensity data between two datetimes for a specific postcode (up to 14 days), useful for localized range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) postcode: Outward postcode (string, e.g., RG41) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute getRangePostcode with from=2025-08-18T00:00Z, to=2025-08-19T00:00Z, and postcode=RG41. Process the response to analyze local trends. Integrate into a GCP localized analytics app.

Range Region ID Intensity Retrieval

Action	getRangeRegionID
Purpose	Retrieves carbon intensity data between two datetimes for a specific region ID (up to 14 days), useful for regional range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid region ID"})
Workflow Example	Execute getRangeRegionID with from=2025-08-18T00:00Z, to=2025-08-19T00:00Z, and regionid=3. Process the response to analyze regional trends. Use in a GCP regional analytics tool.

Current Regional Intensity by Region ID Retrieval

Action	getCurrentRegionalByID
Purpose	Retrieves carbon intensity data for the current half hour by region ID, useful for targeted regional monitoring on GCP.
Parameters	Required: regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid region ID"})
Workflow Example	Execute getCurrentRegionalByID with regionid=3. Process the response to monitor regional intensity. Integrate into a GCP regional dashboard.

Current Postcode Intensity by Region ID Retrieval

Action	getCurrentPostcodeByID
Purpose	Retrieves carbon intensity data for the current half hour by postcode and region ID, useful for precise localized monitoring on GCP.
Parameters	Required: postcode: Outward postcode (string, e.g., RG41) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute getCurrentPostcodeByID with postcode=RG41 and regionid=3. Process the response to monitor local intensity. Use in a GCP localized monitoring app.

48-Hour Forward Postcode Intensity Retrieval

Action	get48hForwardPostcode
Purpose	Retrieves carbon intensity data for the next 48 hours for a specific postcode, useful for localized forecasting on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) postcode: Outward postcode (string, e.g., RG41) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute get48hForwardPostcode with from=2025-08-18T12:00Z and postcode=RG41. Process the response to forecast local intensity. Integrate into a GCP localized planning tool.

48-Hour Forward Region ID Intensity Retrieval

Action	get48hForwardRegionID
Purpose	Retrieves carbon intensity data for the next 48 hours for a specific region ID, useful for regional forecasting on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid region ID"})
Workflow Example	Execute get48hForwardRegionID with from=2025-08-18T12:00Z and regionid=3. Process the response to forecast regional intensity. Use in a GCP regional forecasting tool.

24-Hour Past Postcode Intensity by Region ID Retrieval

Action	get24hPastPostcodeByID
Purpose	Retrieves carbon intensity data for the past 24 hours for a specific postcode by region ID, useful for precise localized historical analysis on GCP.
Parameters	Required: from: Datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) postcode: Outward postcode (string, e.g., RG41) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute get24hPastPostcodeByID with from=2025-08-18T12:00Z, postcode=RG41, and regionid=3. Process the response to analyze local historical trends. Integrate into a GCP localized analytics app.

Range Postcode Intensity by Region ID Retrieval

Action	getRangePostcodeByID
Purpose	Retrieves carbon intensity data between two datetimes for a specific postcode by region ID (up to 14 days), useful for precise localized range analysis on GCP.
Parameters	Required: from: Start datetime in ISO8601 format (string, e.g., 2025-08-18T12:00Z) to: End datetime in ISO8601 format (string, e.g., 2025-08-19T12:00Z) postcode: Outward postcode (string, e.g., RG41) regionid: Region ID (string, e.g., 3) Optional: format: Response format (string, enum: [json], default: json)
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_CARBONINTENSITY_BASE_URL environment variable.
Output	Successful: data: Array of objects containing: regionid: Integer (e.g., 3) dnoregion: String (e.g., Electricity North West) shortname: String (e.g., North West England) postcode: String (e.g., RG41) data: Array of objects with from, to, intensity, and generationmix Failure: Returns error details (e.g., error: {code: "400 Bad Request", message: "Invalid postcode"})
Workflow Example	Execute getRangePostcodeByID with from=2025-08-18T00:00Z, to=2025-08-19T00:00Z, postcode=RG41, and regionid=3. Process the response to analyze local trends over the period. Use in a GCP localized analytics application.

Workflow Creation with the Connector

Example Workflow: Energy Monitoring and Regional Analysis

Retrieve Carbon Intensity Factors	Use the getIntensityFactors action with no parameters to fetch carbon intensity factors for each fuel type. Identify key fuel types (e.g., Biomass, Coal, Solar) and their respective gCO2/kWh values for emissions calculations.
Query Current National Intensity	Execute the getCurrentIntensity action with no parameters to fetch the current half-hour carbon intensity data for Great Britain. Process the response to display real-time national carbon intensity (forecast, actual, and index) in a GCP-based energy dashboard.
Analyze Regional Intensity Trends	Use the get24hPastRegional action with from=2025-08-18T08:00Z to retrieve carbon intensity data for the past 24 hours across all GB regions. Integrate the regional data into a GCP analytics application to visualize and compare carbon intensity trends by region, aiding in localized energy planning.

This workflow enables applications to provide users with accurate national and regional carbon intensity data, enhancing energy monitoring, emissions analysis, and regional planning capabilities on Google Cloud Platform.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event