Function
Ret%Chg(bars [,offset,series])
Factors
Ret1W%Chg - 1 week (bars set to 5)
Ret4W%Chg - 4 weeks (bars set to 20)
Ret3M%Chg - 3 months (bars set to 62)
Ret6M%Chg - 6 months (bars set to 125)
Ret1Y%Chg - 1 year (bars set to 251)
Ret2Y%Chg - 2 years (bars set to 501)
These function/factors return the total return (dividends included) during the period specified as a percent.
Parameters
bar: the lookback period in bars or trading days
offset: offset in bars from the as-of date
series: specify alternate time series (see below)
By default, technical functions access the time series of the instrument in context. You can specify a different time-series in several ways like: using GetSeries(), specifying a StockID directly, or using a time series id. See the examples below.
Examples
Get the latest close price using Close(0, series) using different methods for different time series.
| Using the ID directly | |
| Using the StockID for SPY:USA* | Close(0, 24262) |
| For the Industry series of the stock being evaluated | Close(0,#Industry) |
| Using a Time Series Id | Close(0,$RUI) |
| For the benchmark | Close(0, #Bench) |
| Using GetSeries | |
| Using a fully qualified ticker | Close(0, GetSeries("SPY:USA")) |
| When USA is your default | Close(0, GetSeries("SPY")) |
| See GetSeries() for more examples like for aggregate series | |
| * StockIDs never change | |
Predefined Series IDs
These are special series ids. Additional Series Ids can be found in the reference under: MISC→TIME SERIES IDs
| Id | Description | Freq | OHLC |
| Industry and Sector | |||
| #Sector | Stock's Sector | Daily | C |
| #SubSector | Stock's SubSector | Daily | C |
| #Industry | Stock's Industry | Daily | C |
| #SubIndustry | Stock's SubIndustry | Daily | C |
| Miscellaneous | |||
| #Bench | Benchmark closing prices | Daily | C |
| #TNX | 10Y Treasury Note | Daily | OHLC |
| FED Model series (chart) | |||
| #SPRP | SP500 Risk Premium | Weekly | C |
| #SPEPSCY | SP500 EPS CurrentY | Weekly | C |
| #SPEPSNY | SP500 EPS NextY | Weekly | C |
| #SPEPSCNY | SP500 EPS Blend Y | Weekly | C |
| #SPEPSQ | SP500 EPS Blend Q | Weekly | C |
| #SPEPSTTM | SP500 EPS Trailing 12 months | Weekly | C |
| #SPYield | SP500 Yield | Weekly | C |
Special Series Ids for Moving Averages & Highest/Lowest functions
| Id | Description | Context |
| #Open | Open prices | Stock & ETF |
| #High | High prices | Stock & ETF |
| #Low | Low prices | Stock & ETF |
| #Vol | Volumes | Stock & ETF |