CLclear-street
Orders

Get Orders

Changed on

List orders for an account with optional filtering

get/v1/accounts/{account_id}/orders

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Account identifier

Query parameters

page_sizeinteger

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

page_tokenstring byte

Base64URL-encoded pagination token

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

order_idsstring[]

Comma-separated list of order identifiers. Each value may be an order's id or its client_order_id; only orders matching one of the given identifiers are returned.

statusstring[]

Comma-separated order statuses to filter by

symbolstring

Filter by symbol

instrument_idsInstrumentIdOrSymbol[]

Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).

instrument_type'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH'

Security type

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

underlying_instrument_idsInstrumentIdOrSymbol[]

Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches options orders whose resolved underlier is any of the given instruments.

updated_at.gtstring

Return only rows where updated_at is strictly after the given value. A bare YYYY-MM-DD date expands to the end of that day (UTC), so this matches from the start of the following day. See Range filters for accepted formats, bare-date expansion, and combining bounds. Returns 400 if the resulting range is inverted.

updated_at.gtestring

Return only rows where updated_at is on or after the given value. A bare YYYY-MM-DD date expands to the start of that day (UTC). See Range filters for accepted formats, bare-date expansion, and combining bounds. Returns 400 if the resulting range is inverted.

updated_at.ltstring

Return only rows where updated_at is strictly before the given value. A bare YYYY-MM-DD date expands to the start of that day (UTC). See Range filters for accepted formats, bare-date expansion, and combining bounds. Returns 400 if the resulting range is inverted.

updated_at.ltestring

Return only rows where updated_at is on or before the given value. A bare YYYY-MM-DD date expands to the end of that day (UTC), so this matches through the end of that day. See Range filters for accepted formats, bare-date expansion, and combining bounds. Returns 400 if the resulting range is inverted.

fromstring date-time

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

tostring date-time

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

Response

List of orders

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": [
    {
      "account_id": 19816,
      "client_order_id": "my-ref-id-20251001-001",
      "created_at": "2025-10-31T13:30:00.000000000Z",
      "extended_hours": false,
      "filled_quantity": "0",
      "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
      "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
      "instrument_type": "COMMON_STOCK",
      "leaves_quantity": "1",
      "limit_price": "48.00",
      "order_type": "LIMIT",
      "quantity": "1",
      "side": "BUY",
      "status": "PENDING_NEW",
      "stop_price": null,
      "symbol": "TSLA",
      "time_in_force": "DAY",
      "updated_at": "2025-10-31T13:30:00.000000000Z",
      "venue": "XNAS"
    }
  ]
}

Changes

  • 7e4b278ca27aRevision changes
    • warning

      removed the optional property /// from the response with the status

  • 1bd9eddeffc8Revision changes
    • warning

      for the query request parameter instrument_ids, the type of property items/ changed from no type to string

    • warning

      for the query request parameter underlying_instrument_ids, the type of property items/ changed from no type to string

    • warning

      added the new AT_CLOSE enum value to the /// response property for the response status

    • warning

      added the new AT_OPEN enum value to the /// response property for the response status

    • warning

      added the new PENDING_TRIGGER enum value to the /// response property for the response status

    • warning

      added the new QUEUED enum value to the /// response property for the response status

    • info

      added the new optional query request parameter updated_at.gt

    • info

      added the new optional query request parameter updated_at.gte

    • info

      added the new optional query request parameter updated_at.lt

    • info

      added the new optional query request parameter updated_at.lte

    • info

      added the enum value PENDING_TRIGGER to the property items/ of the query request parameter status

    • info

      added the enum value QUEUED to the property items/ of the query request parameter status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the AT_CROSSING enum value from the /// response property for the response status

    • info

      removed the AT_THE_CLOSE enum value from the /// response property for the response status

    • info

      removed the AT_THE_OPENING enum value from the /// response property for the response status

    • info

      removed the GOOD_THROUGH_CROSSING enum value from the /// response property for the response status

    • info

      removed the GOOD_TILL_CROSSING enum value from the /// response property for the response status

    • info

      removed the OTHER enum value from the /// response property for the response status

    • info

      removed the SELL_SHORT enum value from the /// response property for the response status