docs(market): CLI reference for entities, prices, fts and gaps

This commit is contained in:
kert
2026-11-14 10:30:22 -05:00
parent c87d3c5ead
commit b3123d77af
5 changed files with 140 additions and 0 deletions

View File

@@ -0,0 +1,22 @@
---
title: stack market entities
sidebar_position: 161
---
# `stack market entities`
```
Usage: stack market entities [OPTIONS]
Entity registry (market.entity, security, filing, entity_link): the cited seed
of companies and organizations joined to EDGAR tickers, submissions and
filings; --sic-sweep adds every health-SIC filer.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --sic-sweep Also register every 10-K filer in HEALTH_SICS. │
│ --refresh Download again (a changed body lands beside the old). │
│ --offline Use only the hoarded files. │
│ --write Store entities, securities, filings and links. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

View File

@@ -0,0 +1,36 @@
---
title: stack market fts
sidebar_position: 163
---
# `stack market fts`
```
Usage: stack market fts [OPTIONS]
EDGAR full-text search for program and family terms in 10-K filings: hits
(market.filing_hit), verbatim passages of at most 400 characters that pass the
AMA guard (market.filing_passage) and ``fts`` links (market.entity_link) for
health-SIC and seed companies. A link needs a kept passage. Everything fetched
is hoarded; a rerun resumes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --family <str> A family key (repeatable). │
│ --program <str> A program key (repeatable; all when none │
│ given). │
│ --forms <str> Filing form to search (repeatable). │
│ [default: 10-K] │
│ --from <int> [default: 2001] │
│ --to <int> Default: this year. [default: 0] │
│ --limit <int> At most N new filing downloads and model │
│ calls. │
│ [default: 0] │
│ --max-minutes <float> Stop fetching after this long (rerun resumes). │
│ [default: 0.0] │
│ --refresh Download again. │
│ --dry-run List the queries only. │
│ --classify Label passages with the local model. │
│ --write Store hits, passages, links. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

View File

@@ -0,0 +1,16 @@
---
title: stack market gaps
sidebar_position: 164
---
# `stack market gaps`
```
Usage: stack market gaps [OPTIONS]
Sources that could not be read (market.source_gap).
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

View File

@@ -0,0 +1,29 @@
---
title: stack market prices
sidebar_position: 162
---
# `stack market prices`
```
Usage: stack market prices [OPTIONS]
Tiingo daily prices and total returns (market.price_daily) and the month-end
total-return series (market.series, #797). Prices are internal use only. The
monthly symbol allowance is 450; a first pull of a symbol starts at its
listing, later pulls at the last stored day.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --ticker <str> Price this ticker (repeatable). │
│ --universe The ranked, capped universe (seed + │
│ filing-linked). │
│ --benchmarks SPY, XLV and IHF. │
│ --limit <int> Download at most this many symbols (0 = no │
│ limit). │
│ [default: 0] │
│ --refresh Download again even if priced or hoarded today. │
│ --dry-run Print the ranked universe and the budget only. │
│ --write Store prices, returns and the monthly series. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

37
docs/docs/cli/market.md Normal file
View File

@@ -0,0 +1,37 @@
---
title: stack market
sidebar_position: 160
---
# `stack market`
```
Usage: stack market [OPTIONS] COMMAND [ARGS]...
Market and enrichment tier: exposed companies, prices, lobbying, Congress.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ entities Entity registry (market.entity, security, filing, entity_link): │
│ the │
│ cited seed of companies and organizations joined to EDGAR tickers, │
│ submissions and filings; --sic-sweep adds every health-SIC filer. │
│ prices Tiingo daily prices and total returns (market.price_daily) and the │
│ month-end total-return series (market.series, #797). Prices are │
│ internal │
│ use only. The monthly symbol allowance is 450; a first pull of a │
│ symbol │
│ starts at its listing, later pulls at the last stored day. │
│ fts EDGAR full-text search for program and family terms in 10-K │
│ filings: │
│ hits (market.filing_hit), verbatim passages of at most 400 │
│ characters │
│ that pass the AMA guard (market.filing_passage) and ``fts`` links │
│ (market.entity_link) for health-SIC and seed companies. A link │
│ needs a │
│ kept passage. Everything fetched is hoarded; a rerun resumes. │
│ gaps Sources that could not be read (market.source_gap). │
╰──────────────────────────────────────────────────────────────────────────────╯
```