# Orders ## Get Orders `client.V1.Orders.GetOrders(ctx, accountID, query) (*V1OrderGetOrdersResponse, error)` **get** `/v1/accounts/{account_id}/orders` List orders for an account with optional filtering ### Parameters - `accountID int64` - `query V1OrderGetOrdersParams` - `From param.Field[Time]` The start date and time for the query range, inclusive (ISO 8601 format) - `InstrumentIDs param.Field[[]string]` Comma-separated OEMS instrument UUIDs - `InstrumentType param.Field[V1OrderGetOrdersParamsInstrumentType]` Instrument type filter (e.g., COMMON_STOCK, OPTION) - `const V1OrderGetOrdersParamsInstrumentTypeCommonStock V1OrderGetOrdersParamsInstrumentType = "COMMON_STOCK"` - `const V1OrderGetOrdersParamsInstrumentTypePreferredStock V1OrderGetOrdersParamsInstrumentType = "PREFERRED_STOCK"` - `const V1OrderGetOrdersParamsInstrumentTypeOption V1OrderGetOrdersParamsInstrumentType = "OPTION"` - `const V1OrderGetOrdersParamsInstrumentTypeCash V1OrderGetOrdersParamsInstrumentType = "CASH"` - `const V1OrderGetOrdersParamsInstrumentTypeOther V1OrderGetOrdersParamsInstrumentType = "OTHER"` - `PageSize param.Field[int64]` The number of items to return per page. Only used when page_token is not provided. - `PageToken param.Field[string]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `Status param.Field[[]string]` Comma-separated order statuses to filter by - `const V1OrderGetOrdersParamsStatusPendingNew V1OrderGetOrdersParamsStatus = "PENDING_NEW"` - `const V1OrderGetOrdersParamsStatusNew V1OrderGetOrdersParamsStatus = "NEW"` - `const V1OrderGetOrdersParamsStatusPartiallyFilled V1OrderGetOrdersParamsStatus = "PARTIALLY_FILLED"` - `const V1OrderGetOrdersParamsStatusFilled V1OrderGetOrdersParamsStatus = "FILLED"` - `const V1OrderGetOrdersParamsStatusCanceled V1OrderGetOrdersParamsStatus = "CANCELED"` - `const V1OrderGetOrdersParamsStatusRejected V1OrderGetOrdersParamsStatus = "REJECTED"` - `const V1OrderGetOrdersParamsStatusExpired V1OrderGetOrdersParamsStatus = "EXPIRED"` - `const V1OrderGetOrdersParamsStatusPendingCancel V1OrderGetOrdersParamsStatus = "PENDING_CANCEL"` - `const V1OrderGetOrdersParamsStatusPendingReplace V1OrderGetOrdersParamsStatus = "PENDING_REPLACE"` - `const V1OrderGetOrdersParamsStatusReplaced V1OrderGetOrdersParamsStatus = "REPLACED"` - `const V1OrderGetOrdersParamsStatusDoneForDay V1OrderGetOrdersParamsStatus = "DONE_FOR_DAY"` - `const V1OrderGetOrdersParamsStatusStopped V1OrderGetOrdersParamsStatus = "STOPPED"` - `const V1OrderGetOrdersParamsStatusSuspended V1OrderGetOrdersParamsStatus = "SUSPENDED"` - `const V1OrderGetOrdersParamsStatusCalculated V1OrderGetOrdersParamsStatus = "CALCULATED"` - `const V1OrderGetOrdersParamsStatusOther V1OrderGetOrdersParamsStatus = "OTHER"` - `Symbol param.Field[string]` Filter by symbol - `To param.Field[Time]` The end date and time for the query range, inclusive (ISO 8601 format) - `UnderlyingInstrumentIDs param.Field[string]` Comma-separated OEMS instrument UUIDs. Matches options orders whose resolved underlier is any of the given IDs. ### Returns - `type V1OrderGetOrdersResponse struct{…}` - `Data OrderList` - `ID string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.GetOrders( context.TODO(), 0, clearstreet.V1OrderGetOrdersParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.V1.Orders.GetOrderByID(ctx, orderID, query) (*V1OrderGetOrderByIDResponse, error)` **get** `/v1/accounts/{account_id}/orders/{order_id}` Get Order By ID ### Parameters - `orderID string` - `query V1OrderGetOrderByIDParams` - `AccountID param.Field[int64]` Account identifier ### Returns - `type V1OrderGetOrderByIDResponse struct{…}` - `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 string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.GetOrderByID( context.TODO(), "order_id", clearstreet.V1OrderGetOrderByIDParams{ AccountID: 0, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.V1.Orders.SubmitOrders(ctx, accountID, body) (*V1OrderSubmitOrdersResponse, error)` **post** `/v1/accounts/{account_id}/orders` Submit new orders ### Parameters - `accountID int64` - `body V1OrderSubmitOrdersParams` - `Orders param.Field[[]V1OrderSubmitOrdersParamsOrderUnion]` - `type V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequest struct{…}` Multileg strategy order request - `Legs []V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequestLeg` Legs that compose the strategy. - `InstrumentType SecurityType` Security type for the leg. - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `Ratio string` Ratio for the leg. - `Security string` Trading symbol (e.g. "AAPL" or OSI symbol for options) - `Side Side` Leg side. - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `ID string` Optional leg reference identifier. - `PositionEffect PositionEffect` Optional leg position effect. - `const PositionEffectOpen PositionEffect = "OPEN"` - `const PositionEffectClose PositionEffect = "CLOSE"` - `OrderType RequestOrderType` Type of order (currently MARKET or LIMIT for multileg strategy submission) - `const RequestOrderTypeMarket RequestOrderType = "MARKET"` - `const RequestOrderTypeLimit RequestOrderType = "LIMIT"` - `const RequestOrderTypeStop RequestOrderType = "STOP"` - `const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"` - `const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"` - `const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"` - `TimeInForce RequestTimeInForce` Time in force - `const RequestTimeInForceDay RequestTimeInForce = "DAY"` - `const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"` - `const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"` - `const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"` - `const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"` - `const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"` - `const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"` - `const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"` - `const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"` - `const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"` - `ID string` Optional client-provided unique ID (idempotency). Required to be unique per account. - `LimitPrice string` Strategy price, required for LIMIT orders. - `Quantity string` Optional strategy-level quantity. Multiplies leg quantities. Defaults to 1. - `type NewOrderRequest struct{…}` Request to submit a new order (PlaceOrderRequest from spec) - `InstrumentType SecurityType` Type of security - `OrderType RequestOrderType` Type of order - `Quantity string` Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer) - `Side Side` Side of the order - `TimeInForce RequestTimeInForce` Time in force - `ID string` Optional client-provided unique ID (idempotency). Required to be unique per account. - `ExpiresAt Time` The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Allow trading outside regular trading hours. Some brokers disallow options outside RTH. - `InstrumentID InstrumentIDOrSymbol` OEMS instrument UUID - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (required for LIMIT and STOP_LIMIT orders) - `PositionEffect PositionEffect` Required when instrument_type is OPTION. Specifies whether the order opens or closes a position. - `StopPrice string` Stop price (required for STOP and STOP_LIMIT orders) - `Symbol 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. - `TrailingOffset string` Trailing offset amount (required for trailing orders) - `TrailingOffsetType TrailingOffsetType` Trailing offset type (PRICE or PERCENT_BPS) - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` ### Returns - `type V1OrderSubmitOrdersResponse struct{…}` - `Data OrderList` - `ID string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.SubmitOrders( context.TODO(), 0, clearstreet.V1OrderSubmitOrdersParams{ Orders: []clearstreet.V1OrderSubmitOrdersParamsOrderUnion{clearstreet.V1OrderSubmitOrdersParamsOrderUnion{ OfV1OrderSubmitOrderssOrderNewOrderMultilegRequest: &clearstreet.V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequest{ Legs: []clearstreet.V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequestLeg{clearstreet.V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequestLeg{ InstrumentType: clearstreet.SecurityTypeOption, Ratio: "ratio", Security: "0193bb84-447a-706f-996f-097254663f02", Side: clearstreet.SideBuy, }, clearstreet.V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequestLeg{ InstrumentType: clearstreet.SecurityTypeOption, Ratio: "ratio", Security: "0193bb84-4db4-78ec-b4fd-cba8be61cf8a", Side: clearstreet.SideSell, }, clearstreet.V1OrderSubmitOrdersParamsOrderNewOrderMultilegRequestLeg{ InstrumentType: clearstreet.SecurityTypeOption, Ratio: "ratio", Security: "0193bb84-5264-7f20-8fd3-35df82cd6ef0", Side: clearstreet.SideBuy, }}, OrderType: clearstreet.RequestOrderTypeLimit, TimeInForce: clearstreet.RequestTimeInForceDay, }, }}, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.V1.Orders.ReplaceOrder(ctx, orderID, params) (*V1OrderReplaceOrderResponse, error)` **patch** `/v1/accounts/{account_id}/orders/{order_id}` Replace an order with new parameters ### Parameters - `orderID string` - `params V1OrderReplaceOrderParams` - `AccountID param.Field[int64]` Path param: Account identifier - `LimitPrice param.Field[string]` Body param: New limit price for the order - `Quantity param.Field[string]` Body param: New quantity for the order - `StopPrice param.Field[string]` Body param: New stop price for the order - `TimeInForce param.Field[RequestTimeInForce]` Body param: New time in force for the order ### Returns - `type V1OrderReplaceOrderResponse struct{…}` - `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 string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.ReplaceOrder( context.TODO(), "order_id", clearstreet.V1OrderReplaceOrderParams{ AccountID: 0, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.V1.Orders.CancelOpenOrder(ctx, orderID, body) (*V1OrderCancelOpenOrderResponse, error)` **delete** `/v1/accounts/{account_id}/orders/{order_id}` Cancel a specific order ### Parameters - `orderID string` - `body V1OrderCancelOpenOrderParams` - `AccountID param.Field[int64]` Account identifier ### Returns - `type V1OrderCancelOpenOrderResponse struct{…}` - `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 string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.CancelOpenOrder( context.TODO(), "order_id", clearstreet.V1OrderCancelOpenOrderParams{ AccountID: 0, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.V1.Orders.CancelAllOpenOrders(ctx, accountID, body) (*V1OrderCancelAllOpenOrdersResponse, error)` **delete** `/v1/accounts/{account_id}/orders` Cancel all orders for an account ### Parameters - `accountID int64` - `body V1OrderCancelAllOpenOrdersParams` - `InstrumentIDs param.Field[[]string]` Comma-separated OEMS instrument UUIDs - `InstrumentType param.Field[V1OrderCancelAllOpenOrdersParamsInstrumentType]` Filter by instrument type (e.g., COMMON_STOCK, OPTION) - `const V1OrderCancelAllOpenOrdersParamsInstrumentTypeCommonStock V1OrderCancelAllOpenOrdersParamsInstrumentType = "COMMON_STOCK"` - `const V1OrderCancelAllOpenOrdersParamsInstrumentTypePreferredStock V1OrderCancelAllOpenOrdersParamsInstrumentType = "PREFERRED_STOCK"` - `const V1OrderCancelAllOpenOrdersParamsInstrumentTypeOption V1OrderCancelAllOpenOrdersParamsInstrumentType = "OPTION"` - `const V1OrderCancelAllOpenOrdersParamsInstrumentTypeCash V1OrderCancelAllOpenOrdersParamsInstrumentType = "CASH"` - `const V1OrderCancelAllOpenOrdersParamsInstrumentTypeOther V1OrderCancelAllOpenOrdersParamsInstrumentType = "OTHER"` - `Side param.Field[V1OrderCancelAllOpenOrdersParamsSide]` Filter by order side (BUY or SELL) - `const V1OrderCancelAllOpenOrdersParamsSideBuy V1OrderCancelAllOpenOrdersParamsSide = "BUY"` - `const V1OrderCancelAllOpenOrdersParamsSideSell V1OrderCancelAllOpenOrdersParamsSide = "SELL"` - `const V1OrderCancelAllOpenOrdersParamsSideSellShort V1OrderCancelAllOpenOrdersParamsSide = "SELL_SHORT"` - `const V1OrderCancelAllOpenOrdersParamsSideOther V1OrderCancelAllOpenOrdersParamsSide = "OTHER"` - `Type param.Field[V1OrderCancelAllOpenOrdersParamsType]` Filter by order type (e.g., MARKET, LIMIT) - `const V1OrderCancelAllOpenOrdersParamsTypeMarket V1OrderCancelAllOpenOrdersParamsType = "MARKET"` - `const V1OrderCancelAllOpenOrdersParamsTypeLimit V1OrderCancelAllOpenOrdersParamsType = "LIMIT"` - `const V1OrderCancelAllOpenOrdersParamsTypeStop V1OrderCancelAllOpenOrdersParamsType = "STOP"` - `const V1OrderCancelAllOpenOrdersParamsTypeStopLimit V1OrderCancelAllOpenOrdersParamsType = "STOP_LIMIT"` - `const V1OrderCancelAllOpenOrdersParamsTypeTrailingStop V1OrderCancelAllOpenOrdersParamsType = "TRAILING_STOP"` - `const V1OrderCancelAllOpenOrdersParamsTypeTrailingStopLimit V1OrderCancelAllOpenOrdersParamsType = "TRAILING_STOP_LIMIT"` - `const V1OrderCancelAllOpenOrdersParamsTypeOther V1OrderCancelAllOpenOrdersParamsType = "OTHER"` ### Returns - `type V1OrderCancelAllOpenOrdersResponse struct{…}` - `Data OrderList` - `ID string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 ```go package main import ( "context" "fmt" "github.com/clear-street/clear-street-go" "github.com/clear-street/clear-street-go/option" ) func main() { client := clearstreet.NewClient( option.WithAPIKey("My API Key"), ) response, err := client.V1.Orders.CancelAllOpenOrders( context.TODO(), 0, clearstreet.V1OrderCancelAllOpenOrdersParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 - `type CancelOrderRequest struct{…}` 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. - `AccountID int64` Account ID (from path parameter) - `OrderID string` Order ID to cancel (from path parameter) ### Instrument ID Or Symbol - `type InstrumentIDOrSymbol string` OEMS instrument UUID ### New Order Request - `type NewOrderRequest struct{…}` Request to submit a new order (PlaceOrderRequest from spec) - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `OrderType RequestOrderType` Type of order - `const RequestOrderTypeMarket RequestOrderType = "MARKET"` - `const RequestOrderTypeLimit RequestOrderType = "LIMIT"` - `const RequestOrderTypeStop RequestOrderType = "STOP"` - `const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"` - `const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"` - `const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"` - `Quantity string` Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer) - `Side Side` Side of the order - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `TimeInForce RequestTimeInForce` Time in force - `const RequestTimeInForceDay RequestTimeInForce = "DAY"` - `const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"` - `const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"` - `const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"` - `const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"` - `const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"` - `const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"` - `const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"` - `const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"` - `const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"` - `ID string` Optional client-provided unique ID (idempotency). Required to be unique per account. - `ExpiresAt Time` The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Allow trading outside regular trading hours. Some brokers disallow options outside RTH. - `InstrumentID InstrumentIDOrSymbol` OEMS instrument UUID - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (required for LIMIT and STOP_LIMIT orders) - `PositionEffect PositionEffect` Required when instrument_type is OPTION. Specifies whether the order opens or closes a position. - `const PositionEffectOpen PositionEffect = "OPEN"` - `const PositionEffectClose PositionEffect = "CLOSE"` - `StopPrice string` Stop price (required for STOP and STOP_LIMIT orders) - `Symbol 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. - `TrailingOffset string` Trailing offset amount (required for trailing orders) - `TrailingOffsetType TrailingOffsetType` Trailing offset type (PRICE or PERCENT_BPS) - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` ### Order - `type Order struct{…}` 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). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 - `type OrderList []Order` - `ID string` Engine-assigned unique identifier for this order (UUID). - `AccountID int64` Account placing the order - `ClientOrderID string` Client-provided identifier echoed back (FIX tag 11). - `CreatedAt Time` Timestamp when order was created (UTC) - `FilledQuantity string` Cumulative filled quantity - `InstrumentID string` OEMS instrument UUID for the traded instrument. - `InstrumentType SecurityType` Type of security - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"` - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"` - `const SecurityTypeOption SecurityType = "OPTION"` - `const SecurityTypeCash SecurityType = "CASH"` - `const SecurityTypeOther SecurityType = "OTHER"` - `LeavesQuantity string` Remaining unfilled quantity - `OrderType OrderType` Type of order (MARKET, LIMIT, etc.) - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` - `Quantity string` Total order quantity - `Side Side` Side of the order (BUY, SELL, SELL_SHORT) - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` - `Status OrderStatus` Current status of the order - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` - `Symbol string` Trading symbol - `TimeInForce TimeInForce` Time in force instruction - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` - `UpdatedAt Time` Timestamp of the most recent update (UTC) - `Venue string` MIC code of the venue where the order is routed - `AverageFillPrice string` Average fill price across all executions - `Details []string` Contains execution, rejection or cancellation details, if any - `ExpiresAt Time` Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. - `ExtendedHours bool` Whether the order is eligible for extended-hours trading. - `LimitOffset string` Limit offset for trailing stop-limit orders (signed) - `LimitPrice string` Limit price (for LIMIT and STOP_LIMIT orders) - `QueueState QueueState` Parent order queue state, present when the order is awaiting release or released. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` - `ReleasesAt Time` Scheduled release time for orders awaiting release. - `StopPrice string` Stop price (for STOP and STOP_LIMIT orders) - `TrailingLimitPx string` Current trailing limit price computed by the trailing strategy - `TrailingOffset string` Trailing offset amount for trailing orders - `TrailingOffsetType TrailingOffsetType` Trailing offset type for trailing orders - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"` - `TrailingStopPx string` Current trailing stop price computed by the trailing strategy - `TrailingWatermarkPx string` Trailing watermark price for trailing orders - `TrailingWatermarkTs Time` Trailing watermark timestamp for trailing orders - `UnderlyingInstrumentID 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 - `type OrderStatus string` Order status - `const OrderStatusPendingNew OrderStatus = "PENDING_NEW"` - `const OrderStatusNew OrderStatus = "NEW"` - `const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"` - `const OrderStatusFilled OrderStatus = "FILLED"` - `const OrderStatusCanceled OrderStatus = "CANCELED"` - `const OrderStatusRejected OrderStatus = "REJECTED"` - `const OrderStatusExpired OrderStatus = "EXPIRED"` - `const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"` - `const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"` - `const OrderStatusReplaced OrderStatus = "REPLACED"` - `const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"` - `const OrderStatusStopped OrderStatus = "STOPPED"` - `const OrderStatusSuspended OrderStatus = "SUSPENDED"` - `const OrderStatusCalculated OrderStatus = "CALCULATED"` - `const OrderStatusOther OrderStatus = "OTHER"` ### Order Type - `type OrderType string` Order type - `const OrderTypeMarket OrderType = "MARKET"` - `const OrderTypeLimit OrderType = "LIMIT"` - `const OrderTypeStop OrderType = "STOP"` - `const OrderTypeStopLimit OrderType = "STOP_LIMIT"` - `const OrderTypeTrailingStop OrderType = "TRAILING_STOP"` - `const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"` - `const OrderTypeOther OrderType = "OTHER"` ### Position Effect - `type PositionEffect string` Position effect for options orders - `const PositionEffectOpen PositionEffect = "OPEN"` - `const PositionEffectClose PositionEffect = "CLOSE"` ### Queue State - `type QueueState string` Parent order queue or hold state. - `const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"` - `const QueueStateReleased QueueState = "RELEASED"` ### Request Order Type - `type RequestOrderType string` Strict order-type enum for order submission/replacement requests. - `const RequestOrderTypeMarket RequestOrderType = "MARKET"` - `const RequestOrderTypeLimit RequestOrderType = "LIMIT"` - `const RequestOrderTypeStop RequestOrderType = "STOP"` - `const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"` - `const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"` - `const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"` ### Request Time In Force - `type RequestTimeInForce string` Strict time-in-force enum for order submission/replacement requests. - `const RequestTimeInForceDay RequestTimeInForce = "DAY"` - `const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"` - `const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"` - `const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"` - `const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"` - `const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"` - `const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"` - `const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"` - `const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"` - `const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"` ### Side - `type Side string` Side of an order - `const SideBuy Side = "BUY"` - `const SideSell Side = "SELL"` - `const SideSellShort Side = "SELL_SHORT"` - `const SideOther Side = "OTHER"` ### Time In Force - `type TimeInForce string` Time in force - `const TimeInForceDay TimeInForce = "DAY"` - `const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"` - `const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"` - `const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"` - `const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"` - `const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"` - `const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"` - `const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"` - `const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"` - `const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"` - `const TimeInForceOther TimeInForce = "OTHER"` ### Trailing Offset Type - `type TrailingOffsetType string` Trailing offset type for trailing stop orders. - `const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"` - `const TrailingOffsetTypeBps TrailingOffsetType = "BPS"`