Files
OpenBB/website/content/current/platform/data_models/SymbolMap.md
andrewkenreich 7d095fcfd2 heheheheheheeh
2023-11-14 10:31:48 -05:00

1.3 KiB
Vendored

title, description
title description
Get the ticker symbol corresponding to a company's CIK OpenBB Platform Data Model

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_provider.standard_models. import (
SymbolMapData,
SymbolMapQueryParams,
)

Parameters

Name Type Description Default Optional
query str Search query. 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.