## 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 } } ```