mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 23:12:21 +00:00
* pydantic v4
* flat structure
* md files
* Revert "md files"
This reverts commit bd2170e2ad.
* improve command descriptions
* nice title and description
* human readble data model names on left panel
* implementation details section
* content markdown files
* markdown versioned files
* showcase page
* updates
---------
Co-authored-by: tehcoderer <me@tehcoderer.com>
1.4 KiB
Vendored
1.4 KiB
Vendored
title, description
| title | description |
|---|---|
| Key Executives | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
KeyExecutives |
KeyExecutivesQueryParams |
KeyExecutivesData |
Import Statement
from openbb_provider.standard_models.key_executives import (
KeyExecutivesData,
KeyExecutivesQueryParams,
)
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 |
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 | int | Birth year of the key executive. |
| title_since | int | Date the tile was held since. |