get_strategy_patch_schemasReturn patchable condition targets grouped by role, for discovering sweepable fields.
Area
Strategy Builder
Group
Schema discovery
Access
Read
Risk
Read-only
Details
Full description
Details
Return patchable condition targets grouped by role for a strategy.
Call before a parameter sweep to discover sweepable fields, current values, and valid ranges. Returns one RoleGroup per role (entry/exit/gate/overlay), each containing patchable leaf conditions with label, type, current values, and JSON schema. Use these condition labels in run_backtest sweep overrides to vary parameters.
Labels are stable within a strategy version — re-fetch after editing.
Composite roots (allOf/anyOf/sequence) — the returned label list is authoritative. The bare role.<card_name> form is only a valid sweep target when the slot holds a single non-composite card. Leaves inside a composite must be targeted by their full path role.<composite>.<leaf_name> (or role.<composite>.<type>[_n] for unnamed children). Submitting a bare leaf name that lives inside a composite returns InvalidOverrideError with a "did you mean" hint.
Example — patching an RSI leaf nested in an allOf composite: use label "entry.entry_combo.rsi_lt_30", not the bare "entry.rsi_lt_30" (rejected when entry_combo is the composite root attached to the entry role).
Capabilities
Bounded options and operating modes surfaced above the full JSON schema.
Required Inputs
strategy_idstringStrategy ID