| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

accountId

uuid

required

Search 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

meter\_ids

array of uuids

Meter ids to get dispatches for

meter\_ids
ADD uuid

# `` 200      The found 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 meter-level dispatches.

results\*

object

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

meter\_id

uuid

required

Id of the meter that received dispatches from the market

timeslots

array of objects

required

List with timeslots and quantities that contains dispatches for this meter

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

Updated 11 months ago

* * *

Base URL

https://api.staging.leap.energy/v1.1/account/{accountId}/bidding/dispatch/search

```

xxxxxxxxxx

curl --request POST \

--url https://api.staging.leap.energy/v1.1/account/accountId/bidding/dispatch/search \

--header 'accept: application/json' \

--header 'content-type: application/json'
```

```

xxxxxxxxxx

{

"next_page_token": 2,

"results": [\
\
    {\
\
      "meter_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",\
\
      "timeslots": [\
\
        {\
\
          "start_time": "2023-02-21T16:00:00.000Z",\
\
          "end_time": "2023-02-21T17:00:00.000Z",\
\
          "energy_kw": 80,\
\
          "cancelled": false,\
\
          "programs": [\
\
            "DRAM",\
\
            "CCA"\
\
          ],\
\
          "test_event": false,\
\
          "market_type": "day-ahead"\
\
        },\
\
        {\
\
          "start_time": "2023-02-21T17:00:00.000Z",\
\
          "end_time": "2023-02-21T18:00:00.000Z",\
\
          "energy_kw": 40,\
\
          "cancelled": false,\
\
          "programs": [\
\
            "CA_IOUS-ELRP",\
\
            "ENERGY-ONLY"\
\
          ],\
\
          "test_event": true,\
\
          "market_type": "5m"\
\
        }\
\
      ]\
\
    }\
\
  ]

}