DFES Profiles

This resource view is not available at the moment. Click here for more information.

Download resource

Integrate this resource

Access this data via a web API. Further information in the CKAN API guide (opens in new tab).

Endpoints

The Data API can be accessed via the following actions of the CKAN action API.

Create
https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_create

Update / Insert
https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_upsert

Query
https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search

Querying
First 5 results:
https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search?resource_id=bc4bfcb3-6ec3-400e-a4c3-3f73e3627802&limit=5

Results containing 'jones':
https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search?resource_id=bc4bfcb3-6ec3-400e-a4c3-3f73e3627802&q=jones

Examples
  
    curl -X POST 'https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search' \
      -H "Content-Type: application/json" \
      -d '{
        "resource_id": "bc4bfcb3-6ec3-400e-a4c3-3f73e3627802",
        "limit": 5,
        "q": "jones"
      }'
  
  
    using System;
    using System.Net.Http;
    using System.Text;
    using System.Text.Json;
    using System.Threading.Tasks;

    var data = new {
      resource_id = "bc4bfcb3-6ec3-400e-a4c3-3f73e3627802", // the resource id
      limit = 5, // get 5 results
      q = "jones" // query for 'jones'
    };

    var url = "https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search";

    using var client = new HttpClient();
    var json = JsonSerializer.Serialize(data);
    var content = new StringContent(json, Encoding.UTF8, "application/json");

    try {
      var response = await client.PostAsync(url, content);
      response.EnsureSuccessStatusCode();
      var responseBody = await response.Content.ReadAsStringAsync();
      var result = JsonSerializer.Deserialize<JsonElement>(responseBody);
      Console.WriteLine($"Total results found: {result.GetProperty("result").GetProperty("total")}");
    } catch (HttpRequestException e) {
      Console.WriteLine($"Error fetching data: {e.Message}");
    }
  
  
    const data = {
      resource_id: 'bc4bfcb3-6ec3-400e-a4c3-3f73e3627802', // the resource id
      limit: 5, // get 5 results
      q: 'jones' // query for 'jones'
    };

    const url = new URL('https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search');
    Object.keys(data).forEach(key => url.searchParams.append(key, data[key]));

    fetch(url)
      .then(response => response.json())
      .then(result => {
        console.log('Total results found: ' + result.result.total);
      })
      .catch(error => {
        console.error('Error fetching data:', error);
      });
  
  
    import urllib.request
    import urllib.error
    import json

    url = 'https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search?resource_id=bc4bfcb3-6ec3-400e-a4c3-3f73e3627802&limit=5&q=title:jones'  
    
    try:
        with urllib.request.urlopen(url) as response:
            data = json.loads(response.read().decode('utf-8'))
            print(f"Total results found: {data['result']['total']}")
    except urllib.error.URLError as e:
        print(f"Error fetching data: {e}")
  
  
    $data = [
      'resource_id' => 'bc4bfcb3-6ec3-400e-a4c3-3f73e3627802', // the resource id
      'limit' => 5, // get 5 results
      'q' => 'jones' // query for 'jones'
    ];

    $url = 'https://connecteddata.nationalgrid.co.uk/api/3/action/datastore_search';

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode === 200) {
      $result = json_decode($response, true);
      echo "Total results found: " . $result['result']['total'];
    } else {
      echo "Error fetching data: HTTP " . $httpCode;
    }
  

Data Dictionary

Data Dictionary: Column definitions and metadata for this resource
Column Type Label Description Example
output numeric Units provided in output_units column against that entry.

Demand or export as determined by output_units column

1.60E-03
output_units text Not provided-

Units being used in the value column for that technology

MW demand per heat pump
profile_type text nan

Whether the profile is one of a customer who behaves in an unabated or flexed way.

Unabated
region text Not provided-

Licence area that the profile has been used in for forecasting

All
representative_day text Not provided-

Representative day / season

Winter peak demand
subtechnology text Not provided-

DFES subtechnology

Domestic - Non-hybrid ASHP
technology text Not provided-

DFES technology

Heat pumps
time text HH:MM

Mid-point of half hourly period

00:15:00