Equity Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EquitySearch | EquitySearchQueryParams | EquitySearchData |
Import Statement
from openbb_core.provider.standard_models.equity_search import (
EquitySearchData,
EquitySearchQueryParams,
)
Parameters
- standard
- intrinio
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | True | |
| is_symbol | bool | Whether to search by ticker symbol. | False | True |
| use_cache | bool | Whether to use the cache or not. | True | True |
| provider | Literal['intrinio', 'sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | True | |
| is_symbol | bool | Whether to search by ticker symbol. | False | True |
| use_cache | bool | Whether to use the cache or not. | True | True |
| provider | Literal['intrinio', 'sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True |
| active | bool | When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. | True | True |
| limit | int | The number of data entries to return. | 10000 | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | True | |
| is_symbol | bool | Whether to search by ticker symbol. | False | True |
| use_cache | bool | Whether to use the cache or not. | True | True |
| provider | Literal['intrinio', 'sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True |
| is_fund | bool | Whether to direct the search to the list of mutual funds and ETFs. | False | True |
Data
- standard
- intrinio
- sec
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| name | str | Name of the company. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| name | str | Name of the company. |
| cik | str | |
| lei | str | The Legal Entity Identifier (LEI) of the company. |
| intrinio_id | str | The Intrinio ID of the company. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| name | str | Name of the company. |
| cik | str | Central Index Key |