Screen stocks or funds by any column
br_screenerFilter, sort, and compare stocks, ETFs, and funds by metrics such as P/E, ROE, returns, and NAV to identify candidates matching specific investment criteria.
Instructions
Filter, sort and compare all stocks or all funds on the same data as Agah's screener pages (about 900 stocks, 330 ETFs, 475 funds).
Source: Agah only. Filters stocks or funds on any column; use br_etfs for a plain ETF list with NAV gap and br_fund for one fund.
Use it for "stocks with P/E under 6 and ROE over 30", "best 1-year fixed-income funds", "ETFs with the lowest bubble". Returns are percent; money is Rial; fund Nav is in Rial. Funds also have FundType. Column names are the site's (see list_columns); two return families exist for ETFs: names ending in 2 are NAV returns, the others market-price returns.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | 'stock' all stocks; 'etf' exchange-traded funds with market price; 'mutual' every fund with NAV issue/redeem prices. | |
| sort | No | Column name to sort by (descending unless ascending=true). | |
| limit | No | ||
| columns | No | Column names to return (e.g. ['PToE','Roe'] for stocks, ['Nav','ReturnOf365DaysAgo'] for funds). Omit for a default set; use list_columns=true to see all. | |
| ascending | No | ||
| fund_type | No | Funds only: fixed income, equity, commodity or other. | |
| max_values | No | Keep rows where column <= value, e.g. {'PToE': 6}. | |
| min_values | No | Keep rows where column >= value, e.g. {'Roe': 30}. | |
| list_columns | No | Return the available columns (name, Persian title) instead of rows. | |
| name_contains | No | Keep rows whose name/symbol contains this text (Persian). |