stock_screener
Screen stocks by common or preferred share type across global markets. Get market-cap ranked results with price, dividend yield, and more.
Instructions
Screen stocks by share type — the API twin of TradingView's "Common stock" / "Preferred stock" symbol-search filter.
Args: country: TradingView market name — e.g. america, korea, germany, brazil, japan, uk, india, turkey, canada, australia, france, hongkong stock_type: common | preferred limit: rows to return (max 2000, single upstream request), ranked by market cap descending exclude_otc: default True — drop OTC listings (foreign companies traded over-the-counter); "america" otherwise means "US venue", not "US company" compact: default False — True returns only ticker/symbol/price/currency/ change_percent per row (light payload for bulk price feeds)
Returns: Envelope dict: total_matches (market-wide count), returned, and rows of {ticker, symbol, description, exchange, price, currency, change_percent, dividend_yield, market_cap}. Prices are in the market's local currency (e.g. KRW for korea).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| compact | No | ||
| country | No | america | |
| stock_type | No | common | |
| exclude_otc | No |