OpenBB/website/content/terminal/reference/portfolio/po/property.md

title, description, keywords

title	description	keywords
property	This documentation defines the usage, parameters, and examples for the 'property' function. This function helps in creating a portfolio that is weighted based on a selected property. It includes risk measure options, nan fill methods, risk-free rates, significance levels, and more to optimize the portfolio. The description helps in understanding the function's implementation for portfolio management.	portfolio optimization property weighting risk measures yfinance data log returns return frequency risk-free rate outliers CVaR EVaR CDaR EDaR nan fill method historic period significance level long allocation

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Returns a portfolio that is weighted based on selected property.

Usage

property -pr PROPERTY [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME]

---

Parameters

Name	Description	Default	Optional	Choices
s_property	Property info to weight. Use one of yfinance info options.	None	False	previousClose, regularMarketOpen, twoHundredDayAverage, trailingAnnualDividendYield, payoutRatio, volume24Hr, regularMarketDayHigh, navPrice, averageDailyVolume10Day, totalAssets, regularMarketPreviousClose, fiftyDayAverage, trailingAnnualDividendRate, open, toCurrency, averageVolume10days, expireDate, yield, algorithm, dividendRate, exDividendDate, beta, circulatingSupply, regularMarketDayLow, priceHint, currency, trailingPE, regularMarketVolume, lastMarket, maxSupply, openInterest, marketCap, volumeAllCurrencies, strikePrice, averageVolume, priceToSalesTrailing12Months, dayLow, ask, ytdReturn, askSize, volume, fiftyTwoWeekHigh, forwardPE, fromCurrency, fiveYearAvgDividendYield, fiftyTwoWeekLow, bid, dividendYield, bidSize, dayHigh, annualHoldingsTurnover, enterpriseToRevenue, beta3Year, profitMargins, enterpriseToEbitda, 52WeekChange, morningStarRiskRating, forwardEps, revenueQuarterlyGrowth, sharesOutstanding, fundInceptionDate, annualReportExpenseRatio, bookValue, sharesShort, sharesPercentSharesOut, heldPercentInstitutions, netIncomeToCommon, trailingEps, lastDividendValue, SandP52WeekChange, priceToBook, heldPercentInsiders, shortRatio, sharesShortPreviousMonthDate, floatShares, enterpriseValue, fundFamily, threeYearAverageReturn, lastSplitFactor, legalType, lastDividendDate, morningStarOverallRating, earningsQuarterlyGrowth, pegRatio, lastCapGain, shortPercentOfFloat, sharesShortPriorMonth, impliedSharesOutstanding, fiveYearAverageReturn, regularMarketPrice
risk_measure	Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns	MV	True	MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD
nan_fill_method	Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points	time	True	linear, time, nearest, zero, slinear, quadratic, cubic, barycentric
historic_period	Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset	3y	True	1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max
start_period	Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format		True	None
end_period	End date to get yfinance data from. Must be in 'YYYY-MM-DD' format		True	None
log_returns	If use logarithmic or arithmetic returns to calculate returns	False	True	None
return_frequency	Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns	d	True	d, w, m
max_nan	Max percentage of nan values accepted per asset to be considered in the optimization process	0.05	True	None
threshold_value	Value used to replace outliers that are higher to threshold in absolute value	0.3	True	None
risk_free	Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual	0.02924	True	None
significance_level	Significance level of CVaR, EVaR, CDaR and EDaR	0.05	True	None
long_allocation	Amount to allocate to portfolio	1	True	None
name	Save portfolio with personalized or default name	PROPERTY_0	True	None

---

Examples

2022 Apr 05, 15:02 (🦋) /portfolio/po/ $ property -pr trailingEps

 [3 Years] Weighted Portfolio based on trailingEps

     Weights
┏━━━━━━┳━━━━━━━━━┓
┃      ┃ Value   ┃
┡━━━━━━╇━━━━━━━━━┩
│ AAPL │  6.36 % │
├──────┼─────────┤
│ AMZN │ 68.58 % │
├──────┼─────────┤
│ BA   │ -7.56 % │
├──────┼─────────┤
│ FB   │ 14.57 % │
├──────┼─────────┤
│ MSFT │  9.93 % │
├──────┼─────────┤
│ T    │  2.92 % │
├──────┼─────────┤
│ TSLA │  5.18 % │
└──────┴─────────┘

Annual (by 252) expected return: 33.74%
Annual (by √252) volatility: 30.25%
Sharpe ratio: 1.1094

---