Alert settings (instant alerts, big insider moves, daily email)
set_alert_preferencesTurn the user's CapitalSnitch email alerts on or off (Edge plan): instant watchlist alerts, market-wide 'big insider moves' alerts, and the daily briefing email. Omit a setting to leave it unchanged; call with no settings to see the current ones. Use for 'alert me about any big insider buys', 'stop the daily email', 'turn my alerts on'. Never counts toward the daily limit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| daily_email | No | The weekday morning briefing email. | |
| instant_alerts | No | Email alerts for watchlist companies. | |
| big_moves_alerts | No | Email alerts for major insider moves across the WHOLE market: CEO/CFO purchases of $1M+ and high-conviction cluster buying, even outside the watchlist. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Caveats, data-quality notes, next steps. | |
| results | Yes | Structured results (rows or an object). | |
| sources | Yes | Links to official SEC filings / pages backing the answer. | |
| summary | Yes | Plain-language answer. Quote this, then cite sources. | |
| data_as_of | Yes | Latest SEC filing date included in the data (YYYY-MM-DD). | |
| disclaimer | No | Public-record data for research and education. Not investment advice. Insider trades can be routine (pre-planned 10b5-1 sales, taxes, diversification); correlation is not causation. |