Reference
Indicators (ta)
Moving averages, oscillators, volatility and pattern helpers. Each call keeps its own running memory, so call them on every bar.
ta.accdist
Accumulation/distribution.
Returns: a number
ta.alma(source, length, offset=0.85, sigma=6)
Arnaud Legoux moving average. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
offset | float | Default 0.85 |
sigma | float | Default 6 |
ta.atr(length)
Average true range (RMA of the true range). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
length | int |
ta.barssince(condition)
Bars since condition was last true (na if never). Call on every bar: it keeps its own running memory.
Returns: a whole number
| Parameter | Type |
|---|---|
condition | bool |
ta.bb(source, length, mult)
Bollinger Bands: middle, upper, lower. Call on every bar: it keeps its own running memory.
Returns: several values: [float,float,float]
| Parameter | Type |
|---|---|
source | num |
length | int |
mult | float |
ta.bbw(source, length, mult)
Bollinger Band width as a percent of the middle band. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
mult | float |
ta.cci(source, length)
Commodity channel index. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.change(source, length=1)
source minus its value length bars ago (for bool: true if it changed). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | any | |
length | int | Default 1 |
ta.cmo(source, length)
Chande momentum oscillator. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.correlation(source1, source2, length)
Correlation coefficient, -1 to 1. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source1 | num |
source2 | num |
length | int |
ta.cross(a, b)
True on the bar where a and b cross either way. Call on every bar: it keeps its own running memory.
Returns: true or false
| Parameter | Type |
|---|---|
a | num |
b | num |
ta.crossover(a, b)
True on the bar where a crosses above b. Call on every bar: it keeps its own running memory.
Returns: true or false
| Parameter | Type |
|---|---|
a | num |
b | num |
ta.crossunder(a, b)
True on the bar where a crosses below b. Call on every bar: it keeps its own running memory.
Returns: true or false
| Parameter | Type |
|---|---|
a | num |
b | num |
ta.cum(source)
Running total of source since the first bar. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
ta.dev(source, length)
Mean absolute deviation from the SMA. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.dmi(diLength, adxSmoothing)
Directional movement: +DI, -DI and ADX. Call on every bar: it keeps its own running memory.
Returns: several values: [float,float,float]
| Parameter | Type |
|---|---|
diLength | int |
adxSmoothing | int |
ta.ema(source, length)
Exponential moving average (alpha 2/(length+1), starts from an SMA). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.falling(source, length)
True if source fell on each of the last length bars. Call on every bar: it keeps its own running memory.
Returns: true or false
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.highest(source=high, length)
Highest value of the last length bars. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default high |
length | int |
ta.highestbars(source=high, length)
Offset (0 or negative) to the highest bar of the last length bars. Call on every bar: it keeps its own running memory.
Returns: a whole number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default high |
length | int |
ta.hma(source, length)
Hull moving average. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.kc(source, length, mult, useTrueRange=true)
Keltner Channels: middle (EMA), upper, lower. Call on every bar: it keeps its own running memory.
Returns: several values: [float,float,float]
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
mult | float | |
useTrueRange | bool | Default true |
ta.kcw(source, length, mult, useTrueRange=true)
Keltner Channel width. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
mult | float | |
useTrueRange | bool | Default true |
ta.linreg(source, length, offset=0)
Linear regression value (least squares line) at offset bars back. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
offset | int | Default 0 |
ta.lowest(source=low, length)
Lowest value of the last length bars. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default low |
length | int |
ta.lowestbars(source=low, length)
Offset (0 or negative) to the lowest bar of the last length bars. Call on every bar: it keeps its own running memory.
Returns: a whole number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default low |
length | int |
ta.macd(source, fastlen=12, slowlen=26, siglen=9)
MACD line, signal line and histogram. Call on every bar: it keeps its own running memory.
Returns: several values: [float,float,float]
| Parameter | Type | Notes |
|---|---|---|
source | num | |
fastlen | int | Default 12 |
slowlen | int | Default 26 |
siglen | int | Default 9 |
ta.median(source, length)
Median of the last length values. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.mfi(source, length)
Money flow index, 0 to 100. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.mode(source, length)
Most frequent value of the last length values. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.mom(source, length)
Momentum: source minus source length bars ago. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.obv
On-balance volume.
Returns: a number
ta.percentrank(source, length)
Percent of the previous length values that are at or below the current one. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.pivothigh(source=high, leftbars, rightbars)
Pivot high price, known rightbars bars after the pivot (na otherwise). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default high |
leftbars | int | |
rightbars | int |
ta.pivotlow(source=low, leftbars, rightbars)
Pivot low price, known rightbars bars after the pivot (na otherwise). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default low |
leftbars | int | |
rightbars | int |
ta.range(source, length)
Highest minus lowest of the last length values. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.rising(source, length)
True if source rose on each of the last length bars. Call on every bar: it keeps its own running memory.
Returns: true or false
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.rma(source, length)
Wilder's moving average (alpha 1/length, starts from an SMA). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.roc(source, length)
Rate of change in percent. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.rsi(source, length)
Relative strength index, 0 to 100. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.sar(start, inc, max)
Parabolic SAR. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
start | float |
inc | float |
max | float |
ta.sma(source, length)
Simple moving average of the last length values. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.stdev(source, length, biased=true)
Standard deviation. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
biased | bool | Default true |
ta.stoch(source, high, low, length)
Stochastic: where source sits in the high-low range of length bars, 0 to 100. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
high | num |
low | num |
length | int |
ta.supertrend(factor, atrPeriod)
SuperTrend line and direction (-1 up trend, 1 down trend). Call on every bar: it keeps its own running memory.
Returns: several values: [float,int]
| Parameter | Type |
|---|---|
factor | float |
atrPeriod | int |
ta.swma(source)
Symmetric 4-bar weighted moving average. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
ta.tr(handle_na=false)
True range of this bar. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
handle_na | bool | Default false |
ta.tr
True range of this bar (na on the first bar).
Returns: a number
ta.tsi(source, short_length, long_length)
True strength index, -1 to 1. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
short_length | int |
long_length | int |
ta.valuewhen(condition, source, occurrence=0)
Value of source on the bar where condition was true (occurrence 0 = most recent). Call on every bar: it keeps its own running memory.
Returns: arg1
| Parameter | Type | Notes |
|---|---|---|
condition | bool | |
source | any | |
occurrence | int | Default 0 |
ta.variance(source, length, biased=true)
Variance. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | |
length | int | |
biased | bool | Default true |
ta.vwap(source=hlc3, anchor="D")
Volume-weighted average price, restarting each day ("D"), week ("W") or month ("M"). Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
source | num | Default hlc3 |
anchor | string | Default "D" |
ta.vwap
Daily volume-weighted average price of hlc3.
Returns: a number
ta.vwma(source, length)
Volume-weighted moving average. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.wma(source, length)
Linearly weighted moving average. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
source | num |
length | int |
ta.wpr(length)
Williams %R, -100 to 0. Call on every bar: it keeps its own running memory.
Returns: a number
| Parameter | Type |
|---|---|
length | int |
Education only. Not financial advice. Examples are teaching samples, not trading results.
