Skip to main content

PreparePositionEntryResult

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

FieldTypeRequiredNullableDefaultDescription
ExecPlanIdintYesNoLive execution plan id created for the prepared entry.
PositionNamestrYesNoProposed position name.
StrategyIdintYesNoStrategy id used to prepare the entry.
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.
AbortConditionslist[ConditionEvaluation]YesNoEvaluated entry-abort conditions.
EntryConditionslist[ConditionEvaluation]YesNoEvaluated entry conditions.
EntryAllowedboolYesNoTrue when entry conditions allow the position to be entered.
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 for the prepared position.
PositionPriceLivePricesYesNoAggregate price for the prepared position.
UnderlyingPriceLivePricesYesNoLatest underlying price snapshot used during preparation.
QtyMultiplierDecimalNoYesQuantity multiplier applied during preparation, when provided.