Get Orders

read-only · idempotent

View all pending/open orders with optional filtering.

Returns orders that are in NEW or PARTIALLY_FILLED status.

PARAMETERS:

• symbol: Optional filter by symbol (e.g., “EURUSD”). Omit for all orders.
• status: Filter by order status: “all” (default), “NEW”, “PARTIALLY_FILLED”
• clOrdId: Optional client order ID to query a specific order
• refresh: When true, fetches fresh order data from the broker. When clOrdId + refresh=true, sends a targeted status request for just that order.

RESPONSE FIELDS (per order):

• clOrdId, orderId, symbol, side (BUY/SELL)
• orderType, volume, filledVolume, remainingVolume, status
• price, stopPrice, avgPrice, timeInForce, expireTime
• positionId, createdAt, updatedAt, comment

This is a read-only operation with no risk checks.

Parameters

Parameter	Type	Required	Description
symbol	string	No	Optional symbol filter (e.g., ‘EURUSD’). Omit to get all orders.
status	"all", "NEW", "PARTIALLY_FILLED"	No	Filter by order status. Default ‘all’ returns NEW and PARTIALLY_FILLED orders. Default: all.
clOrdId	string	No	Optional client order ID to query a specific order.
refresh	boolean	No	When true, fetches fresh order data from the broker for a current snapshot. Default false (reads from cached local state). Default: false.