Skip to main content

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​

NameTypeDescriptionDefaultOptional
querystrSearch query.True
use_cacheboolWhether or not to use cache. If True, cache will store for seven days.TrueTrue
providerLiteral['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​

NameTypeDescription