screen
Screen the market for companies that match a condition, returned ranked. kind selects the
screen, and which arguments apply:
- "universe" (aliases: metric, rank): rank every filer by a reported metric (e.g. revenue,
net_income, assets), over period.
- "valuation" (aliases: value, cheap): rank by a ratio (e.g. pe_ratio, ev_to_ebitda,
price_to_book), bounded by min_value/max_value; multiples sort cheapest first.
- "buybacks" (aliases: buyback, repurchases): which companies bought back the most stock —
spent=True is cash actually spent, False is the amount authorised.
- "filings" (aliases: filing_events, events, 8-k): companies that filed a form ("8-K",
"SC 13D") or a specific 8-K item code (e.g. "5.02" a leadership change, "2.01" a completed
acquisition).
- "watchlist" (aliases: list): filter a supplied list of entities by a criteria dict (e.g.
insider_buying, congress_buying, catalyst_within_days, rsi_below).
- "cheap_insiders": companies under max_pe where an insider bought on the open market within
the last days (default 90). Joins the valuation and insider stores.
- "insider_before_event": insider open-market purchases that preceded an 8-K by the same
company within days (default 30); item narrows to an 8-K item code.
- "congress_before_upgrades": Senate purchases followed by an analyst upgrade in the same
ticker within days (default 45).
since bounds how old a filing may be; days/max_pe tune the cross-source screens; limit
caps the rows. Read the coverage note returned with the rows: the store fills over time, so a
ranking is over the companies read so far.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| form | No | 8-K | |
| item | No | ||
| kind | No | universe | |
| limit | No | ||
| ratio | No | pe_ratio | |
| since | No | ||
| spent | No | ||
| max_pe | No | ||
| metric | No | ||
| period | No | annual | |
| criteria | No | ||
| entities | No | ||
| max_value | No | ||
| min_value | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |