Sec Equity Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
SecEquitySearch | SecEquitySearchQueryParams | SecEquitySearchData |
Import Statement
from openbb_core.provider.standard_models. import (
SecEquitySearchData,
SecEquitySearchQueryParams,
)
Parameters
- standard
- sec
query: str | None
Search query.
is_symbol: bool | None
Default: False
Whether to search by ticker symbol.
query: str | None
Search query.
is_symbol: bool | None
Default: False
Whether to search by ticker symbol.
use_cache: bool | None
Default: True
Whether to use the cache or not.
is_fund: bool | None
Default: False
Whether to direct the search to the list of mutual funds and ETFs.
Data
- standard
- sec
symbol: str | None
Symbol representing the entity requested in the data.
name: str | None
Name of the company.
symbol: str | None
Symbol representing the entity requested in the data.
name: str | None
Name of the company.
cik: str
Central Index Key