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

Orders

Place, monitor, and manage trading orders.

Get Orders
v1.orders.get_orders(intaccount_id, OrderGetOrdersParams**kwargs) -> OrderGetOrdersResponse
GET/v1/accounts/{account_id}/orders
Get Order By ID
v1.orders.get_order_by_id(strorder_id, OrderGetOrderByIDParams**kwargs) -> OrderGetOrderByIDResponse
GET/v1/accounts/{account_id}/orders/{order_id}
Submit Orders
v1.orders.submit_orders(intaccount_id, OrderSubmitOrdersParams**kwargs) -> OrderSubmitOrdersResponse
POST/v1/accounts/{account_id}/orders
Replace Order
v1.orders.replace_order(strorder_id, OrderReplaceOrderParams**kwargs) -> OrderReplaceOrderResponse
PATCH/v1/accounts/{account_id}/orders/{order_id}
Cancel Open Order
v1.orders.cancel_open_order(strorder_id, OrderCancelOpenOrderParams**kwargs) -> OrderCancelOpenOrderResponse
DELETE/v1/accounts/{account_id}/orders/{order_id}
Cancel All Open Orders
v1.orders.cancel_all_open_orders(intaccount_id, OrderCancelAllOpenOrdersParams**kwargs) -> OrderCancelAllOpenOrdersResponse
DELETE/v1/accounts/{account_id}/orders
ModelsExpand Collapse
class CancelOrderRequest: …

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: int

Account ID (from path parameter)

formatint64
order_id: str

Order ID to cancel (from path parameter)

str

OEMS instrument UUID

class NewOrderRequest: …

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: str

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: Optional[str]

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

maxLength64
expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

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

instrument_id: Optional[InstrumentIDOrSymbol]

OEMS instrument UUID

formatuuid
limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (required for LIMIT and STOP_LIMIT orders)

position_effect: Optional[PositionEffect]

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

One of the following:
"OPEN"
"CLOSE"
stop_price: Optional[str]

Stop price (required for STOP and STOP_LIMIT orders)

symbol: Optional[str]

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: Optional[str]

Trailing offset amount (required for trailing orders)

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:
"PRICE"
"BPS"
class Order: …

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: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
List[Order]
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
Literal["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"
Literal["MARKET", "LIMIT", "STOP", 4 more]

Order type

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
Literal["OPEN", "CLOSE"]

Position effect for options orders

One of the following:
"OPEN"
"CLOSE"
Literal["AWAITING_RELEASE", "RELEASED"]

Parent order queue or hold state.

One of the following:
"AWAITING_RELEASE"
"RELEASED"
Literal["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"
Literal["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"
Literal["BUY", "SELL", "SELL_SHORT", "OTHER"]

Side of an order

One of the following:
"BUY"
"SELL"
"SELL_SHORT"
"OTHER"
Literal["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"
Literal["PRICE", "BPS"]

Trailing offset type for trailing stop orders.

One of the following:
"PRICE"
"BPS"
class OrderGetOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
class OrderGetOrderByIDResponse: …
data: Order

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: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
class OrderSubmitOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
class OrderReplaceOrderResponse: …
data: Order

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: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
class OrderCancelOpenOrderResponse: …
data: Order

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: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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
class OrderCancelAllOpenOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

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

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

instrument_id: str

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: str

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: str

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: str

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: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

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

One of the following:
"AWAITING_RELEASE"
"RELEASED"
releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time
stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time
underlying_instrument_id: Optional[str]

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