Stock screener
screenFilter stocks by criteria such as dividend yield, P/E ratio, market cap, region, sector, or exchange to find investment opportunities.
Instructions
Find stocks by criteria, e.g. dividend payers in a region or cheap large caps.
Fields are these aliases, or a raw Yahoo screener field name:
market: market_cap, price, change_percent, change_52w_percent, volume, avg_volume_3m, beta
valuation: pe_ratio, peg_ratio, price_to_book, price_to_sales, ev_to_ebitda
dividend: dividend_yield, forward_dividend_yield, dividend_growth_years
profitability and growth: return_on_equity, return_on_assets, net_margin, revenue, revenue_growth, eps_growth
balance sheet: debt_to_equity, current_ratio
ownership: insider_percent, institutional_percent, short_percent_of_float
esg_score
categories, eq or is-in only: region (country code, 'us', 'de'), exchange (Yahoo code, 'NMS', 'GER'), sector ('Technology'), industry (a key or name from get_sector)
Percentages are in percent, 3 means 3 %. A loss makes pe_ratio negative, so pair lt with gt 0. region is where a stock is listed, not where the company sits, so 'de' includes foreign companies traded in Germany, and a company appears once per listing. Preferred shares are listings too (on US exchanges symbols like JPM-PD), carrying the common stock's eps and market cap, so their pe_ratio means nothing. Returns total (all matches) and one row per match with price, valuation and dividend figures. A row's dividend_yield can be missing or differ markedly from the filter, which holds for Yahoo's screener data, not for that column. The other filters' figures are not in the rows: get_company_info adds beta and forward P/E, get_holders the ownership shares, get_financials the statements behind margins, growth and debt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of matches to return. | |
| offset | No | Matches to skip, for the next page. | |
| filters | Yes | Conditions that must all hold, e.g. [{"field": "dividend_yield", "op": "gt", "value": 3}]. | |
| sort_by | No | A numeric field or alias to sort by. | market_cap |
| sort_desc | No | Largest first. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||