Files
OpenBB/website/content/platform/reference/economy/const.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.9 KiB
Vendored

title, description
title description
const OpenBB Platform Function

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

const

Get the constituents of an index.

const(index: Literal[str] = dowjones, provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
index Literal['nasdaq', 'sp500', 'dowjones'] Index for which we want to fetch the constituents. dowjones True
provider Literal['fmp'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True

Returns

OBBject
    results : List[MajorIndicesConstituents]
        Serializable results.

    provider : Optional[Literal['fmp']]
        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
symbol str Symbol to get data for.
name str Name of the constituent company in the index.
sector str Sector the constituent company in the index belongs to.
sub_sector str Sub-sector the constituent company in the index belongs to.
headquarter str Location of the headquarter of the constituent company in the index.
date_first_added Union[date, str, None] Date the constituent company was added to the index.
cik int Central Index Key of the constituent company in the index.
founded Union[date, str] Founding year of the constituent company in the index.