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 |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Search query. | True | |
use_cache | bool | Whether or not to use cache. | True | True |
Data
- standard
- sec
Name | Type | Description |
---|---|---|
; |
Name | Type | Description |
---|---|---|
name | str | The name of the institution. |
cik | Union[str, int] | Central Index Key (CIK) |