Skip to main content

SendOrderArgs

Arguments for submitting or replacing an order on the Control Hub endpoint.

FieldTypeRequiredNullableDefaultDescription
IdempotencyKeystrYesNoClient-provided idempotency key used to de-duplicate requests and enable safe retries.
ReplacesOrderintYesYesExisting live order id to replace; null submits a new order.
BrokerAccountIdstrYesNoBroker account id where the order should be submitted.
ExecPlanIdintYesNoLive execution plan id produced by a preparation job.
QtyMultiplierDecimalYesYesQuantity multiplier for AddPosition/AddLegs orders. Positive and required for entry/add-leg plans; it may override the prepared multiplier only before execution starts, then must match the locked multiplier. Must be null for exits, removals, and moves.
LegGroupIdintYesNoExecution-plan leg group id being ordered.
LegGroupOrderLegGroupOrderYesNoOrder parameters and execution-plan leg ids for the selected leg group.