Back to builder reference
Value ref
equityThe strategy's running equity-curve value.
field selects: current (equity right now), peak (the running
high-water mark), or drawdown_pct (percent below that peak — 0 at a
new high, positive while underwater). Use drawdown_pct directly for a
circuit-breaker gate rather than deriving it from current/peak.
VIB-1370 / VIB-1319: the sub-metric selector is named field
across every ValueRef-style type. The legacy name equity_metric was
removed.
Backing types
EquityValueRef
Required fields
FieldTypeDescription
fieldreqenum: drawdown_pct, current, peak-Optional fields
FieldTypeDescription
kindstring-resolutionanyOf (2 variants)Optional higher-timeframe override for this value ref. Set it inside left/right refs such as {'kind': 'indicator', ..., 'resolution': '4h'} or {'kind': 'price', 'field': 'close', 'resolution': '4h'}. Do not put timeframe/source_timeframe on the parent condition. None = strategy timeframe.symbolanyOf (2 variants)Optional reference symbol this value ref reads from (e.g. 'SPY'). None = the traded/primary symbol. Mutually exclusive with resolution.Backing types
The IR ValueRef classes this builder field resolves to.
EquityValueRef