Skip to content

API Reference


API Reference / IndicatorAccessors

Interface: IndicatorAccessors ​

Defined in: src/backtest/types.ts:94

Methods ​

sma() ​

sma(period?): number | null

Defined in: src/backtest/types.ts:95

Parameters ​

period? ​

number

Returns ​

number | null


ema() ​

ema(period?): number | null

Defined in: src/backtest/types.ts:96

Parameters ​

period? ​

number

Returns ​

number | null


rsi() ​

rsi(period?): number | null

Defined in: src/backtest/types.ts:97

Parameters ​

period? ​

number

Returns ​

number | null


macd() ​

macd(options?): object

Defined in: src/backtest/types.ts:98

Parameters ​

options? ​
fastPeriod? ​

number

slowPeriod? ​

number

signalPeriod? ​

number

Returns ​

object

macd ​

macd: number | null

signal ​

signal: number | null

hist ​

hist: number | null


atr() ​

atr(period?): number | null

Defined in: src/backtest/types.ts:103

Parameters ​

period? ​

number

Returns ​

number | null


adx() ​

adx(period?): number | null

Defined in: src/backtest/types.ts:104

Parameters ​

period? ​

number

Returns ​

number | null


bollinger() ​

bollinger(options?): object

Defined in: src/backtest/types.ts:105

Parameters ​

options? ​
period? ​

number

standardDeviations? ​

number

Returns ​

object

upper ​

upper: number | null

middle ​

middle: number | null

lower ​

lower: number | null


stochastic() ​

stochastic(options?): object

Defined in: src/backtest/types.ts:110

Parameters ​

options? ​
period? ​

number

signalPeriod? ​

number

Returns ​

object

k ​

k: number | null

d ​

d: number | null


supertrend() ​

supertrend(options?): object

Defined in: src/backtest/types.ts:114

Parameters ​

options? ​
period? ​

number

multiplier? ​

number

Returns ​

object

value ​

value: number | null

direction ​

direction: 1 | -1 | null


vwap() ​

vwap(): number | null

Defined in: src/backtest/types.ts:118

Returns ​

number | null


timeframe() ​

timeframe(minutes): IndicatorAccessors

Defined in: src/backtest/types.ts:124

Same accessors, scoped to one of higherTimeframesMinutes, read at the highest bar that had fully closed as of the current primary bar — never a bar still in progress. Throws if minutes wasn't configured.

Parameters ​

minutes ​

number

Returns ​

IndicatorAccessors


bias() ​

bias(): MultiTimeframeSummary

Defined in: src/backtest/types.ts:130

analyzeMultiTimeframe() bias as of this bar, blended over whichever of higherTimeframesMinutes map onto m1/m5/m15/m25/m60 — other resample minutes are visible via .timeframe(m) but not this blend.

Returns ​

MultiTimeframeSummary

Community project — not affiliated with Dhan. MIT License.