v4

latestOpenAPI 3.0.02026-08-04103181301.4 KB
orders

Get Order Queue Position

Endpoint for getting an order's queue position in the order book. This represents the amount of orders that need to be matched before this order receives a partial or full match. Queue position is determined using a price-time priority.

get/portfolio/orders/{order_id}/queue_position

Path parameters

order_idstring required

Order ID

Response

Queue position retrieved successfully

queue_position_fpstring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

Example response

{
  "queue_position_fp": "10.00"
}