Skip to main content
POST
Create Watchlist

Authorizations

Authorization
string
header
required

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

Body

application/json

Name and initial symbols for the new watchlist. name is required; symbols is optional.

Request body for creating a new watchlist.

name
string
required

User-facing name for the new watchlist, such as Tech Stocks or Dividend Ideas. Must not match the name of another watchlist the user already has (case-sensitive).

Minimum string length: 1
symbols
string[]

Symbols to save in the new watchlist. Use exact uppercase ticker symbols; symbols that can't be resolved are dropped from the saved list and returned in the response's invalid_symbols field.

Example:

Response

Watchlist created. The response contains the saved watchlist; check invalid_symbols for any submitted symbols that were dropped.

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.