Skip to main content
GET
List Orders

List Orders

Returns a paginated list of your orders, newest first.

Query parameters

number
Page number (default 1)
number
Results per page (default 50, max 100)
string
Filter by status (e.g. filled, pending, failed)
string
Filter by order type — energy or bandwidth
string
Only autorefill is accepted: returns just the orders made by your Auto Refill rules. Any other value returns 422. Omit it to get all orders.
string
First day of the period, YYYY-MM-DD, inclusive. Omit both dates for the full list.
string
Last day of the period, YYYY-MM-DD, inclusive — the whole day counts, down to 23:59:59.999 in your time zone.
string
IANA time zone the two dates are read in, e.g. Europe/Berlin. Omitted means UTC.
Unlike a report, a list has no one-year cap — it is paginated. Both dates are optional: from alone means “from that day on”, to alone “up to and including that day”.

Response

Returns orders (array of order objects), total, page, and page_size.

Example

Response