Market Data - DayAhead

ReductionReasons

Request

Request URL

https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons[?deliveryarea][&deliveryareafrom][&deliveryareato][&startTime][&endTime]

Request parameters

deliveryarea (optional)

string

Used to filter content by area code (e.g. NO1, NO2, SE1, SE2, FI)
Full list of delivery areas
deliveryareafrom (optional)

string

Used to filter content by area code (e.g. NO1, NO2, SE1, SE2, FI)
deliveryareato (optional)

string

Used to filter content by area code (e.g. NO1, NO2, SE1, SE2, FI)
startTime (optional)

string

Format - date-time (as date-time in RFC3339). Used to select content for a given start time in UTC, with a special UTC designator('Z'). e.g. 2019-05-30T23:59:59Z
endTime (optional)

string

Format - date-time (as date-time in RFC3339). Used to select content for a given end time in UTC, with a special UTC designator('Z'). e.g. 2019-05-30T23:59:59Z

Request headers

Accept-Encoding (optional)

string

Used to compress content. e.g. 'gzip'
Authorization

string

OAuth 2.0 access token obtained from Nordpool SSO. Supported grant types: Resource owner password.

Responses

Bad Request. Please check that added header values are valid.

Sample
Schema

string

{
  "type": "string"
}

An unexpected error occurred.

Sample
Schema

string

{
  "type": "string"
}

Payload of Array of TimeSeriesDto

Sample
Schema

[
  {
    "SubType": "string",
    "values": [
      {
        "endTime": "string",
        "value": 0.0,
        "startTime": "string"
      }
    ],
    "category": "string",
    "startTime": "string",
    "unit": "string",
    "endTime": "string",
    "resolution": "string",
    "scale": 0,
    "createdTime": 0,
    "type": "string",
    "attributes": [
      {
        "value": "string",
        "name": "string",
        "role": "string"
      }
    ]
  }
]

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "SubType": {
        "type": "string"
      },
      "values": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "string",
              "format": "date-time"
            },
            "value": {
              "type": "number",
              "format": "double"
            },
            "startTime": {
              "type": "string",
              "format": "date-time"
            }
          }
        }
      },
      "category": {
        "type": "string"
      },
      "startTime": {
        "type": "string",
        "format": "date-time"
      },
      "unit": {
        "type": "string"
      },
      "endTime": {
        "type": "string",
        "format": "date-time"
      },
      "resolution": {
        "type": "string"
      },
      "scale": {
        "type": "integer",
        "format": "int32"
      },
      "createdTime": {
        "type": "integer",
        "format": "int64"
      },
      "type": {
        "type": "string"
      },
      "attributes": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "value": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "role": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

No data available

Sample
Schema

string

{
  "type": "string"
}

Too many requests in the system. Please refer to Retry-After header to wait for new requests.

Sample
Schema

string

{
  "type": "string"
}

Response field description can be found here.

Code samples

@ECHO OFF

curl -v -X GET "https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons?deliveryarea={string}&deliveryareafrom={string}&deliveryareato={string}&startTime={string}&endTime={string}"
-H "Accept-Encoding: "
-H "Authorization: {access token}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.AcceptEncoding.Add(StringWithQualityHeaderValue.Parse(""));
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["deliveryarea"] = "{string}";
            queryString["deliveryareafrom"] = "{string}";
            queryString["deliveryareato"] = "{string}";
            queryString["startTime"] = "{string}";
            queryString["endTime"] = "{string}";
            var uri = "https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons");

            builder.setParameter("deliveryarea", "{string}");
            builder.setParameter("deliveryareafrom", "{string}");
            builder.setParameter("deliveryareato", "{string}");
            builder.setParameter("startTime", "{string}");
            builder.setParameter("endTime", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Accept-Encoding", "");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "deliveryarea": "{string}",
            "deliveryareafrom": "{string}",
            "deliveryareato": "{string}",
            "startTime": "{string}",
            "endTime": "{string}",
        };
      
        $.ajax({
            url: "https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Accept-Encoding","");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"deliveryarea={string}",
                         @"deliveryareafrom={string}",
                         @"deliveryareato={string}",
                         @"startTime={string}",
                         @"endTime={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Accept-Encoding"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Accept-Encoding' => '',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'deliveryarea' => '{string}',
    'deliveryareafrom' => '{string}',
    'deliveryareato' => '{string}',
    'startTime' => '{string}',
    'endTime' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Accept-Encoding': '',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'deliveryarea': '{string}',
    'deliveryareafrom': '{string}',
    'deliveryareato': '{string}',
    'startTime': '{string}',
    'endTime': '{string}',
})

try:
    conn = httplib.HTTPSConnection('marketdata-api.nordpoolgroup.com')
    conn.request("GET", "/dayahead/capacities/reductionReasons?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Accept-Encoding': '',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'deliveryarea': '{string}',
    'deliveryareafrom': '{string}',
    'deliveryareato': '{string}',
    'startTime': '{string}',
    'endTime': '{string}',
})

try:
    conn = http.client.HTTPSConnection('marketdata-api.nordpoolgroup.com')
    conn.request("GET", "/dayahead/capacities/reductionReasons?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://marketdata-api.nordpoolgroup.com/dayahead/capacities/reductionReasons')

query = URI.encode_www_form({
    # Request parameters
    'deliveryarea' => '{string}',
    'deliveryareafrom' => '{string}',
    'deliveryareato' => '{string}',
    'startTime' => '{string}',
    'endTime' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Accept-Encoding'] = ''
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body