KAkalshi
orders

Get Order Queue Position

Changed on

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

Request

  • Base URL
    https://external-api.kalshi.com/trade-api/v2
  • URL
    https://external-api.kalshi.com/trade-api/v2/portfolio/orders/{order_id}/queue_position
  • Auth
    API key in header KALSHI-ACCESS-KEY and API key in header KALSHI-ACCESS-SIGNATURE and API key in header KALSHI-ACCESS-TIMESTAMP

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"
}

Changes

  • a07481be8bf9Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • 218c1f661cbdRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      the response property became required for the status