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

1.8 KiB
Vendored

title, description, keywords
title description keywords
cik_map Learn how to retrieve the CIK number corresponding to a ticker symbol using the python obb.regulators.sec.cik_map function. Understand the available parameters, return values, and data structure.
CIK number
ticker symbol
python obb.regulators.sec.cik_map function
get data for symbol
provider parameter
returns
results
warnings
chart object
metadata info
data
central index key

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

Get the CIK number corresponding to a ticker symbol.

obb.regulators.sec.cik_map(symbol: Union[str, List[str]], provider: Literal[str] = sec)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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[CikMap]
        Serializable results.

    provider : Optional[Literal['sec']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

Data

Name Type Description
Name Type Description
cik Union[str, int] Central Index Key