symbol_map
Map a CIK number to a ticker symbol, leading 0s can be omitted or included.
Examples
from openbb import obb
obb.regulators.sec.symbol_map(query='0000789019', provider='sec')
Parameters
- standard
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | False | |
| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True |
| 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 |
|---|---|---|---|---|
| query | str | Search query. | False | |
| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True |
| 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 |
Returns
OBBject
results : List[SymbolMap]
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 |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |