Executive Compensation
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ExecutiveCompensation | ExecutiveCompensationQueryParams | ExecutiveCompensationData |
Import Statement
from openbb_core.provider.standard_models.executive_compensation import (
ExecutiveCompensationData,
ExecutiveCompensationQueryParams,
)
Parameters
- standard
- fmp
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): fmp.
• Optional: False
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): fmp.
• Optional: False
year: int
Year of the compensation.
• Optional: True
Data
- standard
- fmp
symbol: str
Symbol representing the entity requested in the data.
cik: str
Central Index Key (CIK) for the requested entity.
company_name: str
The name of the company.
industry: str
The industry of the company.
year: int
Year of the compensation.
name_and_position: str
Name and position.
salary: Annotated[float, Ge(ge=0)]
Salary.
bonus: Annotated[float, Ge(ge=0)]
Bonus payments.
stock_award: Annotated[float, Ge(ge=0)]
Stock awards.
incentive_plan_compensation: Annotated[float, Ge(ge=0)]
Incentive plan compensation.
all_other_compensation: Annotated[float, Ge(ge=0)]
All other compensation.
total: Annotated[float, Ge(ge=0)]
Total compensation.
symbol: str
Symbol representing the entity requested in the data.
cik: str
Central Index Key (CIK) for the requested entity.
company_name: str
The name of the company.
industry: str
The industry of the company.
year: int
Year of the compensation.
name_and_position: str
Name and position.
salary: Annotated[float, Ge(ge=0)]
Salary.
bonus: Annotated[float, Ge(ge=0)]
Bonus payments.
stock_award: Annotated[float, Ge(ge=0)]
Stock awards.
incentive_plan_compensation: Annotated[float, Ge(ge=0)]
Incentive plan compensation.
all_other_compensation: Annotated[float, Ge(ge=0)]
All other compensation.
total: Annotated[float, Ge(ge=0)]
Total compensation.
filing_date: date
Date of the filing.
accepted_date: datetime
Date the filing was accepted.
url: str
URL to the filing data.