## Get Orders

`$ clear-street v1:orders get-orders`

**get** `/v1/accounts/{account_id}/orders`

List orders for an account with optional filtering

### Parameters

- `--account-id: number`

  Account identifier

- `--from: optional string`

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

- `--instrument-id: optional array of string`

  Comma-separated OEMS instrument UUIDs

- `--instrument-type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more`

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

- `--page-size: optional number`

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

- `--page-token: optional string`

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

- `--status: optional array of "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more`

  Comma-separated order statuses to filter by

- `--symbol: optional string`

  Filter by symbol

- `--to: optional string`

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

- `--underlying-instrument-ids: optional string`

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

### Returns

- `V1OrderGetOrdersResponse: BaseResponse`

  - `data: array of Order`

    - `id: string`

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

    - `account_id: number`

      Account placing the order

    - `client_order_id: string`

      Client-provided identifier echoed back (FIX tag 11).

    - `created_at: string`

      Timestamp when order was created (UTC)

    - `filled_quantity: string`

      Cumulative filled quantity

    - `instrument_id: string`

      OEMS instrument UUID for the traded instrument.

    - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more`

      Type of security

      - `"COMMON_STOCK"`

      - `"PREFERRED_STOCK"`

      - `"OPTION"`

      - `"CASH"`

      - `"OTHER"`

    - `leaves_quantity: string`

      Remaining unfilled quantity

    - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more`

      Type of order (MARKET, LIMIT, etc.)

      - `"MARKET"`

      - `"LIMIT"`

      - `"STOP"`

      - `"STOP_LIMIT"`

      - `"TRAILING_STOP"`

      - `"TRAILING_STOP_LIMIT"`

      - `"OTHER"`

    - `quantity: string`

      Total order quantity

    - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"`

      Side of the order (BUY, SELL, SELL_SHORT)

      - `"BUY"`

      - `"SELL"`

      - `"SELL_SHORT"`

      - `"OTHER"`

    - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more`

      Current status of the order

      - `"PENDING_NEW"`

      - `"NEW"`

      - `"PARTIALLY_FILLED"`

      - `"FILLED"`

      - `"CANCELED"`

      - `"REJECTED"`

      - `"EXPIRED"`

      - `"PENDING_CANCEL"`

      - `"PENDING_REPLACE"`

      - `"REPLACED"`

      - `"DONE_FOR_DAY"`

      - `"STOPPED"`

      - `"SUSPENDED"`

      - `"CALCULATED"`

      - `"OTHER"`

    - `symbol: string`

      Trading symbol

    - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more`

      Time in force instruction

      - `"DAY"`

      - `"GOOD_TILL_CANCEL"`

      - `"IMMEDIATE_OR_CANCEL"`

      - `"FILL_OR_KILL"`

      - `"GOOD_TILL_DATE"`

      - `"AT_THE_OPENING"`

      - `"AT_THE_CLOSE"`

      - `"GOOD_TILL_CROSSING"`

      - `"GOOD_THROUGH_CROSSING"`

      - `"AT_CROSSING"`

      - `"OTHER"`

    - `updated_at: string`

      Timestamp of the most recent update (UTC)

    - `venue: string`

      MIC code of the venue where the order is routed

    - `average_fill_price: optional string`

      Average fill price across all executions

    - `details: optional array of string`

      Contains execution, rejection or cancellation details, if any

    - `expires_at: optional string`

      Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

    - `extended_hours: optional boolean`

      Whether the order is eligible for extended-hours trading.

    - `limit_offset: optional string`

      Limit offset for trailing stop-limit orders (signed)

    - `limit_price: optional string`

      Limit price (for LIMIT and STOP_LIMIT orders)

    - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"`

      Parent order queue state, present when the order is awaiting release or released.

      - `"AWAITING_RELEASE"`

      - `"RELEASED"`

    - `releases_at: optional string`

      Scheduled release time for orders awaiting release.

    - `stop_price: optional string`

      Stop price (for STOP and STOP_LIMIT orders)

    - `trailing_limit_px: optional string`

      Current trailing limit price computed by the trailing strategy

    - `trailing_offset: optional string`

      Trailing offset amount for trailing orders

    - `trailing_offset_type: optional "PRICE" or "BPS"`

      Trailing offset type for trailing orders

      - `"PRICE"`

      - `"BPS"`

    - `trailing_stop_px: optional string`

      Current trailing stop price computed by the trailing strategy

    - `trailing_watermark_px: optional string`

      Trailing watermark price for trailing orders

    - `trailing_watermark_ts: optional string`

      Trailing watermark timestamp for trailing orders

    - `underlying_instrument_id: optional string`

      OEMS instrument ID of the option's underlying instrument. Populated only
      for OPTIONS orders; `null` for non-options and for options whose underlier
      cannot be resolved from the instrument cache.

### Example

```cli
clear-street v1:orders get-orders \
  --api-key 'My API Key' \
  --account-id 0
```

#### Response

```json
{
  "data": [
    {
      "account_id": 19816,
      "average_fill_price": "149.95",
      "client_order_id": "my-ref-id-20251001-001",
      "created_at": "2025-10-31T13:30:00.000000000Z",
      "filled_quantity": "50",
      "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
      "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "50",
      "limit_price": "150.00",
      "order_type": "LIMIT",
      "quantity": "100",
      "side": "BUY",
      "status": "PARTIALLY_FILLED",
      "stop_price": null,
      "symbol": "AAPL",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T13:35:10.000000000Z"
    },
    {
      "account_id": 19816,
      "average_fill_price": "450.75",
      "client_order_id": "my-ref-id-20251001-002",
      "created_at": "2025-10-31T14:00:00.000000000Z",
      "filled_quantity": "200",
      "id": "0195f6c8-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
      "instrument_id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "0",
      "limit_price": null,
      "order_type": "MARKET",
      "quantity": "200",
      "side": "SELL",
      "status": "FILLED",
      "stop_price": null,
      "symbol": "MSFT",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T14:00:05.000000000Z"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "cGFnZT0yJmxhc3RfaWQ9b3JkXzRjRDVlNkY3ZzhIOWkwSjE=",
    "page_number": 1,
    "request_id": "d9a4f5b6-c3d4-6e5f-0a1b-7c8d9e0f1a2b",
    "total_items": 25,
    "total_pages": 3
  }
}
```