Skip to main content
GET
TypeScript SDK

Authorizations

x-api-key
string
header
required

Query Parameters

pageSize
integer
default:20

Max results to return (1-100). Applies to the first page only; ignored when a pageToken is supplied (the token's encoded page size wins).

Required range: 1 <= x <= 100
Example:

20

pageToken
string

Opaque cursor from a previous response's nextPageToken. Encodes the page size so it does not need to be re-sent. Omit to fetch the first page.

Minimum string length: 1
status
enum<string>[]

Filter to specific order statuses (comma-separated). Omit to return all.

Minimum array length: 1

Order lifecycle. pending: accepted; funding/signing, not yet resting. open: resting on the book, no fills yet. partial: partially filled. filled: fully filled. cancelled / failed: terminal.

Available options:
pending,
open,
partial,
filled,
cancelled,
failed
Example:
type
enum<string>[]

Filter to specific order types (comma-separated: market, limit, stop, stop_limit). Omit to return all.

Minimum array length: 1
Available options:
market,
limit,
stop,
stop_limit,
iceberg
Example:

Response

Orders found

orders
Order · object[]
required

Page of orders.

nextPageToken
string | null
required

Opaque cursor for the next page.