Forecast NRSS prices

API change history

The forecast NRSS prices API provides a GET action and returns a set of forecast NRSS prices.

In order to use the forecast NRSS API you must subscribe to the Wholesale market prices API product to receive your API key.

The forecast NRSS prices API will return the following fields:

  • PointOfConnectionCode
  • TradingDate
  • TradingPeriodNumber
  • RunDateTime
  • DollarsPerMegawattHour

These fields should be self-explanatory. The RunDateTime field returns the date and time at which the prices were generated. As there will be several instances of a forecast price for any given point of connection, trading date and trading period, it will be necessary to make use of the RunDateTime field to distinguish one instance from another.

The database underlying the forecast price APIs contains data for the last 30 days. If data older than 30 days is required, users should download the zip files found here.

A policy has been applied to the wholesale price APIs restricting users to 60 calls per minute and a total of 60 MB of data per hour. The Authority may revise this policy if high rates of utilisation negatively impacts performance.

Forecast NRSS - GET

The GET action returns the latest set of NRSS prices as a JSON result set. Optionally the result set can be influenced by providing a range of OData filters on

  • PointOfConnectionCode
  • TradingDate
  • TradingPeriodNumber
  • DollarsPerMegawattHour

Some OData filter examples

  • For field PointOfConnectionCode, valid operators are: eq, and here are some examples:
    • $filter=PointOfConnectionCode eq 'AB1234'
  • For field TradingDate, valid operators are: eq, and here are some examples:
    • $filter=TradingDate eq datetime'2020-04-01T00:00'
  • For field TradingPeriodNumber, valid operators are: eq, le, ge, and here are some examples:
    • $filter=TradingPeriodNumber eq 15
    • $filter=TradingPeriodNumber ge 23
    • $filter=TradingPeriodNumber le 10
    • $filter=TradingPeriodNumber ge 1 and TradingPeriodNumber le 2
  • For field DollarsPerMegawattHour, valid operators are: eq, le, ge, and here are some examples:
    • $filter=DollarsPerMegawattHour eq 15.0M
    • $filter=DollarsPerMegawattHour ge 23.0M
    • $filter=DollarsPerMegawattHour le 10.0M
    • $filter=DollarsPerMegawattHour ge 1.4M and DollarsPerMegawattHour le 2.1M

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    ODATA to limit result set, eg ?$filter=DollarsPerMegawattHour eq 15.0M

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Forecast NRSS collection

Representations

[{
    "PointOfConnectionCode": "ABY0111",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 82.19
  },
  {
    "PointOfConnectionCode": "ALB0331",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 91.29
  },
  {
    "PointOfConnectionCode": "ALB1101",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 90.71
  },
  {
    "PointOfConnectionCode": "APS0111",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 82.92
  },
  {
    "PointOfConnectionCode": "ARA2201",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 85.09
  },
  {
    "PointOfConnectionCode": "ARG1101",
    "TradingDate": "2020-10-31T00:00:00",
    "TradingPeriodNumber": 40,
    "RunDateTime": "2020-10-31T16:03:01",
    "DollarsPerMegawattHour": 87.05
  }]

Code samples

@ECHO OFF

curl -v -X GET "https://emi.azure-api.net/forecast-nrss/?$filter={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--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.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["$filter"] = "{string}";
            var uri = "https://emi.azure-api.net/forecast-nrss/?" + 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://emi.azure-api.net/forecast-nrss/");

            builder.setParameter("$filter", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // 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
            "$filter": "{string}",
        };
      
        $.ajax({
            url: "https://emi.azure-api.net/forecast-nrss/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            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://emi.azure-api.net/forecast-nrss/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"$filter={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:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // 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://emi.azure-api.net/forecast-nrss/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '$filter' => '{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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    '$filter': '{string}',
})

try:
    conn = httplib.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/forecast-nrss/?%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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    '$filter': '{string}',
})

try:
    conn = http.client.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/forecast-nrss/?%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://emi.azure-api.net/forecast-nrss/')

query = URI.encode_www_form({
    # Request parameters
    '$filter' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# 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