mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
1.5 KiB
Vendored
1.5 KiB
Vendored
title, description
| title | description |
|---|---|
| ExecutiveCompensation | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
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 |
|---|---|---|
| symbol | str | Symbol to get data for. |
| cik | str | Central Index Key (CIK) of the company. |
| filing_date | date | Date of the filing. |
| accepted_date | datetime | Date the filing was accepted. |
| name_and_position | str | Name and position of the executive. |
| year | int | Year of the compensation. |
| salary | PositiveFloat | Salary of the executive. |
| bonus | NonNegativeFloat | Bonus of the executive. |
| stock_award | NonNegativeFloat | Stock award of the executive. |
| incentive_plan_compensation | NonNegativeFloat | Incentive plan compensation of the executive. |
| all_other_compensation | NonNegativeFloat | All other compensation of the executive. |
| total | PositiveFloat | Total compensation of the executive. |
| url | str | URL of the filing data. |