One holding across its whole range
sweep_holdingOne holding already in the portfolio, measured at every weight from none to all, the rest of the money shared out in proportion: volatility, its share of the risk and the number of independent bets at each point. Typical questions: 'How much BND does it take to change anything?'; 'Show me my portfolio with 0% to 100% QQQ.'; 'At what weight does gold start to matter here?'. Instead: for one specific change, test_a_change. For a holding not yet owned, check_before_you_buy. It never says which weight to hold. It does not recommend, predict or calculate tax.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | Currency code every figure is expressed in: USD, EUR, GBP, CAD… Default USD. | |
| ticker | Yes | The holding to sweep; must be one of `holdings`. | |
| holdings | Yes | What is held: {ticker: number}, 1 to 100 holdings. Weights in any scale (60/20/20 or 0.6/0.2/0.2) or money amounts in the base currency (60000/20000/20000): `units` says which; without it, holdings adding up to 1 or 100 are read as percentages, anything else as money, which makes the falls come out in money. Tickers as the exchange lists them (VOO, VWCE.DE, EQQQ.DE, XAW.TO; 'CASH.USD' for cash). Example: {"VTI": 60, "VXUS": 20, "BND": 20}. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Window end. | |
| data | No | Where the prices came from and what was missing or repaired. | |
| kind | No | Kind of figures (counterfactual). | |
| knee | No | Weight below which most of the change happens, when there is one. | |
| note | No | One sentence on where the change comes from. | |
| start | No | Window start. | |
| _fence | Yes | What these figures are and are not: descriptive, no forecast, no advice. Repeat its sense when presenting the result. | |
| points | No | Per weight: weight, vol (volatility), risk_share (that holding's share of the risk), effective_bets, top_factor_share. | |
| ticker | No | The holding swept. | |
| total_change | No | Change in volatility from none to the current weight. | |
| redistribution | No | How the rest of the money is spread at each point. |