Files
OpenBB/website/content/platform/data_models/CashFlowStatementGrowth.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

4.0 KiB
Vendored

title, description
title description
Cash Flow Statement Growth OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
CashFlowStatementGrowth CashFlowStatementGrowthQueryParams CashFlowStatementGrowthData

Import Statement

from openbb_core.provider.standard_models.cash_flow_growth import (
CashFlowStatementGrowthData,
CashFlowStatementGrowthQueryParams,
)

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
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.
date date The date of the data.
period str Period the statement is returned for.
growth_net_income float Growth rate of net income.
growth_depreciation_and_amortization float Growth rate of depreciation and amortization.
growth_deferred_income_tax float Growth rate of deferred income tax.
growth_stock_based_compensation float Growth rate of stock-based compensation.
growth_change_in_working_capital float Growth rate of change in working capital.
growth_accounts_receivables float Growth rate of accounts receivables.
growth_inventory float Growth rate of inventory.
growth_accounts_payables float Growth rate of accounts payables.
growth_other_working_capital float Growth rate of other working capital.
growth_other_non_cash_items float Growth rate of other non-cash items.
growth_net_cash_provided_by_operating_activities float Growth rate of net cash provided by operating activities.
growth_investments_in_property_plant_and_equipment float Growth rate of investments in property, plant, and equipment.
growth_acquisitions_net float Growth rate of net acquisitions.
growth_purchases_of_investments float Growth rate of purchases of investments.
growth_sales_maturities_of_investments float Growth rate of sales maturities of investments.
growth_other_investing_activities float Growth rate of other investing activities.
growth_net_cash_used_for_investing_activities float Growth rate of net cash used for investing activities.
growth_debt_repayment float Growth rate of debt repayment.
growth_common_stock_issued float Growth rate of common stock issued.
growth_common_stock_repurchased float Growth rate of common stock repurchased.
growth_dividends_paid float Growth rate of dividends paid.
growth_other_financing_activities float Growth rate of other financing activities.
growth_net_cash_used_provided_by_financing_activities float Growth rate of net cash used/provided by financing activities.
growth_effect_of_forex_changes_on_cash float Growth rate of the effect of foreign exchange changes on cash.
growth_net_change_in_cash float Growth rate of net change in cash.
growth_cash_at_end_of_period float Growth rate of cash at the end of the period.
growth_cash_at_beginning_of_period float Growth rate of cash at the beginning of the period.
growth_operating_cash_flow float Growth rate of operating cash flow.
growth_capital_expenditure float Growth rate of capital expenditure.
growth_free_cash_flow float Growth rate of free cash flow.