iATR

Calculates the Average True Range (ATR) indicator value for any symbol and timeframe.

Syntax

iATR(
symbol: string,
timeframe: number,
index: number,
atrPeriod: number,
applyToPrice: TPriceType
): number

Parameters

Parameter	Type	Description
symbol	string	Symbol name
timeframe	number	Timeframe in minutes
index	number	Index of the bar to calculate ATR for
atrPeriod	number	ATR averaging period
applyToPrice	TPriceType	Type of price to use (Open, High, Low, Close, etc.)

Return Value

Returns a number representing the ATR value at the specified bar index.

Description

Calculates the Average True Range (ATR) indicator.

Example

const atr = this.api.iATR('EURUSD', 60, 0, 14, TPriceType.PRICE_CLOSE)