Skip to main content

Overview

The bigdata_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 in items.

When to Use

Get Watchlist is ideal for:
Never guess a watchlist ID. Call the tool without an id first to list owned watchlists, or take the ID from the watchlist URL in the Bigdata App.

How It Works

  1. List owned watchlists by calling the tool without an id
  2. Pick the watchlist by name and take its id
  3. Fetch it by calling the tool again with that id to load items
  4. 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 id to 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 a watchlists array. List mode example
Fetch mode example

Usage Monitoring

The tool bigdata_get_watchlist does not consume any quota.

Practical Tips

From watchlist to analysis

Pass items 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.

Presenting results

Show the watchlist name and item count first, then the securities. To display names and tickers rather than raw IDs, resolve them through the portfolio tearsheet, whose identity columns always include company name and ticker.