Skip to main content

gaintopain

Get Pain-to-Gain ratio based on historical data

Source Code: [link]

openbb.portfolio.metric.gaintopain(portfolio_engine: portfolio_engine.PortfolioEngine)

Parameters

NameTypeDescriptionDefaultOptional
portfolio_enginePortfolioEnginePortfolioEngine class instance, this will hold transactions and perform calculations.
Use portfolio.load to create a PortfolioEngine.
NoneFalse

Returns

TypeDescription
pd.DataFrameDataFrame of the portfolio's gain-to-pain ratio

Examples

from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx")
output = openbb.portfolio.metric.gaintopain(p)