Institutions Search
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
InstitutionsSearch | InstitutionsSearchQueryParams | InstitutionsSearchData |
Import Statement
from openbb_core.provider.standard_models. import (
InstitutionsSearchData,
InstitutionsSearchQueryParams,
)
Parameters
- standard
- sec
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Search query. | True | |
use_cache | bool | Whether or not to use cache. | True | True |
provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Search query. | True | |
use_cache | bool | Whether or not to use cache. | True | True |
provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True |
Data
- standard
- sec
Name | Type | Description |
---|
Name | Type | Description |
---|---|---|
name | str | The name of the institution. |
cik | Union[int, str] | Central Index Key (CIK) |