yfinance_screen
Screen stocks or funds using predefined Yahoo Finance screener keys or custom query trees. Retrieve filtered results with sorting and pagination.
Instructions
Run a Yahoo Finance screener query.
Supports predefined Yahoo screener keys and custom equity or fund query trees.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Screener query. For query_type='predefined': string key like 'day_gainers'. For query_type='equity' or 'fund': query tree object with {operator, operands} nodes. | |
| query_type | No | Query mode: 'predefined', 'equity', or 'fund'. | predefined |
| offset | No | Result offset. | |
| size | No | Rows to return for custom queries. Yahoo maximum is 250. | |
| count | No | Rows to return for predefined queries. Yahoo maximum is 250. | |
| sort_field | No | Sort field, for example 'percentchange'. | |
| sort_asc | No | Sort ascending if true, descending if false. | |
| user_id | No | Optional Yahoo user id. | |
| user_id_type | No | Optional Yahoo user id type, commonly 'guid'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |