Cik Map
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CikMap | CikMapQueryParams | CikMapData |
Import Statement
from openbb_core.provider.standard_models.cik_map import (
CikMapData,
CikMapQueryParams,
)
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 |
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. |