Overview
Thebigdata_get_watchlist tool reads watchlists from your Bigdata.com account. It has two modes depending on whether you pass an id:
- List mode (no
id): returns the watchlists the caller owns, with name and description only. Shared, public, and global watchlists are not included. - Fetch mode (with
id): returns one watchlist the caller can read, including shared watchlists when the ID is known, together with the Knowledge Graph IDs initems.
When to Use
Get Watchlist is ideal for:- Discovering watchlists: Finding out which watchlists exist before editing, deleting, or analyzing one
- Loading holdings: Retrieving the entity IDs of a watchlist to pass to
bigdata_portfolio_tearsheetor to buildbigdata_searchfilters - Resolving an ID: Turning a watchlist name into the
idrequired bybigdata_edit_watchlistandbigdata_delete_watchlist
How It Works
- List owned watchlists by calling the tool without an
id - Pick the watchlist by name and take its
id - Fetch it by calling the tool again with that
idto loaditems - Use the returned IDs with other tools, for example a portfolio tearsheet across the whole list
Parameters
Important Notes
- List mode returns metadata only. Make a second call with an
idto get the entity IDs - List mode only shows watchlists you own. A watchlist shared with you can still be fetched by ID
- Watchlists created in the Bigdata App can hold more than 100 items, and fetch mode returns all of them
- An unknown ID returns an error, for example
Watchlist <id> not found
Data Returned
Both modes return a JSON object with awatchlists array.
List mode example
Usage Monitoring
The toolbigdata_get_watchlist does not consume any quota.
Practical Tips
From watchlist to analysis
Passitems straight into bigdata_portfolio_tearsheet for a consolidated grid, or into the entity filters of bigdata_search to search news, filings, and transcripts across the whole watchlist.