get_search(symbol, rows=100, filters=[], symbolsOnly=False)
Description:
Performs a symbol keyword search and returns a list of matching symbols, optionally filtered by asset class, exchange, or other available search facets. You can choose to return either full symbol metadata or just the symbol names using the symbolsOnly flag.
Function Signature:
get_search(symbol: str, rows: int = 100, filters: Union[str, List[str]] = [],
symbolsOnly: bool = False) -> tuple
Parameters:
| Name | Type | Required | Default | Description |
| symbol | str | Yes | — | Keyword or partial string to search (e.g., 'brn', 'Crude'). |
| rows | int | No | 100 | Maximum number of search results to return. |
| filters | str or List[str] | No | [] | Optional filter code(s) from get_search_filters() (e.g., 'F.EX.7.11'). |
| symbolsOnly | bool | No | False | If True, returns only symbol strings. If False, returns full metadata for each result. |
Return:
Returns a tuple of results:
- symbol strings (if symbolsOnly=True).
- tuples of symbol metadata — (symbol, name, exchange, type) — if symbolsOnly=False.
Notes:
- Filters must use valid filter codes — use get_search_filters() to retrieve them.
- symbol is case-insensitive and supports partial matches.
- Results are limited by the rows parameter (default: 100).
- Use symbolsOnly=True when you only need a list of tradable symbols (faster and cleaner).