Watchlists

Watchlists let users save and organize groups of instruments for quick reference. Each user can maintain multiple watchlists, and each can hold up to 1,000 instruments.

Recommended Client Flow for Watchlist

1. You can create your first watchlist by using the create watchlist endpoint POST v1/watchlists and providing a name
   1. Once that is done you can confirm the watchlist was created by taking the watchlist_id from the POST call and checking the get watchlist by id endpoint GET /v1/watchlists/{watchlist_id}
2. Now it’s time to populate the watchlist by using the add watchlist item endpoint POST /v1/watchlists/{watchlist_id}/items . In the body of the post request you will pass an instrument_id.
   1. Remove unwanted items with the delete watchlist item endpoint DELETE /v1/watchlists/{watchlist_id}/items/{item_id} to remove it. The item_id will be returned when you made the previous post call or if you are looking to remove it at a later point in time you can use the get watchlist endpoint in step 1.a to get the same item_id
3. Additionally if you decide you do not want to keep a watchlist altogether you cycle through the different watchlists you have created by using get watchlist endpoint GET /v1/watchlists and use the watchlist_id that you retrieved and pass it to delete watchlist endpoint DELETE /v1/watchlists/{watchlist_id}

---