symbol_map
Get the ticker symbol corresponding to a company's CIK.
Example
from openbb import obb
obb.regulators.sec.symbol_map(use_cache=True)
Parameters
- Standard
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | True | |
| 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 for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | "sec" | 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 |
|---|---|---|
| provider | Literal['openbb'] | The data provider for the data. |
| symbol | str | Symbol representing the entity requested in the data. |