screen_companies
Screen companies by financial metrics or business data. Use filters like ROE > 15, presets such as 'Cash Flow Machines', or queries on revenue, market share, and more.
Instructions
Screen companies by financial metrics and/or business data. Pass 'preset' (a popular screen name from list_popular_screens, e.g. 'Cash Flow Machines'), OR 'filters' and/or 'alternate'. 'filters' accepts a query string like '( ROE > 15 ) and ( Market Capitalization > 500 )' or a shorthand object like {roe:{min:15}, debt_to_equity:{max:0.5}}. Query strings support any field name from search_screener_fields, % values ('ROCE > 20%'), field-vs-field comparisons ('Net Sales > 3Yrs ago Net Sales'), and arithmetic ('capex/Net Block > 0.5'). 'alternate' is a business-data query using relationships: 'makes ', 'revenue from <product/region> > N', 'market share > N', 'uses ', 'caters to ', 'has plant in ' — combinable with AND/OR/NOT, e.g. 'market share > 50' or 'revenue from Defence > 50'. Product/region names come from search_screener_fields with type Products/Regions. Optional flags: latest_results_only (only companies that reported the latest quarter), superstar_investors (only companies a superstar/whale investor holds — adds a 'whales' column), sme (search the SME-listed universe instead of mainboard). 'limit' caps returned rows (default 50) and 'offset' pages through the rest (e.g. offset: 50 for rows 51-100 — served from cache, no refetch); total_results always reports the full match count.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sme | No | ||
| limit | No | ||
| offset | No | ||
| preset | No | ||
| filters | No | ||
| alternate | No | ||
| latest_results_only | No | ||
| superstar_investors | No |