Files
OpenBB/website/content/platform/reference/fa/mgmt.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.5 KiB
Vendored

title, description
title description
mgmt OpenBB Platform Function

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

mgmt

Key Executives.

mgmt(symbol: Union[str, List[str]], provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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[KeyExecutives]
        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
title str Designation of the key executive.
name str Name of the key executive.
pay int Pay of the key executive.
currency_pay str Currency of the pay.
gender str Gender of the key executive.
year_born str Birth year of the key executive.
title_since int Date the tile was held since.