<p>The real-time dispatch API provides a GET action and returns a set of three variables — dispatch prices, generation or dispatch megawatts, and megawatts of load. Note that dispatch prices are similar to but not identical to real-time prices – dispatch prices are generated a few minutes apart from real-time prices.
</p>
<p>
In order to use the real-time dispatch API you must subscribe to the <a href="/products">Wholesale market prices</a> API product to receive your API key.
</p>
<p>The real-time dispatch API will return the following fields:</p>
<ul>
<li>PointOfConnectionCode</li>
<li>FiveMinuteIntervalDatetime</li>
<li>FiveMinuteIntervalNumber</li>
<li>RunDateTime</li>
<li>SPDLoadMegawatt</li>
<li>SPDGenerationMegawatt</li>
<li>DollarsPerMegawattHour</li>
</ul>
<p>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.</p>
<p>The GET action returns the latest set of real-time dispatch variables as a JSON result set. Optionally the result set can be influenced by providing a range of OData filters on
<ul>
<li>PointOfConnectionCode </li>
<li>FiveMinuteIntervalDatetime</li>
<li>FiveMinuteIntervalNumber</li>
<li>DollarsPerMegawattHour</li>
</ul>
<br>
<p> Some OData filter examples </p>
<ul>
<li>For field PointOfConnectionCode, valid operators are: eq, and here are some examples:
<ul>
<li>$filter=PointOfConnectionCode eq 'AB1234' </li>
</ul>
</li>
<li>For field FiveMinuteIntervalDatetime, valid operators are: eq, and here are some examples:
<ul>
<li>$filter=FiveMinuteIntervalDatetime eq datetime'2020-04-01T00:00' </li>
</ul>
</li>
<li>For field FiveMinuteIntervalNumber, valid operators are: eq, le, ge, and here are some examples:
<ul>
<li>$filter=FiveMinuteIntervalNumber eq 15</li>
<li>$filter=FiveMinuteIntervalNumber ge 23</li>
<li>$filter=FiveMinuteIntervalNumber le 10</li>
<li>$filter=FiveMinuteIntervalNumber ge 1 and FiveMinuteIntervalNumber le 2 </li>
</ul>
</li>
</ul>
<ul>
<li>For field DollarsPerMegawattHour, valid operators are: eq, le, ge, and here are some examples: <ul>
<li>$filter=DollarsPerMegawattHour eq 15.0M</li>
<li>$filter=DollarsPerMegawattHour ge 23.0M</li>
<li>$filter=DollarsPerMegawattHour le 10.0M</li>
<li>$filter=DollarsPerMegawattHour ge 199.4M and DollarsPerMegawattHour le 200.1M </li>
</ul>
</li>
</ul>
ODATA to limit result set, eg ?$filter=DollarsPerMegawattHour eq 15.0M
Real-time dispatch collection
[{
"PointOfConnectionCode": "ABY0111",
"FiveMinuteIntervalDatetime": "2020-10-31T17:00:00",
"FiveMinuteIntervalNumber": 1,
"RunDateTime": "2020-10-31T03:59:01",
"SPDLoadMegawatt": 2.613,
"SPDGenerationMegawatt": 0.000,
"DollarsPerMegawattHour": 112.00
},
{
"PointOfConnectionCode": "ABY1101",
"FiveMinuteIntervalDatetime": "2020-10-31T17:00:00",
"FiveMinuteIntervalNumber": 1,
"RunDateTime": "2020-10-31T03:59:01",
"SPDLoadMegawatt": 0.000,
"SPDGenerationMegawatt": 0.000,
"DollarsPerMegawattHour": 111.88
},
{
"PointOfConnectionCode": "AG1",
"FiveMinuteIntervalDatetime": "2020-10-31T17:00:00",
"FiveMinuteIntervalNumber": 1,
"RunDateTime": "2020-10-31T03:59:01",
"SPDLoadMegawatt": 0.000,
"SPDGenerationMegawatt": 0.000,
"DollarsPerMegawattHour": 0.00
},
{
"PointOfConnectionCode": "AG2",
"FiveMinuteIntervalDatetime": "2020-10-31T17:00:00",
"FiveMinuteIntervalNumber": 1,
"RunDateTime": "2020-10-31T03:59:01",
"SPDLoadMegawatt": 0.000,
"SPDGenerationMegawatt": 0.000,
"DollarsPerMegawattHour": 0.00
},
{
"PointOfConnectionCode": "AG3",
"FiveMinuteIntervalDatetime": "2020-10-31T17:00:00",
"FiveMinuteIntervalNumber": 1,
"RunDateTime": "2020-10-31T03:59:01",
"SPDLoadMegawatt": 0.000,
"SPDGenerationMegawatt": 0.000,
"DollarsPerMegawattHour": 0.00
}]