jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9cedbb2e77b633a43578c69b4e89bfa5c5f7cb
OpenBB/website/content/platform/data_models/ExecutiveCompensation.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774) 
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

1.9 KiB
Vendored
Raw Blame History

title, description
title description
Get Executive Compensation OpenBB Platform Data Model

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

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

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 representing the entity requested in the data.
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 float Salary of the executive.
bonus float Bonus of the executive.
stock_award float Stock award of the executive.
incentive_plan_compensation float Incentive plan compensation of the executive.
all_other_compensation float All other compensation of the executive.
total float Total compensation of the executive.
url str URL of the filing data.