Search meter dispatches

post deprecated

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

Search dispatches that match the input filters

Path Params

accountId

uuid

required

Body Params

Search dispatch request input

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

meter_ids

array of uuids

Meter ids to get dispatches for

meter_ids

Responses

Language

Credentials

Bearer

JWT

URL

Response

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

application/json

200The found 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