GetExecutableOrders
Returns pending orders in a market that would be eligible to execute
if the market traded at price. Useful for previewing available
counterparty liquidity at a hypothetical price before submitting a
trade.
An order counts as executable when it’s a position-opening order on
the LONG side with threshold_price >= price, a position-opening
order on the SHORT side with threshold_price <= price, or a
reduce-only order (a manual reduce, or a stop-loss/take-profit that
has already triggered). Only PENDING, PARTIALLY_FILLED, and
PARTIALLY_MERGED orders are considered.
Results are ordered by threshold_price descending, then
timestamp descending.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Define the version of the Connect protocol. If omitted, use 1.
1 Define the timeout, in ms
Body
Market to query. Must be non-zero; an unknown market returns NOT_FOUND.
Hypothetical execution price to test orders against, in USD. Must be positive.
Direction of the position represented by an order.
SIDE_LONG, SIDE_SHORT 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.