Skip to main content
POST
GetExecutableOrders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol. If omitted, use 1.

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
marketId
required

Market to query. Must be non-zero; an unknown market returns NOT_FOUND.

price
number<double>
required

Hypothetical execution price to test orders against, in USD. Must be positive.

side
enum<string> | null

Direction of the position represented by an order.

Available options:
SIDE_LONG,
SIDE_SHORT
limit
integer | null

Optional cap on the number of orders returned. When omitted or zero, all matching orders are returned. Does not affect total_count, which always reflects the full match set.

Response

200 - application/json

Success

orders
Order · object[]

Orders that would be executable at price, ordered by threshold price descending, then timestamp descending. Truncated to limit when set.

totalCount
integer

Total number of matching orders, independent of limit.