Watchlists API
List your watchlists, page the companies on one list, and add or remove them with the same company id as Entity Reference.
Watchlists let you sync the lists you already curate in Alpha Analyst into your own apps and automations: read list names and counts, page the companies on a list, and add or remove symbols with the same ids you use on Entities. Creating, renaming, or deleting a list stays in the product UI.
Platform-linked Watchlists for the login behind your key—same as on the website. That login needs an API plan and watchlists on its website plan; the key is enough. How platform-linked access works.
A company id here is the same id as Entity Reference: AAPL, AAPL US, a CIK, a LEI, an EDINET code, or a FIGI.
What to call
| You have | Call |
|---|---|
| You want the lists on this account | Watchlists |
A watchlist_id and you want the companies | Watchlist Entities |
| Companies to add, remove, or both | Update Watchlist |
Watchlists is the cheap call. It returns names and counts and does not resolve each company. Watchlist Entities resolves one page (default 20, maximum 25), newest addition first. Each company is the Entity item, the same object as Entity Reference. Pass the returned id to filings, financials, or remove.
Update Watchlist takes add and remove on one call. At most 20 ids in each. remove runs first, then add. An id in both lists ends on the watchlist. Ids that do not resolve come back in unresolved and are not stored.
Coverage
- Whose lists. The signed-in user, plus lists shared with their organization. Another user's private list is 404.
- Access. Platform-linked: API plan + website plan with watchlists on the key’s login; same rules as the app. How it works.
- Pages. Watchlists default to 50 per page (maximum 100). Companies default to 20 (maximum 25).
truncatedis true when another page exists.pagestarts at 1. - Not covered. Creating, renaming, or deleting a watchlist. Prices, filings, and financials for a company — use the
idfrom Watchlist Entities on those tools.