FAfairground
Orders

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.

post/order_service.v1.OrderService/GetExecutableOrders

Request

Headers

Connect-Protocol-Version1 required

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

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

pricenumber double required

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

side'SIDE_LONG' | 'SIDE_SHORT'

Direction of the position represented by an order.

limitinteger nullable

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

Success

totalCountinteger

Total number of matching orders, independent of limit.

Example response

{
  "orders": [
    {
      "timestamp": "2023-01-15T01:30:15.01Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.