Skip to main content

PreparePositionAdjustmentResult

Completed result for a position-adjustment preparation job on the Control Hub endpoint.

FieldTypeRequiredNullableDefaultDescription
ExecPlanIdintYesNoLive execution plan id created for the prepared adjustment.
OperationPositionAdjustmentOperationYesNoAdjustment operation represented by the execution plan.
ConditionstrYesNoAdjustment condition that triggered or selected the operation.
PositionIdintYesNoExisting live position id being adjusted.
PositionNamestrYesNoExisting live position name.
StrategyIdintYesNoStrategy id associated with the position.
StrategyNamestrYesNoStrategy name at preparation time.
BrokerAccountIdstrYesNoBroker account id used for preparation.
OrderLegslist[ExecPlanLegRef]YesNoStable execution-plan leg references to use for orders, paper fills, and per-leg quote data.
LegGroupsdict[int, list[str]]YesNoExecution-plan leg ids grouped by leg group id.
LegGroupQtysdict[int, ExecutionPlanLegGroupQtys]YesNoPlanned signed leg quantities and group quantities keyed by leg group id.
Varsdict[str, Decimal]YesNoPrepared strategy variables keyed by variable name.
LegGreeksdict[str, LiveGreeks]YesNoLive greeks keyed by execution-plan leg id.
LegPricesdict[str, LivePrices]YesNoLive prices keyed by execution-plan leg id.
LegGroupGreeksdict[int, LiveGreeks]YesNoAggregate greeks keyed by leg group id.
LegGroupPricesdict[int, LivePrices]YesNoAggregate prices keyed by leg group id.
PositionGreeksLiveGreeksYesNoAggregate greeks after the prepared adjustment.
PositionPriceLivePricesYesNoAggregate price for the prepared adjustment.
UnderlyingPriceLivePricesYesNoLatest underlying price snapshot used during preparation.
QtyMultiplierDecimalNoYesQuantity multiplier applied during preparation, when provided.
AbortConditionslist[ConditionEvaluation]NoYesEvaluated adjustment-abort conditions, when the adjustment type supports them.
AdjustmentAllowedboolNoYesTrue when adjustment conditions allow the prepared operation to continue; null when not applicable.