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

ParametersExpand Collapse

accountID int64

query V1OrderGetOrdersParams

From param.Field[Time]Optional

The start date and time for the query range, inclusive (ISO 8601 format)

formatdate-time

InstrumentIDs param.Field[[]string]Optional

Comma-separated instrument identifiers

InstrumentType param.Field[V1OrderGetOrdersParamsInstrumentType]Optional

Instrument type filter (e.g., COMMON_STOCK, OPTION)

const V1OrderGetOrdersParamsInstrumentTypeCommonStock V1OrderGetOrdersParamsInstrumentType = "COMMON_STOCK"

const V1OrderGetOrdersParamsInstrumentTypeOption V1OrderGetOrdersParamsInstrumentType = "OPTION"

const V1OrderGetOrdersParamsInstrumentTypeCash V1OrderGetOrdersParamsInstrumentType = "CASH"

OrderIDs param.Field[[]string]Optional

Comma-separated order IDs to filter by. When provided, only orders whose order ID is in this set are returned.

PageSize param.Field[int64]Optional

The number of items to return per page. Only used when page_token is not provided.

formatint64

maximum1000

minimum1

PageToken param.Field[string]Optional

Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.

formatbyte

Status param.Field[[]string]Optional

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]Optional

Filter by symbol

To param.Field[Time]Optional

The end date and time for the query range, inclusive (ISO 8601 format)

formatdate-time

UnderlyingInstrumentIDs param.Field[[]string]Optional

Comma-separated instrument identifiers. Matches options orders whose resolved underlier is any of the given IDs.

ReturnsExpand Collapse

type V1OrderGetOrdersResponse struct{…}

Data OrderList

ID string

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

AccountID int64

Account placing the order

formatint64

ClientOrderID string

Client-provided identifier echoed back.

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time

FilledQuantity string

Cumulative filled quantity

InstrumentID string

Instrument identifier for the traded instrument.

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LeavesQuantity string

Remaining unfilled quantity

OrderType OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

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)

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Status OrderStatus

Current status of the order

One of the following:

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

One of the following:

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)

formatdate-time

Venue string

MIC code of the venue where the order is routed

AverageFillPrice stringOptional

Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.

Details []stringOptional

Contains execution, rejection or cancellation details, if any

ExpiresAt TimeOptional

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

QueueState QueueStateOptional

Parent order queue state, present when the order is awaiting release or released. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

ReleasesAt TimeOptional

Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingOffset stringOptional

Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type for trailing orders When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkPx stringOptional

Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

UnderlyingInstrumentID stringOptional

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Get Orders

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)
}

{
  "data": [
    {
      "account_id": 19816,
      "average_fill_price": "47.95",
      "client_order_id": "my-ref-id-20251001-001",
      "created_at": "2025-10-31T13:30:00.000000000Z",
      "filled_quantity": "5",
      "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
      "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "5",
      "limit_price": "48.00",
      "order_type": "LIMIT",
      "quantity": "10",
      "side": "BUY",
      "status": "PARTIALLY_FILLED",
      "stop_price": null,
      "symbol": "TSLA",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T13:35:10.000000000Z",
      "venue": "XNAS"
    },
    {
      "account_id": 19816,
      "average_fill_price": "50.03",
      "client_order_id": "my-ref-id-20251001-002",
      "created_at": "2025-10-31T14:00:00.000000000Z",
      "filled_quantity": "10",
      "id": "0195f6c8-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
      "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "0",
      "limit_price": null,
      "order_type": "MARKET",
      "quantity": "10",
      "side": "SELL",
      "status": "FILLED",
      "stop_price": null,
      "symbol": "TSLA",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T14:00:05.000000000Z",
      "venue": "XNAS"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "cGFnZT0yJmxhc3RfaWQ9b3JkXzRjRDVlNkY3ZzhIOWkwSjE=",
    "page_number": 1,
    "request_id": "d9a4f5b6-c3d4-6e5f-0a1b-7c8d9e0f1a2b",
    "total_items": 25,
    "total_pages": 3
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

Returns Examples

{
  "data": [
    {
      "account_id": 19816,
      "average_fill_price": "47.95",
      "client_order_id": "my-ref-id-20251001-001",
      "created_at": "2025-10-31T13:30:00.000000000Z",
      "filled_quantity": "5",
      "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
      "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "5",
      "limit_price": "48.00",
      "order_type": "LIMIT",
      "quantity": "10",
      "side": "BUY",
      "status": "PARTIALLY_FILLED",
      "stop_price": null,
      "symbol": "TSLA",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T13:35:10.000000000Z",
      "venue": "XNAS"
    },
    {
      "account_id": 19816,
      "average_fill_price": "50.03",
      "client_order_id": "my-ref-id-20251001-002",
      "created_at": "2025-10-31T14:00:00.000000000Z",
      "filled_quantity": "10",
      "id": "0195f6c8-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
      "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "0",
      "limit_price": null,
      "order_type": "MARKET",
      "quantity": "10",
      "side": "SELL",
      "status": "FILLED",
      "stop_price": null,
      "symbol": "TSLA",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T14:00:05.000000000Z",
      "venue": "XNAS"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "cGFnZT0yJmxhc3RfaWQ9b3JkXzRjRDVlNkY3ZzhIOWkwSjE=",
    "page_number": 1,
    "request_id": "d9a4f5b6-c3d4-6e5f-0a1b-7c8d9e0f1a2b",
    "total_items": 25,
    "total_pages": 3
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}