Request
This endpoint expects an object.
reqIDlongRequired
Request identifier to uniquely track a request.
modelstringRequired
Name of the model to rebalance.
positionTargetslist of objectsRequired
Position targets to override for the model. Only these instruments are adjusted; the rest of the model is preserved.
subscriptionKeystringOptional
Subscription key. Send an empty string on the initial request.
Response
Successfully retrieved the rebalance allocation preview.
accountsCanTradeFractionslist of stringsOptional
Accounts eligible to trade fractional shares.
allocationTotalslist of objectsOptional
Aggregate buy/sell totals per instrument.
allocationslist of objectsOptional
Individual allocation instructions produced by the rebalancer.
baseCcystringOptional
Base currency of the model.
contractsAllocEnabledlist of longsOptional
Contract identifiers for which allocation is enabled.
contractsCashQtyEnabledlist of longsOptional
Contract identifiers for which cash-quantity allocation is enabled.
contractsFracEligiblelist of longsOptional
Contract identifiers eligible for fractional-share allocation.
errorslist of stringsOptional
List of errors produced by the rebalancer. Empty when the preview is successful.
miPositionTransferslist of objectsOptional
Position transfers scheduled between managed-independent accounts.
modelstringOptional
Name of the model that was rebalanced.
positionTransferslist of objectsOptional
Position transfers scheduled between the model and its accounts.
reqIDlongOptional
Request identifier echoed from the originating request.
subscriptionStatuslongOptional
Describes if the model is in polling mode.
transfersInstructionIdstringOptional
Identifier that groups the resulting transfers; supply to downstream submit endpoints.
warningslist of stringsOptional
Non-fatal warnings produced by the rebalancer.
