zfin/docs/reference/cli/lookup.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

36 lines
919 B
Markdown

# `zfin lookup`
Resolve a CUSIP (9-character security identifier) to its ticker via the
OpenFIGI API.
```
Usage: zfin lookup <CUSIP>
```
Successful results are cached indefinitely in `cusip_tickers.srf`.
`OPENFIGI_API_KEY` raises the rate limit, but the unauthenticated tier
works for low volume. Mutual funds frequently have no OpenFIGI
coverage; the command says so and suggests a manual portfolio entry.
## Example
```bash
zfin lookup 037833100
```
```
037833100 → AAPL
```
Use this when a holding in your portfolio is identified by CUSIP (e.g.
a 401k share class) and you need its ticker for a `ticker::` alias. See
[ticker aliases](../config/portfolio-srf.md#ticker-aliases-and-cusips).
## See also
- [`portfolio.srf` reference](../config/portfolio-srf.md) -- using `ticker::` aliases.
- [Environment variables](../config/environment.md) -- `OPENFIGI_API_KEY`.
---
[CLI command reference](index.md)