Skip to main content

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​

NameTypeDescriptionDefaultOptional
querystrSearch query.False
use_cacheboolWhether or not to use cache. If True, cache will store for seven days.TrueTrue
providerLiteral['sec']The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.NoneTrue

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