Search group dispatches

post deprecated

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

Search group dispatches that match the input filters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

uuid

required

Body Params

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

Allowed:

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

Allowed:

include_tests

boolean

Include dispatches for test events in the response

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

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The found group dispatches that matched the search input

400Request could not be parsed or is invalid

401Unauthorized

403No access to this resource

404Resource not found

5XXUnexpected error