Watchlist

Get Watchlists

List watchlists for the authenticated user

get/v1/watchlists

Request

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

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.

Response

List of watchlists

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes

No recorded changes to this operation across all 62 revisions of this API.