cik_map
Map a ticker symbol to a CIK number.
Examples
from openbb import obb
obb.regulators.sec.cik_map(symbol='MSFT', provider='sec')
Parameters
- standard
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['sec'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['sec'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. | None | True |
| use_cache | bool | Whether or not to use cache for the request, default is True. | True | True |
Returns
OBBject
results : List[CikMap]
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 |
|---|---|---|
| cik | Union[str, int] | Central Index Key (CIK) for the requested entity. |
| Name | Type | Description |
|---|---|---|
| cik | Union[str, int] | Central Index Key (CIK) for the requested entity. |