URL Expired

The URL for this request expired after 30 days.

accountId

uuid

required

Search group dispatch request input

The market_type field takes the values “day-ahead” or “hour-ahead” corresponding to return only dispatches for those markets. If left empty both will be included in the response

start_date

date-time

required

Start datetime range to get dispatches for (inclusive)

end_date

date-time

required

End datetime range to get dispatches for (inclusive). End date must be max 31 days after the start date

rtm

string

enum

Takes the values “5m” or “15m” corresponding to return only 5 minute or 15 minute real-time dispatches. If left empty, real-time dispatches are not included in the response. Note: It is impossible combine rtm or market_type fields in one request

5m5m15m

Allowed:

5m``15m

market_type

string

enum

Indicates the market “day-ahead” or “hour-ahead”. Note: It is impossible combine rtm or market_type fields in one request

hour-aheadhour-aheadday-ahead

Allowed:

hour-ahead``day-ahead

include_tests

boolean

Include dispatches for test events in the response

truetruefalse

page_token

string

Token of the page to request. Null to request a new batch of results

market_group_ids

array of uuids

Market group ids to get group dispatches for

market_group_ids ADD uuid

`` 200 The found group dispatches that matched the search input

object

next_page_token

string

Token to be used in a subsequent request to get the next batch of results. Null when the last page of results has been reached

results

array of objects

required

A list of market-group dispatches.

results*

object

Aggregates timeslot dispatches per market group. Previously stored dispatches might be updated so when dealing with a dispatch that has the same market group, start time, end time and market type as an existing one, the previously received dispatch has to be updates with the new field values.

market_group_id

uuid

The id of the market group that received dispatches from the market. Could be null if the dispatch does not belong to a market group.

meter_ids

array of uuids

required

Ids of the meters that received dispatches from the market

timeslots

array of objects

required

List with timeslots and quantities that contains dispatches for these meters

timeslots*

object

A single time interval that describes all aspects of the dispatch

start_time

date-time

required

Start time of dispatch

end_time

date-time

required

End time of dispatch

energy_kw

double

The awarded kW for the dispatch. If the value is 'null' this indicates a full dispatch

test_event

boolean

required

Indicates whether the dispatch is a test event

market_type

string

enum

Indicates the market “day-ahead”, “hour-ahead”, “15m” or “5m”

hour-ahead``day-ahead``15m``5m

cancelled

boolean

'true' if a previously created dispatch is cancelled. The (meter_id, start_time, end_time, market_type) combination should be used in order to identify which one of the previously saved DispatchTimeslot has to be cancelled

programs

array of strings

Programs associated with the dispatch. This is a fixed list of values depending on your use-case and refers to the program(s) that the meters are enrolled for.

`` 400 Request could not be parsed or is invalid

`` 401 Unauthorized

`` 403 No access to this resource

`` 404 Resource not found

`` 5XX Unexpected error

{
  "next_page_token": 2,
  "results": [
    {
      "market_group_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "meter_ids": [
        "a946dfb9-5dc9-41f4-b9f2-4e5ac8fb5447",
        "74a2444d-7b49-45d1-93f7-dd8c24b33130"
      ],
      "timeslots": [
        {
          "start_time": "2023-01-23T16:00:00.000Z",
          "end_time": "2023-01-23T00:00:00.000Z",
          "energy_kw": 95,
          "cancelled": false,
          "programs": [
            "DRAM",
            "CCA"
          ],
          "test_event": false,
          "market_type": "day-ahead"
        },
        {
          "start_time": "2023-01-24T16:00:00.000Z",
          "end_time": "2023-01-24T00:00:00.000Z",
          "energy_kw": 115,
          "cancelled": false,
          "programs": [
            "DRAM",
            "CCA"
          ],
          "test_event": true,
          "market_type": "day-ahead"
        }
      ]
    }
  ]
}

Updated 11 months ago