Renko

forge.barsfunctionSince Forge API 1
Signaturepython
forge.bars.Renko(box: float | Param | Mapping[str, Any],*,unit: str = 'pips',trend: float | Param = 1,reversal: float | Param = 2,offset: float = 0.0,wicks: bool = False,new_bar_mode: str = 'close_on_threshold',preset: str | None = 'traditional',basis: str | Param | None = None,day_boundary: str | None = None,on_closure: str | None = None,anchor: str | float | None = None) -> BarDecl

Renko bricks. box is the brick size in unit (default pips), or an ATR or percent box.

Parameters

NameTypeDefault
boxfloat | Param | Mapping[str, Any]
unitstr'pips'
trendfloat | Param1
reversalfloat | Param2
offsetfloat0.0
wicksboolFalse
new_bar_modestr'close_on_threshold'
presetstr | None'traditional'
basisstr | Param | NoneNone
day_boundarystr | NoneNone
on_closurestr | NoneNone
anchorstr | float | NoneNone

trend (default 1) and reversal (default 2) count boxes; offset is 0 to 1.