institutions_search
Search SEC-regulated institutions by name and return a list of results with CIK numbers.
Examples
from openbb import obb
obb.regulators.sec.institutions_search(provider='sec')
obb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')
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 |
Returns
OBBject
results : List[InstitutionsSearch]
Serializable results.
provider : Optional[Literal['sec']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- sec
Name | Type | Description |
---|---|---|
; |
Name | Type | Description |
---|---|---|
name | str | The name of the institution. |
cik | Union[str, int] | Central Index Key (CIK) |