# Orders ## Get Orders `$ clear-street v1:orders get-orders` **get** `/v1/accounts/{account_id}/orders` List orders for an account with optional filtering ### Parameters - `--account-id: number` Account identifier - `--from: optional string` The start date and time for the query range, inclusive (ISO 8601 format) - `--instrument-id: optional array of string` Comma-separated OEMS instrument UUIDs - `--instrument-type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Instrument type filter (e.g., COMMON_STOCK, OPTION) - `--page-size: optional number` The number of items to return per page. Only used when page_token is not provided. - `--page-token: optional string` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `--status: optional array of "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` Comma-separated order statuses to filter by - `--symbol: optional string` Filter by symbol - `--to: optional string` The end date and time for the query range, inclusive (ISO 8601 format) - `--underlying-instrument-ids: optional string` Comma-separated OEMS instrument UUIDs. Matches options orders whose resolved underlier is any of the given IDs. ### Returns - `V1OrderGetOrdersResponse: BaseResponse` - `data: array of Order` - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders get-orders \ --api-key 'My API Key' \ --account-id 0 ``` #### 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 `$ clear-street v1:orders get-order-by-id` **get** `/v1/accounts/{account_id}/orders/{order_id}` Get Order By ID ### Parameters - `--account-id: number` Account identifier - `--order-id: string` Order identifier ### Returns - `V1OrderGetOrderByIDResponse: BaseResponse` - `data: object { id, account_id, client_order_id, 29 more }` A trading order with its current state and execution details. This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking. - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders get-order-by-id \ --api-key 'My API Key' \ --account-id 0 \ --order-id order_id ``` #### 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 `$ clear-street v1:orders submit-orders` **post** `/v1/accounts/{account_id}/orders` Submit new orders ### Parameters - `--account-id: number` Account identifier - `--order: array of object { legs, order_type, time_in_force, 3 more } or NewOrderRequest` ### Returns - `V1OrderSubmitOrdersResponse: BaseResponse` - `data: array of Order` - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders submit-orders \ --api-key 'My API Key' \ --account-id 0 \ --order '{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}' ``` #### 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 `$ clear-street v1:orders replace-order` **patch** `/v1/accounts/{account_id}/orders/{order_id}` Replace an order with new parameters ### Parameters - `--account-id: number` Path param: Account identifier - `--order-id: string` Path param: Order identifier - `--limit-price: optional string` Body param: New limit price for the order - `--quantity: optional string` Body param: New quantity for the order - `--stop-price: optional string` Body param: New stop price for the order - `--time-in-force: optional "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 7 more` Body param: New time in force for the order ### Returns - `V1OrderReplaceOrderResponse: BaseResponse` - `data: object { id, account_id, client_order_id, 29 more }` A trading order with its current state and execution details. This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking. - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders replace-order \ --api-key 'My API Key' \ --account-id 0 \ --order-id order_id ``` #### 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 `$ clear-street v1:orders cancel-open-order` **delete** `/v1/accounts/{account_id}/orders/{order_id}` Cancel a specific order ### Parameters - `--account-id: number` Account identifier - `--order-id: string` Order identifier ### Returns - `V1OrderCancelOpenOrderResponse: BaseResponse` - `data: object { id, account_id, client_order_id, 29 more }` A trading order with its current state and execution details. This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking. - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders cancel-open-order \ --api-key 'My API Key' \ --account-id 0 \ --order-id order_id ``` #### 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 `$ clear-street v1:orders cancel-all-open-orders` **delete** `/v1/accounts/{account_id}/orders` Cancel all orders for an account ### Parameters - `--account-id: number` Account identifier - `--instrument-id: optional array of string` Comma-separated OEMS instrument UUIDs - `--instrument-type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Filter by instrument type (e.g., COMMON_STOCK, OPTION) - `--side: optional "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Filter by order side (BUY or SELL) - `--type: optional "MARKET" or "LIMIT" or "STOP" or 4 more` Filter by order type (e.g., MARKET, LIMIT) ### Returns - `V1OrderCancelAllOpenOrdersResponse: BaseResponse` - `data: array of Order` - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 ```cli clear-street v1:orders cancel-all-open-orders \ --api-key 'My API Key' \ --account-id 0 ``` #### 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 - `cancel_order_request: object { account_id, order_id }` Request to cancel an existing order Note: In the API, order cancellation is done via DELETE request without a body. The order_id and account_id come from the URL path parameters. - `account_id: number` Account ID (from path parameter) - `order_id: string` Order ID to cancel (from path parameter) ### Instrument ID Or Symbol - `instrument_id_or_symbol: string` OEMS instrument UUID ### New Order Request - `new_order_request: object { instrument_type, order_type, quantity, 13 more }` Request to submit a new order (PlaceOrderRequest from spec) - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `order_type: "MARKET" or "LIMIT" or "STOP" or 3 more` Type of order - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `quantity: string` Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer) - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 7 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"` - `id: optional string` Optional client-provided unique ID (idempotency). Required to be unique per account. - `expires_at: optional string` The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Allow trading outside regular trading hours. Some brokers disallow options outside RTH. - `instrument_id: optional string` OEMS instrument UUID - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (required for LIMIT and STOP_LIMIT orders) - `position_effect: optional "OPEN" or "CLOSE"` Required when instrument_type is OPTION. Specifies whether the order opens or closes a position. - `"OPEN"` - `"CLOSE"` - `stop_price: optional string` Stop price (required for STOP and STOP_LIMIT orders) - `symbol: optional string` 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 string` Trailing offset amount (required for trailing orders) - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type (PRICE or PERCENT_BPS) - `"PRICE"` - `"BPS"` ### Order - `order: object { id, account_id, client_order_id, 29 more }` A trading order with its current state and execution details. This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking. - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 - `order_list: array of Order` - `id: string` Engine-assigned unique identifier for this order (UUID). - `account_id: number` Account placing the order - `client_order_id: string` Client-provided identifier echoed back (FIX tag 11). - `created_at: string` Timestamp when order was created (UTC) - `filled_quantity: string` Cumulative filled quantity - `instrument_id: string` OEMS instrument UUID for the traded instrument. - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` Type of security - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `leaves_quantity: string` Remaining unfilled quantity - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Type of order (MARKET, LIMIT, etc.) - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` - `quantity: string` Total order quantity - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of the order (BUY, SELL, SELL_SHORT) - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more` 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: string` Trading symbol - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more` 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: string` Timestamp of the most recent update (UTC) - `venue: string` MIC code of the venue where the order is routed - `average_fill_price: optional string` Average fill price across all executions - `details: optional array of string` Contains execution, rejection or cancellation details, if any - `expires_at: optional string` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `extended_hours: optional boolean` Whether the order is eligible for extended-hours trading. - `limit_offset: optional string` Limit offset for trailing stop-limit orders (signed) - `limit_price: optional string` Limit price (for LIMIT and STOP_LIMIT orders) - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"` Parent order queue state, present when the order is awaiting release or released. - `"AWAITING_RELEASE"` - `"RELEASED"` - `releases_at: optional string` Scheduled release time for orders awaiting release. - `stop_price: optional string` Stop price (for STOP and STOP_LIMIT orders) - `trailing_limit_px: optional string` Current trailing limit price computed by the trailing strategy - `trailing_offset: optional string` Trailing offset amount for trailing orders - `trailing_offset_type: optional "PRICE" or "BPS"` Trailing offset type for trailing orders - `"PRICE"` - `"BPS"` - `trailing_stop_px: optional string` Current trailing stop price computed by the trailing strategy - `trailing_watermark_px: optional string` Trailing watermark price for trailing orders - `trailing_watermark_ts: optional string` Trailing watermark timestamp for trailing orders - `underlying_instrument_id: optional string` 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 - `order_status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 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 - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more` Order type - `"MARKET"` - `"LIMIT"` - `"STOP"` - `"STOP_LIMIT"` - `"TRAILING_STOP"` - `"TRAILING_STOP_LIMIT"` - `"OTHER"` ### Position Effect - `position_effect: "OPEN" or "CLOSE"` Position effect for options orders - `"OPEN"` - `"CLOSE"` ### Queue State - `queue_state: "AWAITING_RELEASE" or "RELEASED"` Parent order queue or hold state. - `"AWAITING_RELEASE"` - `"RELEASED"` ### Request Order Type - `request_order_type: "MARKET" or "LIMIT" or "STOP" or 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 - `request_time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 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 - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"` Side of an order - `"BUY"` - `"SELL"` - `"SELL_SHORT"` - `"OTHER"` ### Time In Force - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 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 - `trailing_offset_type: "PRICE" or "BPS"` Trailing offset type for trailing stop orders. - `"PRICE"` - `"BPS"`