zfin/docs/reference/config/watchlist-srf.md
Emil Lerch 74fc219afd
All checks were successful
Generic zig build / build (push) Successful in 5m48s
Generic zig build / publish-macos (push) Successful in 11s
Generic zig build / deploy (push) Successful in 23s
add docs/guides
2026-06-22 14:53:53 -07:00

45 lines
1.6 KiB
Markdown

# `watchlist.srf` reference
A watchlist tracks the price of symbols you don't own. Watchlist
symbols appear at the bottom of the portfolio view (and the TUI
Portfolio tab) showing their latest price, with no position, cost, or
weight.
zfin loads `watchlist.srf` from `ZFIN_HOME` (or the current
directory), or from an explicit path with the `-w` / `--watchlist`
flag. It is optional.
## File format
One `symbol::` per line, under the standard `#!srfv1` header:
```srf
#!srfv1
symbol::MSFT
symbol::NVDA
symbol::TSLA
```
## Two ways to watch a symbol
| Approach | When to use |
|---------------------------------------------------------------------|---------------------------------------------------------------------------|
| A `watchlist.srf` file (above) | A standalone list you reuse across portfolios, or one you pass with `-w`. |
| A `security_type::watch` lot in [`portfolio.srf`](portfolio-srf.md) | You want the watch entry to live alongside your holdings. |
```srf
# Equivalent watch entry inside portfolio.srf
security_type::watch,symbol::NVDA
```
The two sources are merged: the effective watchlist is the union of
the watchlist file and any `watch` lots in the portfolio.
## See also
- [`portfolio.srf`](portfolio-srf.md) -- the `watch` security type.
- [`zfin quote`](../cli/quote.md) -- a one-off price check without adding to a watchlist.
---
[Documentation home](../../README.md#reference)