screen_stocks
Screen stocks by financial growth, sector, sub-industry, market cap, analyst ratings, institutional ownership, country, and price performance.
Discover valid filter values with the list tools named in each parameter's
description before guessing.
Rate-limited to 10/hour
per user server-side.
Asynchronous: returns a task id. Poll it with `get_task_status` until SUCCESS.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metrics | No | Financial-growth criteria: metric name -> threshold (number) or required flag (bool), e.g. {"revenue_growth": 0.1, "positive_eps": true}. Interpreted by the screener, not enum-validated. | |
| sectors | No | Sector values from list_options("sectors"). | |
| countries | No | Country values from list_options("countries"). | |
| market_cap | No | Market-cap buckets from list_options("market_cap"), e.g. "Small-cap", "Large-cap". | |
| sub_sectors | No | Sub-industry values from list_sub_industries([...]). | |
| analyst_ratings | No | Analyst consensus ratings to keep, e.g. ["Buy", "Strong Buy"]. | |
| price_performance | No | Price-return criteria: window -> minimum return, e.g. {"ytd": 0.1}. | |
| institutional_ownership | No | Investor category -> minimum ownership, keyed by list_options("institutional_investor_types") values, e.g. {"Hedge Fund": 5}. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | PENDING on submission. | |
| task_id | Yes | Poll with get_task_status until SUCCESS. |