Skip to content
Clear Street Clear Street
Get started
API Reference
V1

Orders

Place, monitor, and manage trading orders.

Get Orders
client.v1.orders.getOrders(numberaccountID, OrderGetOrdersParams { from, instrument_ids, instrument_type, 6 more } query?, RequestOptionsoptions?): OrderGetOrdersResponse { data }
GET/v1/accounts/{account_id}/orders
Get Order By ID
client.v1.orders.getOrderByID(stringorderID, OrderGetOrderByIDParams { account_id } params, RequestOptionsoptions?): OrderGetOrderByIDResponse { data }
GET/v1/accounts/{account_id}/orders/{order_id}
Submit Orders
client.v1.orders.submitOrders(numberaccountID, OrderSubmitOrdersParams { orders } params, RequestOptionsoptions?): OrderSubmitOrdersResponse { data }
POST/v1/accounts/{account_id}/orders
Replace Order
client.v1.orders.replaceOrder(stringorderID, OrderReplaceOrderParams { account_id, limit_price, quantity, 2 more } params, RequestOptionsoptions?): OrderReplaceOrderResponse { data }
PATCH/v1/accounts/{account_id}/orders/{order_id}
Cancel Open Order
client.v1.orders.cancelOpenOrder(stringorderID, OrderCancelOpenOrderParams { account_id } params, RequestOptionsoptions?): OrderCancelOpenOrderResponse { data }
DELETE/v1/accounts/{account_id}/orders/{order_id}
Cancel All Open Orders
client.v1.orders.cancelAllOpenOrders(numberaccountID, OrderCancelAllOpenOrdersParams { instrument_ids, instrument_type, side, type } params?, RequestOptionsoptions?): OrderCancelAllOpenOrdersResponse { data }
DELETE/v1/accounts/{account_id}/orders
ModelsExpand Collapse
CancelOrderRequest { account_id, order_id }

Request to cancel an existing order

Note: In the API, order cancellation is done via DELETE request without a body. The order_id and account_id come from the URL path parameters.

account_id: number

Account ID (from path parameter)

formatint64
order_id: string

Order ID to cancel (from path parameter)

InstrumentIDOrSymbol = string

OEMS instrument UUID

NewOrderRequest { instrument_type, order_type, quantity, 13 more }

Request to submit a new order (PlaceOrderRequest from spec)

instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
order_type: RequestOrderType

Type of order

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
quantity: string

Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)

side: Side

Side of the order

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
time_in_force: RequestTimeInForce

Time in force

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
id?: string | null

Optional client-provided unique ID (idempotency). Required to be unique per account.

maxLength64
expires_at?: string | null

The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Allow trading outside regular trading hours. Some brokers disallow options outside RTH.

instrument_id?: InstrumentIDOrSymbol | null

OEMS instrument UUID

formatuuid
limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (required for LIMIT and STOP_LIMIT orders)

position_effect?: PositionEffect

Required when instrument_type is OPTION. Specifies whether the order opens or closes a position.

One of the following:
"OPEN"
"CLOSE"
stop_price?: string | null

Stop price (required for STOP and STOP_LIMIT orders)

symbol?: string | null

Trading symbol. For equities, use the ticker symbol (e.g., “AAPL”). For options, use the OSI symbol (e.g., “AAPL 250117C00190000”). Either symbol or instrument_id must be provided.

trailing_offset?: string | null

Trailing offset amount (required for trailing orders)

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:
"PRICE"
"BPS"
Order { id, account_id, client_order_id, 29 more }

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderList = Array<Order { id, account_id, client_order_id, 29 more } >
id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderStatus = "PENDING_NEW" | "NEW" | "PARTIALLY_FILLED" | 12 more

Order status

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
OrderType = "MARKET" | "LIMIT" | "STOP" | 4 more

Order type

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
PositionEffect = "OPEN" | "CLOSE"

Position effect for options orders

One of the following:
"OPEN"
"CLOSE"
QueueState = "AWAITING_RELEASE" | "RELEASED"

Parent order queue or hold state.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
RequestOrderType = "MARKET" | "LIMIT" | "STOP" | 3 more

Strict order-type enum for order submission/replacement requests.

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
RequestTimeInForce = "DAY" | "GOOD_TILL_CANCEL" | "IMMEDIATE_OR_CANCEL" | 7 more

Strict time-in-force enum for order submission/replacement requests.

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
Side = "BUY" | "SELL" | "SELL_SHORT" | "OTHER"

Side of an order

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
TimeInForce = "DAY" | "GOOD_TILL_CANCEL" | "IMMEDIATE_OR_CANCEL" | 8 more

Time in force

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
TrailingOffsetType = "PRICE" | "BPS"

Trailing offset type for trailing stop orders.

One of the following:
"PRICE"
"BPS"
OrderGetOrdersResponse extends BaseResponse { metadata, error } { data }
data: OrderList { id, account_id, client_order_id, 29 more }
id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderGetOrderByIDResponse extends BaseResponse { metadata, error } { data }
data: Order { id, account_id, client_order_id, 29 more }

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderSubmitOrdersResponse extends BaseResponse { metadata, error } { data }
data: OrderList { id, account_id, client_order_id, 29 more }
id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderReplaceOrderResponse extends BaseResponse { metadata, error } { data }
data: Order { id, account_id, client_order_id, 29 more }

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderCancelOpenOrderResponse extends BaseResponse { metadata, error } { data }
data: Order { id, account_id, client_order_id, 29 more }

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
OrderCancelAllOpenOrdersResponse extends BaseResponse { metadata, error } { data }
data: OrderList { id, account_id, client_order_id, 29 more }
id: string

Engine-assigned unique identifier for this order (UUID).

account_id: number

Account placing the order

formatint64
client_order_id: string

Client-provided identifier echoed back (FIX tag 11).

created_at: string

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: string

Cumulative filled quantity

instrument_id: string

OEMS instrument UUID for the traded instrument.

formatuuid
instrument_type: SecurityType

Type of security

One of the following:
"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
leaves_quantity: string

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: string

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
symbol: string

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_THE_OPENING"
"AT_THE_CLOSE"
"GOOD_TILL_CROSSING"
"GOOD_THROUGH_CROSSING"
"AT_CROSSING"
"OTHER"
updated_at: string

Timestamp of the most recent update (UTC)

formatdate-time
venue: string

MIC code of the venue where the order is routed

average_fill_price?: string | null

Average fill price across all executions

details?: Array<string>

Contains execution, rejection or cancellation details, if any

expires_at?: string | null

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
extended_hours?: boolean | null

Whether the order is eligible for extended-hours trading.

limit_offset?: string | null

Limit offset for trailing stop-limit orders (signed)

limit_price?: string | null

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state?: QueueState | null

Parent order queue state, present when the order is awaiting release or released.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at?: string | null

Scheduled release time for orders awaiting release.

formatdate-time
stop_price?: string | null

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px?: string | null

Current trailing limit price computed by the trailing strategy

trailing_offset?: string | null

Trailing offset amount for trailing orders

trailing_offset_type?: TrailingOffsetType | null

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px?: string | null

Current trailing stop price computed by the trailing strategy

trailing_watermark_px?: string | null

Trailing watermark price for trailing orders

trailing_watermark_ts?: string | null

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id?: string | null

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid