1. Get Your Watchlists
First, retrieve the list of watchlists currently associated with your account. This will provide you with thewatchlistId needed for further management actions.
Endpoint: GET /api/v1/watchlists
Note: You can use the ensureBuiltinWatchlists parameter to make sure system default lists are included in the response.
2. Create a New Watchlist
You can create a custom watchlist by specifying a name. Endpoint:POST /api/v1/watchlists
| Parameter | Type | Description |
|---|---|---|
name | Query | The display name for your new watchlist (e.g., “Tech Stocks”). |
3. Add Instruments to a Watchlist
Once a watchlist is created, you can add instruments to it using itswatchlistId.
Endpoint: POST /api/v1/watchlists/{watchlistId}/items
4. Set a Default Watchlist
The “Default” watchlist is the one that appears immediately when you log in. Endpoint:PUT /api/v1/watchlists/setUserSelectedUserDefault/{watchlistId}
5. Delete a Watchlist
Remove a watchlist and all its contained items permanently. Endpoint:DELETE /api/v1/watchlists/{watchlistId}