Skip to main content
GET
Get Watchlist

Authorizations

Authorization
string
header
required

OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.

Path Parameters

watchlist_id
integer<int64>
required

The numeric ID of the watchlist to retrieve. You can get this from a previous list/create/update response (the id field in the returned watchlist).

Example:

12345

Response

The requested watchlist.

Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders.

id
integer<int64>

Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist.

invalid_symbols
string[]

Symbols from the request that could not be resolved and were dropped from symbols. Only present on create and update responses when at least one submitted symbol failed resolution.

name
string

User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app.

symbols
string[] | null

Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search. May be null for a watchlist saved through Replace All Watchlists without symbols.