state
Archive Watchlist
delete_watchlistBenchmark and above
Soft-delete a watchlist by its name (not id): status flips to `archived` (still readable via list_watchlists status=all/archived). The name is freed for reuse by a new save_watchlist. Idempotent. Tier: sp500+ (sample rejected).
Example Call
example_call.pypython
# Using the Valuein MCP server from Python (via MCP SDK)# Or call directly from Claude / Cursor after setup result = await client.call_tool( "delete_watchlist", arguments={ "name": "EXAMPLE"})print(result)Direct tool call:delete_watchlist(...)
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | required | Watchlist name to soft-delete (case-insensitive, 1–80 chars); frees the name for reuse. |
Output Fields
watchlist_idstatusExample Response
Illustrative
response.jsonjson
{ "watchlist_id": null, "status": "ACTIVE"}Shape only — field names match the live schema; values are placeholders, not real filings. See MCP server for the structured response shape.
Notes
Available from the Benchmark plan and above.
Plan Access
Sample (guest)
Not includedBenchmark (token)
AvailablePro
AvailableInstitutional
AvailableRelated Tools
Index names are trademarks of their owners; Valuein is not affiliated with or endorsed by any index provider.