OpenBB/website/content/platform/data_models/SymbolMap.md

title, description

title	description
Symbol Map	Map a CIK number to a ticker symbol, leading 0s can be omitted or included

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

---

Implementation details

Class names

Model name	Parameters class	Data class
SymbolMap	SymbolMapQueryParams	SymbolMapData

Import Statement

from openbb_core.provider.standard_models. import (
SymbolMapData,
SymbolMapQueryParams,
)

---

Parameters

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 for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.	sec	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 for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.	sec	True

---

Data

Name	Type	Description

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.