Skip to main content

Documentation Index

Fetch the complete documentation index at: https://finance.dev/llms.txt

Use this file to discover all available pages before exploring further.

Overview

The Watchlist API allows you to create, update, and delete watchlists for tracking securities.

Methods

getWatchlists(accountId)

const watchlists = await client.watchlist.getWatchlists('acc_123');
watchlists.forEach(wl => {
  console.log(`${wl.name}: ${wl.symbols.length} symbols`);
});

createWatchlist(accountId, name, symbols)

const watchlist = await client.watchlist.createWatchlist(
  'acc_123',
  'Tech Stocks',
  ['AAPL', 'GOOGL', 'MSFT']
);

updateWatchlist(watchlistId, symbols)

await client.watchlist.updateWatchlist('wl_123', symbols);

deleteWatchlist(watchlistId)

await client.watchlist.deleteWatchlist('wl_123');

Examples

const wl = await client.watchlist.createWatchlist(
  'acc_123',
  'My Favorites',
  ['AAPL', 'TSLA', 'NVDA']
);

await client.watchlist.updateWatchlist(
  wl.id,
  [...wl.symbols, 'AMD', 'INTC']
);