Files
OpenBB/website/content/platform/reference/fundamental/income_growth.md
James Maslek dce447b423 install v4 (#5766)
* install v4

* add run on pr

* this seems sus

* thnx juan

* flip

* thnx juan

* idk

* Update index.js

* Update Root.tsx

* Update index.js

* try again

* fix front matter

* fix description front matter

* Revert "fix description front matter"

This reverts commit cccc7b2469.

* try to fix this mickey

* fixed all that mickey @DidierRLopes broke

* Update index.js

* generate platform fix

* black fix

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-11-21 06:38:50 +00:00

4.9 KiB
Vendored

title, description, keywords
title description keywords
income_growth Explore the growth of a company's income statement with the Python function obb.equity.fundamental.income_growth. Retrieve data for symbols, specify the limit, period, and provider, and get detailed information on various aspects of the income statement growth.
income statement growth
company income statement
python obb.equity.fundamental.income_growth
symbol
limit
period
provider
data entries
time period
provider name
warnings
chart object
metadata
symbol data
date
growth revenue
cost of goods sold
gross profit
gross profit ratio
research and development expenses
general and administrative expenses
selling and marketing expenses
operating expenses
total costs and expenses
interest expenses
depreciation and amortization expenses
ebitda
ebitda ratio
operating income
operating income ratio
total other income expenses net
income before tax
income tax expenses
net income
eps
eps diluted
weighted average shares outstanding

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

Income Statement Growth. Information about the growth of the company income statement.

obb.equity.fundamental.income_growth(symbol: Union[str, List[str]], limit: int = 10, period: Literal[str] = annual, provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
limit int The number of data entries to return. 10 True
period Literal['annual', 'quarter'] Time period of the data to return. annual True
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[IncomeStatementGrowth]
        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
symbol str Symbol representing the entity requested in the data.
date date The date of the data.
period str Period the statement is returned for.
growth_revenue float Growth rate of total revenue.
growth_cost_of_revenue float Growth rate of cost of goods sold.
growth_gross_profit float Growth rate of gross profit.
growth_gross_profit_ratio float Growth rate of gross profit as a percentage of revenue.
growth_research_and_development_expenses float Growth rate of expenses on research and development.
growth_general_and_administrative_expenses float Growth rate of general and administrative expenses.
growth_selling_and_marketing_expenses float Growth rate of expenses on selling and marketing activities.
growth_other_expenses float Growth rate of other operating expenses.
growth_operating_expenses float Growth rate of total operating expenses.
growth_cost_and_expenses float Growth rate of total costs and expenses.
growth_interest_expense float Growth rate of interest expenses.
growth_depreciation_and_amortization float Growth rate of depreciation and amortization expenses.
growth_ebitda float Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.
growth_ebitda_ratio float Growth rate of EBITDA as a percentage of revenue.
growth_operating_income float Growth rate of operating income.
growth_operating_income_ratio float Growth rate of operating income as a percentage of revenue.
growth_total_other_income_expenses_net float Growth rate of net total other income and expenses.
growth_income_before_tax float Growth rate of income before taxes.
growth_income_before_tax_ratio float Growth rate of income before taxes as a percentage of revenue.
growth_income_tax_expense float Growth rate of income tax expenses.
growth_net_income float Growth rate of net income.
growth_net_income_ratio float Growth rate of net income as a percentage of revenue.
growth_eps float Growth rate of Earnings Per Share (EPS).
growth_eps_diluted float Growth rate of diluted Earnings Per Share (EPS).
growth_weighted_average_shs_out float Growth rate of weighted average shares outstanding.
growth_weighted_average_shs_out_dil float Growth rate of diluted weighted average shares outstanding.