Sign in

v1

latestOpenAPI 3.0.32026-07-23215362.6 KB
Trading

GET Orders

Retrieve a list of orders with optional filtering and pagination.

get/v1/orders

Query parameters

clientReferencestring

Filter orders by client provided reference parameter

orderStatusOrderStatus[]

Comma-delimited list of order statuses. Returns orders matching any of the provided statuses.

Filter orders by order status

placedAtStartstring date-time

Filter orders by when the order was placed. Lower bound, exclusive

placedAtEndstring date-time

Filter orders by when the order was placed. Upper bound, inclusive

completedAtStartstring date-time

Filter orders by when the order was completely filled. Lower bound, exclusive

completedAtEndstring date-time

Filter orders by when the order was completely filled. Upper bound, inclusive

accountIdstring uuid

Filter orders by account ID

pairstring

Filter orders by pair

sidestring

Filter orders by side

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortField'orderStatus' | 'placedAt' | 'completedAt'

Will sort the returned data using the specified field.

sortDirection'ASC' | 'DESC'

Specifies the sort direction for the sortField.

Response

Successful response

afterstring nullable

The token of the last item in the response

totalCountstring integer

The total number of items in the entire filtered data set