Skip to main content

​
Overview

The bigdata_edit_watchlist tool updates a watchlist you own in your Bigdata.com account. In a single call you can rename it, change or clear its description, add Knowledge Graph IDs, remove Knowledge Graph IDs, or any combination of these. Fields you leave out are unchanged.

​
When to Use

Edit Watchlist is ideal for:
  • Rebalancing: Adding new positions and removing closed ones after a portfolio update
  • Growing a list: Extending a watchlist beyond the 100 items allowed at creation time
  • Housekeeping: Renaming a watchlist or rewriting its description so it is easy to find later
Items must be Knowledge Graph IDs, not company names or tickers. Resolve them with find_securities or get_securities first.

​
How It Works

  1. Find the watchlist id with bigdata_get_watchlist if the user has not supplied it
  2. Resolve any securities to add or remove to their Knowledge Graph IDs
  3. Call bigdata_edit_watchlist with the id and at least one change
  4. Read the returned watchlist to confirm the final items

​
Parameters

​
Important Notes

  • At least one of name, description, add_items, or remove_items is required. A call with only id returns the error at least one of name, description, add_items, or remove_items is required
  • The same ID cannot appear in both add_items and remove_items
  • Adds and removes are applied as set operations. There is no way to reorder items or replace the whole list in one call. To replace the list, remove the current items and add the new ones
  • Only watchlists you own can be edited

​
Data Returned

Returns a JSON object with a watchlists array containing the updated watchlist:

​
Usage Monitoring

The tool bigdata_edit_watchlist does not consume any quota.

​
Practical Tips

​
Confirm before removing

When a user asks to remove positions by name, resolve the names first and show the IDs and matching securities before calling the tool, so the wrong entity is not dropped.

​
Next steps after editing

Pass the returned items to bigdata_portfolio_tearsheet to refresh the grid for the updated list.