Screen stocks
screen_stocksScreen the global Bullrun stock universe with the app rule engine using custom fundamental rules or named presets: profitable value, dividend income, growth and cash flow, cash generators, dividend growth. action=list_presets discloses exact thresholds, units, annual lookback and sorting without any backend request. action=run (default) executes one preset or custom rules; running uses the API's metered screening budget. Custom screens support sector/industry/country, listing controls, annual/quarterly lookback, AND/OR rule groups and money units. Presets are mechanical starting points, not recommendations or famous-investor strategies. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Deprecated alias for lookbackMode; kept for compatibility. | |
| limit | No | Maximum stocks to return: custom default 25 (1-100), preset default 20 (1-50). | |
| order | No | Sort direction. Custom default desc; presets use their disclosed order. Nulls always sort last regardless of direction. | |
| rules | No | Fundamental rules. Same groupId means AND; different groupIds mean OR. | |
| action | No | list_presets discloses named screens without any backend request; run executes a preset or custom rules and uses the metered screening budget. | run |
| preset | No | Optional named screen. Presets use disclosed fixed rules/sorting, annual lookback (2-10 years), primary active listings and a default limit of 20 (maximum 50). Omit for custom rules; do not combine with rules or minMarketCap. | |
| sector | No | Exact sector name to filter by, e.g. "Technology", "Healthcare". Omit for all sectors. | |
| sortBy | No | Metric to sort by. Custom default marketCap; presets use their disclosed sorting. revenueGrowth is accepted as an alias for revenueGrowthPct. | |
| country | No | Exact country name to filter by, e.g. "United States", "Germany". Omit for all countries. | |
| periods | No | Deprecated alias for lookback; kept for compatibility. | |
| industry | No | Exact industry name to filter by, e.g. "Software - Infrastructure". Omit for all industries. | |
| lookback | No | How many reporting periods to evaluate (default 3). Growth rules need at least 2 comparable periods; presets require 2-10 annual observations. | |
| countries | No | Exact country names to include. Use this for multi-country screens; it overrides country when provided. | |
| lookbackMode | No | Whether rule evaluation uses annual or quarterly reporting periods. Default annual; presets require annual. | |
| minMarketCap | No | Compatibility shortcut: adds marketCap >= this absolute value to every rule group. | |
| includeInactive | No | Include delisted/inactive tickers with no recent price bar. Default false. | |
| includeSecondary | No | Include secondary cross-listings of the same security. Default false (primary listings only). |