Building Block Definitions 2024
Building Block Definitions 2024
CKAN Data API
Access resource data via a web API with powerful query support.
Further information in the main CKAN Data API and DataStore documentation.
The Data API can be accessed via the following actions of the CKAN action API.
Query example (first 5 results) |
---|
https://api.neso.energy/api/3/action/datastore_search?resource_id=778a505c-1972-463b-b4bf-53e33c4d3470&limit=5
|
Query example (via SQL statement) |
https://api.neso.energy/api/3/action/datastore_search_sql?sql=SELECT * from "778a505c-1972-463b-b4bf-53e33c4d3470" LIMIT 5
|
A simple ajax (JSONP) request to the data API using jQuery.
var data = { resource_id: '778a505c-1972-463b-b4bf-53e33c4d3470', // the resource id limit: 5 // get 5 results }; $.ajax({ url: 'https://api.neso.energy/api/3/action/datastore_search', data: data, dataType: 'jsonp', success: function(data) { alert('Total results found: ' + data.result.total) } });
A simple ajax (JSONP) request to the data API using jQuery.
import urllib2 url = 'https://api.neso.energy/api/3/action/datastore_search?resource_id=778a505c-1972-463b-b4bf-53e33c4d3470&limit=5' fileobj = urllib2.urlopen(url) print fileobj.read()
Data Explorer
Data Explorer
Table Information
Template
Title | Template |
---|---|
Type | string |
Description | The area that this data relates to |
Comment | |
Example | Generation |
Unit | MW |
Technology
Title | Technology |
---|---|
Type | string |
Description | Lower level of categorisation after template level |
Comment | |
Example | Non-renewable CHP |
Unit | MW |
Building Block ID Number
Title | Building Block ID Number |
---|---|
Type | string |
Description | Code identifying this building block |
Comment | |
Example | Gen_BB001 |
Unit | MW |
Technology Detail
Title | Technology Detail |
---|---|
Type | string |
Description | Further information on what this building block contains |
Comment | |
Example | Offshore Wind |
Unit | MW |
Units
Title | Units |
---|---|
Type | string |
Description | The units that this building block is in |
Comment | |
Example | MW |
Unit | MW |
Detail
Title | Detail |
---|---|
Type | string |
Description | Description of what this building block contains |
Comment | |
Example | Installed capacity |
Unit | MW |
Comments
Title | Comments |
---|---|
Type | string |
Description | Further information on what is included in this building block |
Comment | |
Example | Non-renewable excluding domestic Micro CHP |
Unit |
Alignment with Ofgem Core Scenario Key Drivers
Title | Alignment with Ofgem Core Scenario Key Drivers |
---|---|
Type | string |
Description | Alignment with Ofgem Core Scenario Key Drivers |
Comment | |
Example | |
Unit |