Skip to content
Clear Street Clear Street
Get started
API Reference
V1
Watchlist

Get Watchlists

v1.watchlist.get_watchlists(WatchlistGetWatchlistsParams**kwargs) -> WatchlistGetWatchlistsResponse
GET/v1/watchlists

List watchlists for the authenticated user

ParametersExpand Collapse
page_size: Optional[int]

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

formatint64
maximum1000
minimum1
page_token: Optional[Union[str, Base64FileInput]]

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

formatbyte
ReturnsExpand Collapse
class WatchlistGetWatchlistsResponse: …
id: str

The unique identifier for the watchlist.

formatuuid
created_at: datetime

The timestamp when the watchlist was created.

formatdate-time
name: str

The user-provided watchlist name.

Get Watchlists

from clear_street import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.watchlist.get_watchlists()
print(response)
{
  "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
  }
}