# Orders ## Get Orders `v1.orders.get_orders(intaccount_id, OrderGetOrdersParams**kwargs) -> OrderGetOrdersResponse` **get** `/v1/accounts/{account_id}/orders` List orders for an account with optional filtering ### Parameters - `account_id: int` - `from_: Optional[Union[str, datetime]]` The start date and time for the query range, inclusive (ISO 8601 format) - `instrument_ids: Optional[Sequence[str]]` Comma-separated OEMS instrument UUIDs - `instrument_type: Optional[Literal["COMMON_STOCK", "PREFERRED_STOCK", "OPTION", 2 more]]` Instrument type filter (e.g., COMMON_STOCK, OPTION) - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `page_size: Optional[int]` The number of items to return per page. Only used when page_token is not provided. - `page_token: Optional[Union[str, Base64FileInput]]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `status: Optional[List[Literal["PENDING_NEW", "NEW", "PARTIALLY_FILLED", 12 more]]]` Comma-separated order statuses to filter by - `"PENDING_NEW"` - `"NEW"` - `"PARTIALLY_FILLED"` - `"FILLED"` - `"CANCELED"` - `"REJECTED"` - `"EXPIRED"` - `"PENDING_CANCEL"` - `"PENDING_REPLACE"` - `"REPLACED"` - `"DONE_FOR_DAY"` - `"STOPPED"` - `"SUSPENDED"` - `"CALCULATED"` - `"OTHER"` - `symbol: Optional[str]` Filter by symbol - `to: Optional[Union[str, datetime]]` The end date and time for the query range, inclusive (ISO 8601 format) - `underlying_instrument_ids: Optional[str]` Comma-separated OEMS instrument UUIDs. Matches options orders whose resolved underlier is any of the given IDs. ### Returns - `class OrderGetOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.get_orders( account_id=0, ) print(response) ``` #### Response ```json { "data": [ { "account_id": 19816, "average_fill_price": "149.95", "client_order_id": "my-ref-id-20251001-001", "created_at": "2025-10-31T13:30:00.000000000Z", "filled_quantity": "50", "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b", "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "150.00", "order_type": "LIMIT", "quantity": "100", "side": "BUY", "status": "PARTIALLY_FILLED", "stop_price": null, "symbol": "AAPL", "time_in_force": "DAY", "updated_at": "2025-10-31T13:35:10.000000000Z" }, { "account_id": 19816, "average_fill_price": "450.75", "client_order_id": "my-ref-id-20251001-002", "created_at": "2025-10-31T14:00:00.000000000Z", "filled_quantity": "200", "id": "0195f6c8-1a2b-7c3d-8e4f-5a6b7c8d9e0f", "instrument_id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "instrument_type": "COMMON_STOCK", "leaves_quantity": "0", "limit_price": null, "order_type": "MARKET", "quantity": "200", "side": "SELL", "status": "FILLED", "stop_price": null, "symbol": "MSFT", "time_in_force": "DAY", "updated_at": "2025-10-31T14:00:05.000000000Z" } ], "error": null, "metadata": { "next_page_token": "cGFnZT0yJmxhc3RfaWQ9b3JkXzRjRDVlNkY3ZzhIOWkwSjE=", "page_number": 1, "request_id": "d9a4f5b6-c3d4-6e5f-0a1b-7c8d9e0f1a2b", "total_items": 25, "total_pages": 3 } } ``` ## Get Order By ID `v1.orders.get_order_by_id(strorder_id, OrderGetOrderByIDParams**kwargs) -> OrderGetOrderByIDResponse` **get** `/v1/accounts/{account_id}/orders/{order_id}` Get Order By ID ### Parameters - `account_id: int` - `order_id: str` ### Returns - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.get_order_by_id( order_id="order_id", account_id=0, ) print(response) ``` #### Response ```json { "data": { "account_id": 19816, "average_fill_price": "149.95", "created_at": "2025-10-31T13:30:00.000000000Z", "filled_quantity": "50", "id": "my-ref-id-20251001-001", "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "150.00", "order_type": "LIMIT", "quantity": "100", "side": "BUY", "status": "PARTIALLY_FILLED", "stop_price": null, "symbol": "AAPL", "time_in_force": "DAY", "updated_at": "2025-10-31T13:35:10.000000000Z" }, "error": null, "metadata": { "request_id": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f" } } ``` ## Submit Orders `v1.orders.submit_orders(intaccount_id, OrderSubmitOrdersParams**kwargs) -> OrderSubmitOrdersResponse` **post** `/v1/accounts/{account_id}/orders` Submit new orders ### Parameters - `account_id: int` - `orders: Iterable[Order]` - `class OrderNewOrderMultilegRequest: …` Multileg strategy order request - `legs: Iterable[OrderNewOrderMultilegRequestLeg]` Legs that compose the strategy. - `instrument_type: SecurityType` Security type for the leg. - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `ratio: str` Ratio for the leg. - `security: str` Trading symbol (e.g. "AAPL" or OSI symbol for options) - `side: Side` Leg side. - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `id: Optional[str]` Optional leg reference identifier. - `position_effect: Optional[PositionEffect]` Optional leg position effect. - `"OPEN"` - `"CLOSE"` - `order_type: RequestOrderType` Type of order (currently MARKET or LIMIT for multileg strategy submission) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `time_in_force: RequestTimeInForce` Time in force - `"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. - `limit_price: Optional[str]` Strategy price, required for LIMIT orders. - `quantity: Optional[str]` Optional strategy-level quantity. Multiplies leg quantities. Defaults to 1. - `class NewOrderRequest: …` Request to submit a new order (PlaceOrderRequest from spec) - `instrument_type: SecurityType` Type of security - `order_type: RequestOrderType` Type of order - `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 - `time_in_force: RequestTimeInForce` Time in force - `id: Optional[str]` Optional client-provided unique ID (idempotency). Required to be unique per account. - `expires_at: Optional[datetime]` The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE. - `extended_hours: Optional[bool]` Allow trading outside regular trading hours. Some brokers disallow options outside RTH. - `instrument_id: Optional[InstrumentIDOrSymbol]` OEMS instrument UUID - `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. - `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) - `"PRICE"` - `"BPS"` ### Returns - `class OrderSubmitOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.submit_orders( account_id=0, orders=[{ "legs": [{ "instrument_type": "OPTION", "ratio": "ratio", "security": "0193bb84-447a-706f-996f-097254663f02", "side": "BUY", }, { "instrument_type": "OPTION", "ratio": "ratio", "security": "0193bb84-4db4-78ec-b4fd-cba8be61cf8a", "side": "SELL", }, { "instrument_type": "OPTION", "ratio": "ratio", "security": "0193bb84-5264-7f20-8fd3-35df82cd6ef0", "side": "BUY", }], "order_type": "LIMIT", "time_in_force": "DAY", }], ) print(response) ``` #### Response ```json { "data": [ { "account_id": 19816, "average_fill_price": null, "client_order_id": "my-ref-id-20251003-001", "created_at": "2025-10-03T14:01:15.000000000Z", "filled_quantity": "0", "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e01", "instrument_id": "c3c4c5c6-d3d4-e3e4-f3f4-f5f6f7f8f9fa", "instrument_type": "COMMON_STOCK", "leaves_quantity": "25", "limit_price": null, "order_type": "MARKET", "quantity": "25", "side": "SELL", "status": "PENDING_NEW", "stop_price": null, "symbol": "GOOG", "time_in_force": "DAY", "updated_at": "2025-10-03T14:01:15.000000000Z", "venue": "XNAS" }, { "account_id": 19816, "average_fill_price": null, "client_order_id": "my-ref-id-20251003-002", "created_at": "2025-10-03T14:01:15.000000000Z", "filled_quantity": "0", "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02", "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "180.00", "order_type": "LIMIT", "quantity": "50", "side": "BUY", "status": "PENDING_NEW", "stop_price": null, "symbol": "TSLA", "time_in_force": "DAY", "updated_at": "2025-10-03T14:01:15.000000000Z", "venue": "XNAS" } ], "error": null, "metadata": { "request_id": "ea0b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d" } } ``` ## Replace Order `v1.orders.replace_order(strorder_id, OrderReplaceOrderParams**kwargs) -> OrderReplaceOrderResponse` **patch** `/v1/accounts/{account_id}/orders/{order_id}` Replace an order with new parameters ### Parameters - `account_id: int` - `order_id: str` - `limit_price: Optional[str]` New limit price for the order - `quantity: Optional[str]` New quantity for the order - `stop_price: Optional[str]` New stop price for the order - `time_in_force: Optional[RequestTimeInForce]` New time in force for the order - `"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"` ### Returns - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.replace_order( order_id="order_id", account_id=0, ) print(response) ``` #### Response ```json { "data": { "account_id": 19816, "average_fill_price": "149.95", "created_at": "2025-10-31T13:30:00.000000000Z", "filled_quantity": "50", "id": "my-ref-id-20251001-001", "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "150.50", "order_type": "LIMIT", "quantity": "125", "side": "BUY", "status": "PENDING_REPLACE", "stop_price": null, "symbol": "AAPL", "time_in_force": "DAY", "updated_at": "2025-10-31T14:10:00.000000000Z" }, "error": null, "metadata": { "request_id": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a" } } ``` ## Cancel Open Order `v1.orders.cancel_open_order(strorder_id, OrderCancelOpenOrderParams**kwargs) -> OrderCancelOpenOrderResponse` **delete** `/v1/accounts/{account_id}/orders/{order_id}` Cancel a specific order ### Parameters - `account_id: int` - `order_id: str` ### Returns - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.cancel_open_order( order_id="order_id", account_id=0, ) print(response) ``` #### Response ```json { "data": { "account_id": 19816, "average_fill_price": "149.95", "created_at": "2025-10-31T13:30:00.000000000Z", "filled_quantity": "50", "id": "my-ref-id-20251001-001", "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "150.50", "order_type": "LIMIT", "quantity": "125", "side": "BUY", "status": "PENDING_CANCEL", "stop_price": null, "symbol": "AAPL", "time_in_force": "DAY", "updated_at": "2025-10-31T14:15:00.000000000Z" }, "error": null, "metadata": { "request_id": "2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b" } } ``` ## Cancel All Open Orders `v1.orders.cancel_all_open_orders(intaccount_id, OrderCancelAllOpenOrdersParams**kwargs) -> OrderCancelAllOpenOrdersResponse` **delete** `/v1/accounts/{account_id}/orders` Cancel all orders for an account ### Parameters - `account_id: int` - `instrument_ids: Optional[Sequence[str]]` Comma-separated OEMS instrument UUIDs - `instrument_type: Optional[Literal["COMMON_STOCK", "PREFERRED_STOCK", "OPTION", 2 more]]` Filter by instrument type (e.g., COMMON_STOCK, OPTION) - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `side: Optional[Literal["BUY", "SELL", "SELL_SHORT", "OTHER"]]` Filter by order side (BUY or SELL) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `type: Optional[Literal["MARKET", "LIMIT", "STOP", 4 more]]` Filter by order type (e.g., MARKET, LIMIT) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` ### Returns - `class OrderCancelAllOpenOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.orders.cancel_all_open_orders( account_id=0, ) print(response) ``` #### Response ```json { "data": [ { "account_id": 19816, "average_fill_price": "149.95", "created_at": "2025-10-31T13:30:00.000000000Z", "filled_quantity": "50", "id": "019c0b48-b8fb-700d-8c5e-931d54555f54", "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "instrument_type": "COMMON_STOCK", "leaves_quantity": "50", "limit_price": "150.00", "order_type": "LIMIT", "quantity": "100", "side": "BUY", "status": "PENDING_CANCEL", "stop_price": null, "symbol": "AAPL", "time_in_force": "DAY", "updated_at": "2025-10-31T14:15:00.000000000Z" }, { "account_id": 19816, "average_fill_price": null, "created_at": "2025-10-31T14:00:00.000000000Z", "filled_quantity": "0", "id": "019c0b49-03af-70d1-8eeb-d69836c9840b", "instrument_id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "instrument_type": "COMMON_STOCK", "leaves_quantity": "200", "limit_price": "450.00", "order_type": "LIMIT", "quantity": "200", "side": "SELL", "status": "PENDING_CANCEL", "stop_price": null, "symbol": "MSFT", "time_in_force": "DAY", "updated_at": "2025-10-31T14:15:00.000000000Z" } ], "error": null, "metadata": { "request_id": "fb1c2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e" } } ``` ## Domain Types ### Cancel Order Request - `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) - `order_id: str` Order ID to cancel (from path parameter) ### Instrument ID Or Symbol - `str` OEMS instrument UUID ### New Order Request - `class NewOrderRequest: …` Request to submit a new order (PlaceOrderRequest from spec) - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `order_type: RequestOrderType` Type of order - `"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 - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `time_in_force: RequestTimeInForce` Time in force - `"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. - `expires_at: Optional[datetime]` The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE. - `extended_hours: Optional[bool]` Allow trading outside regular trading hours. Some brokers disallow options outside RTH. - `instrument_id: Optional[InstrumentIDOrSymbol]` OEMS instrument UUID - `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. - `"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) - `"PRICE"` - `"BPS"` ### Order - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order List - `List[Order]` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Status - `Literal["PENDING_NEW", "NEW", "PARTIALLY_FILLED", 12 more]` Order status - `"PENDING_NEW"` - `"NEW"` - `"PARTIALLY_FILLED"` - `"FILLED"` - `"CANCELED"` - `"REJECTED"` - `"EXPIRED"` - `"PENDING_CANCEL"` - `"PENDING_REPLACE"` - `"REPLACED"` - `"DONE_FOR_DAY"` - `"STOPPED"` - `"SUSPENDED"` - `"CALCULATED"` - `"OTHER"` ### Order Type - `Literal["MARKET", "LIMIT", "STOP", 4 more]` Order type - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` ### Position Effect - `Literal["OPEN", "CLOSE"]` Position effect for options orders - `"OPEN"` - `"CLOSE"` ### Queue State - `Literal["AWAITING_RELEASE", "RELEASED"]` Parent order queue or hold state. - `"AWAITING_RELEASE"` - `"RELEASED"` ### Request Order Type - `Literal["MARKET", "LIMIT", "STOP", 3 more]` Strict order-type enum for order submission/replacement requests. - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` ### Request Time In Force - `Literal["DAY", "GOOD_TILL_CANCEL", "IMMEDIATE_OR_CANCEL", 7 more]` Strict time-in-force enum for order submission/replacement requests. - `"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 - `Literal["BUY", "SELL", "SELL_SHORT", "OTHER"]` Side of an order - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` ### Time In Force - `Literal["DAY", "GOOD_TILL_CANCEL", "IMMEDIATE_OR_CANCEL", 8 more]` Time in force - `"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"` ### Trailing Offset Type - `Literal["PRICE", "BPS"]` Trailing offset type for trailing stop orders. - `"PRICE"` - `"BPS"` ### Order Get Orders Response - `class OrderGetOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Get Order By ID Response - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Submit Orders Response - `class OrderSubmitOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Replace Order Response - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Cancel Open Order Response - `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 - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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. ### Order Cancel All Open Orders Response - `class OrderCancelAllOpenOrdersResponse: …` - `data: OrderList` - `id: str` Engine-assigned unique identifier for this order (UUID). - `account_id: int` Account placing the order - `client_order_id: str` Client-provided identifier echoed back (FIX tag 11). - `created_at: datetime` Timestamp when order was created (UTC) - `filled_quantity: str` Cumulative filled quantity - `instrument_id: str` OEMS instrument UUID for the traded instrument. - `instrument_type: SecurityType` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: str` Remaining unfilled quantity - `order_type: OrderType` Type of order (MARKET, LIMIT, etc.) - `"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) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: OrderStatus` Current status of the order - `"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 - `"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) - `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. - `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. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: Optional[datetime]` Scheduled release time for orders awaiting release. - `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 - `"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 - `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.