Get Watchlists

$ clear-street v1:watchlist get-watchlists

GET/v1/watchlists

List watchlists for the authenticated user

ParametersExpand Collapse

--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.

ReturnsExpand Collapse

V1WatchlistGetWatchlistsResponse: BaseResponse { metadata, error }

data: array of WatchlistEntry { id, created_at, name }

id: string

The unique identifier for the watchlist.

created_at: string

The timestamp when the watchlist was created.

name: string

The user-provided watchlist name.

Get Watchlists

clear-street v1:watchlist get-watchlists \
  --api-key 'My API Key'

{
  "data": [
    {
      "created_at": "2025-01-15T10:00:00.000000000Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Tech Stocks"
    },
    {
      "created_at": "2025-01-10T14:30:00.000000000Z",
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Dividend Portfolio"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": null,
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "total_items": 2,
    "total_pages": 1
  }
}

Returns Examples

{
  "data": [
    {
      "created_at": "2025-01-15T10:00:00.000000000Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Tech Stocks"
    },
    {
      "created_at": "2025-01-10T14:30:00.000000000Z",
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Dividend Portfolio"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": null,
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "total_items": 2,
    "total_pages": 1
  }
}