rebalance_check
Generate buy/sell/hold suggestions to move portfolio toward target allocation. Modes include total rebalance, band-triggered, fixed DCA, and cash flow only.
Instructions
Buy/sell/hold suggestions to move current holdings toward the target allocation (ASSET_TARGET). There are exactly 4 modes: 'to_total' (rebalance the whole book back to target weights — ALSO deploys new_cash into the rebalance if you pass it) and 'bands' (the same plan, but only when some sleeve has drifted past the 5%/25% threshold; if none has, every line is HOLD); 'fixed_dca' (spread new_cash across the target mix) and 'cash_flow_only' (put new_cash into the most-underweight sleeves) — these two REQUIRE new_cash > 0 and suggest all-HOLD when it is 0. Offline + read-only — it suggests, never trades. A NEW target ticker can't be sized offline (no cached price); those appear under 'unpriced'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | to_total | |
| new_cash | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asof | Yes | ||
| mode | Yes | ||
| note | No | ||
| new_cash | No | new cash deployed this run: fixed_dca / cash_flow_only REQUIRE it; to_total and bands also deploy it when passed (bands only if some holding has drifted outside its band). For fixed_dca / cash_flow_only, 0 → all-HOLD. | |
| unpriced | Yes | held/target tickers with no cached price; offline, a NEW target ticker can't be sized — run the CLI online for a full plan | |
| suggestions | Yes | ||
| target_source | No | the ASSET_TARGET file the plan is measured against |