SignalR Reference: Control Hub

Control Hub: APIs for managing strategies, positions, and orders.

• Hub URL: /hubs/control/v1

All request/response methods return an API envelope (MesoLiveApiResponse<T>).

Envelope fields: MesoLiveApiResponse

GetIdempotencyRecord

Retrieve the idempotency record for a previously submitted idempotent operation.

Args model: GetIdempotencyRecordArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Idempotency key used for an idempotent operation (e.g. SendOrder, ApplyPaperFills, CancelOrder).

Returns (payload): IdempotencyRecord

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Idempotency key used to de-duplicate requests and enable safe retries.
Operation	IdempotencyOperation	Yes	No		Operation type associated with this key.
Status	IdempotencyRecordStatus	Yes	No		Processing state for this operation.
CreatedAt	datetime	Yes	No		UTC timestamp when the record was created.
UpdatedAt	datetime	Yes	No		UTC timestamp when the record was last updated.
RequestHash	str	No	Yes		Optional hash of the original request payload (for diagnostics).
LiveExecPlanId	int	No	Yes		Optional live execution plan id associated with the operation (if applicable).
LiveOrderIds	list[int]	No	Yes		Optional live order ids created/affected by the operation (if applicable).
ErrorMessage	str	No	Yes		Error message for failed operations (if available).
JobId	str	No	Yes		Job id for asynchronous operations (if applicable).
JobStatus	PreparationStatus	No	Yes		Job status for asynchronous operations (if applicable).
JobResult	JsonElement	No	Yes		Raw job result payload for asynchronous operations (if applicable).
JobErrorMessage	str	No	Yes		Raw job error message for asynchronous operations (if applicable).
ResponseStatus	StatusCode	No	Yes		Response status code returned by the original API call (if captured).
ResponseMessage	str	No	Yes		Response message returned by the original API call (if captured).
ResponseError	MesoLiveApiError	No	Yes		Response error details returned by the original API call (if captured).
ResponseData	str	No	Yes		Raw response data returned by the original API call (if captured).

ListAgents

List currently connected agent instances (per provider/connector).

Args model: ListAgentsArgs

No fields.

Returns (payload): ListAgentsResult

Field	Type	Required	Nullable	Default	Description
Agents	list[AgentInfo]	Yes	No		Connected agents.

ListAccounts

List brokerage accounts linked to the authenticated user.

Args model: ListAccountsArgs

Field	Type	Required	Nullable	Default	Description
BrokerTypeFilter	BrokerType	No	Yes		Optional filter by broker type. null = all brokerages.
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListAccounts call.

Returns (payload): ListAccountsResult

Field	Type	Required	Nullable	Default	Description
Accounts	list[LiveAccount]	Yes	No		Accounts returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

GetAccount

Get a single brokerage account by broker account id.

Args model: GetAccountArgs

Field	Type	Required	Nullable	Default	Description
BrokerAccountId	str	No	No		Broker account id to retrieve.

Returns (payload): GetAccountResult

Field	Type	Required	Nullable	Default	Description
Account	LiveAccount	Yes	No		Account details.

CreateStrategy

Create a new live strategy from a Strategy Definition.

Args model: CreateStrategyArgs

Field	Type	Required	Nullable	Default	Description
Name	str	Yes	No		User-facing strategy name.
Description	str	Yes	No		User-facing strategy description.
BacktestId	str	Yes	No		Backtest identifier used for traceability (as produced by MesoSim tooling).
MesoSimInstance	str	Yes	No		MesoSim instance identifier where the strategy definition originated.
StrategyDefinition	dict[str, Any]	Yes	No		Strategy Definition payload.
ActiveOnAccounts	list[str]	Yes	No		Broker account ids where this strategy should be active/enabled.

Returns (payload): CreateStrategyResult

Field	Type	Required	Nullable	Default	Description
StrategyId	int	No	No		Live strategy id created by the server.

UpdateStrategy

Update an existing live strategy definition and its activation settings.

Args model: UpdateStrategyArgs

Field	Type	Required	Nullable	Default	Description
StrategyId	int	Yes	No		Live strategy id to update.
StrategyDefinition	dict[str, Any]	Yes	No		Updated strategy definition payload.
ActiveOnAccounts	list[str]	Yes	No		Broker account ids where this strategy should be active/enabled.

Returns (payload): UpdateStrategyResult

No fields.

RenameStrategy

Rename an existing live strategy.

Args model: RenameStrategyArgs

Field	Type	Required	Nullable	Default	Description
StrategyId	int	Yes	No		Live strategy id to rename.
Name	str	Yes	No		New user-facing strategy name.

Returns (payload): RenameStrategyResult

Field	Type	Required	Nullable	Default	Description
Success	bool	No	No		Whether the rename operation succeeded.

DeleteStrategy

Delete an existing live strategy.

Args model: DeleteStrategyArgs

Field	Type	Required	Nullable	Default	Description
StrategyId	int	Yes	No		Live strategy id to delete.

Returns (payload): DeleteStrategyResult

Field	Type	Required	Nullable	Default	Description
Success	bool	No	No		Whether the delete operation succeeded.

ListStrategies

List strategies accessible to the authenticated user.

Args model: ListStrategiesArgs

Field	Type	Required	Nullable	Default	Description
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListStrategies call.
ActiveOnAccounts	list[str]	No	Yes		Optional filter: only strategies active on any of these broker account ids.

Returns (payload): ListStrategiesResult

Field	Type	Required	Nullable	Default	Description
Strategies	list[LiveStrategy]	Yes	No		Strategies returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

GetStrategy

Get a single strategy by strategy id.

Args model: GetStrategyArgs

Field	Type	Required	Nullable	Default	Description
StrategyId	int	Yes	No		Live strategy id to retrieve.

Returns (payload): GetStrategyResult

Field	Type	Required	Nullable	Default	Description
Strategy	LiveStrategy	Yes	No		Strategy details.

ListPositions

List live positions.

Args model: ListPositionsArgs

Field	Type	Required	Nullable	Default	Description
LiveStrategyId	int	No	Yes		Optional filter by live strategy id.
LiveExecPlanId	int	No	Yes		Optional filter by live execution plan id.
BrokerAccountId	str	No	Yes		Optional filter by broker account id.
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListPositions call.

Returns (payload): ListPositionsResult

Field	Type	Required	Nullable	Default	Description
Positions	list[LivePosition]	No	No		Positions returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

StartPreparePositionEntry

Start an asynchronous "prepare entry" job for entering a new position. Matches the Build Position functionality of the UI.

Args model: PreparePositionEntryArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
PositionName	str	Yes	No		User-facing name for the new position to be created.
StrategyId	int	Yes	No		Live strategy id to enter.
BrokerAccountId	str	Yes	No		Target broker account id to enter the position on.
LegSelectionConstraint	LiveLegSelectionConstraint	Yes	No		Constraint for how option legs may be selected (uniqueness rules).
Underlying	LiveUnderlying	Yes	No		Underlying used as the basis for leg selection and quoting.
DataProvider	DataProviderType	Yes	Yes		Optional override for which market data provider to use. null = server default.

Returns (payload): StartPreparePositionEntryResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id identifying the asynchronous preparation.

GetPreparePositionEntryStatus

Get status and (if completed) the result of a "prepare entry" job.

Args model: GetPreparePositionEntryStatusArgs

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id returned by StartPreparePositionEntry.

Returns (payload): GetPreparePositionEntryStatusResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Status	PreparationStatus	Yes	No		Current job status.
Result	PreparePositionEntryResult	No	Yes		Result payload when Status is Completed.
Error	str	No	Yes		Error message when Status is Failed.
CreatedAt	datetime	Yes	No		UTC timestamp when the job was created.
UpdatedAt	datetime	Yes	No		UTC timestamp when the job was last updated.

CancelPreparePositionEntry

Cancel an in-progress "prepare entry" job.

Args model: CancelPreparePositionEntryArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
JobId	str	Yes	No		Job id returned by StartPreparePositionEntry.

Returns (payload): CancelPreparePositionEntryResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Cancelled	bool	Yes	No		Whether the job was cancelled.

StartPreparePositionExit

Start an asynchronous "prepare exit" job for exiting an existing position. Matches the Liquidate functionality of the UI.

Args model: PreparePositionExitArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
PositionId	int	Yes	No		Live position id to exit.

Returns (payload): StartPreparePositionExitResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id identifying the asynchronous preparation.

GetPreparePositionExitStatus

Get status and (if completed) the result of a "prepare exit" job.

Args model: GetPreparePositionExitStatusArgs

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id returned by StartPreparePositionExit.

Returns (payload): GetPreparePositionExitStatusResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Status	PreparationStatus	Yes	No		Current job status.
Result	PreparePositionExitResult	No	Yes		Result payload when Status is Completed.
Error	str	No	Yes		Error message when Status is Failed.
CreatedAt	datetime	Yes	No		UTC timestamp when the job was created.
UpdatedAt	datetime	Yes	No		UTC timestamp when the job was last updated.

CancelPreparePositionExit

Cancel an in-progress "prepare exit" job.

Args model: CancelPreparePositionExitArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
JobId	str	Yes	No		Job id returned by StartPreparePositionExit.

Returns (payload): CancelPreparePositionExitResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Cancelled	bool	Yes	No		Whether the job was cancelled.

StartPreparePositionAdjustment

Start an asynchronous "prepare adjustment" job for adjusting an existing position.

Args model: PreparePositionAdjustmentArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
PositionId	int	Yes	No		Live position id to adjust.
Operation	PositionAdjustmentOperation	Yes	No		Adjustment operation to prepare (e.g. remove/add legs, move a leg, or update vars).
Condition	str	Yes	No		Condition identifier or expression used by the server to select and validate the adjustment.
LegSelectionConstraint	LiveLegSelectionConstraint	No	Yes		Optional constraint for how option legs may be selected (uniqueness rules). null = server default.
DataProvider	DataProviderType	No	Yes		Optional override for which market data provider to use. null = server default.

Returns (payload): StartPreparePositionAdjustmentResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id identifying the asynchronous preparation.

GetPreparePositionAdjustmentStatus

Get status and (if completed) the result of a "prepare adjustment" job.

Args model: GetPreparePositionAdjustmentStatusArgs

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id returned by StartPreparePositionAdjustment.

Returns (payload): GetPreparePositionAdjustmentStatusResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Status	PreparationStatus	Yes	No		Current job status.
Result	PreparePositionAdjustmentResult	No	Yes		Result payload when Status is Completed.
Error	str	No	Yes		Error message when Status is Failed.
CreatedAt	datetime	Yes	No		UTC timestamp when the job was created.
UpdatedAt	datetime	Yes	No		UTC timestamp when the job was last updated.

CancelPreparePositionAdjustment

Cancel an in-progress "prepare adjustment" job.

Args model: CancelPreparePositionAdjustmentArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
JobId	str	Yes	No		Job id returned by StartPreparePositionAdjustment.

Returns (payload): CancelPreparePositionAdjustmentResult

Field	Type	Required	Nullable	Default	Description
JobId	str	Yes	No		Job id.
Cancelled	bool	Yes	No		Whether the job was cancelled.

GetPosition

Get a detailed view of a single live position (legs, leg groups, vars, quotes/greeks).

Args model: GetPositionArgs

Field	Type	Required	Nullable	Default	Description
LivePositionId	int	No	No		Live position id to retrieve.

Returns (payload): GetPositionResult

Field	Type	Required	Nullable	Default	Description
Position	LivePosition	No	No		Position details.
Vars	dict[str, Decimal]	No	No		Current strategy/position variables (var name → value).
LegGreeks	dict[str, LiveGreeks]	No	No		Per-leg greeks keyed by leg name.
LegPrices	dict[str, LivePrices]	No	No		Per-leg prices keyed by leg name.
PositionLegs	dict[str, LiveLeg]	Yes	No		Position legs keyed by leg name.
LegGroups	dict[int, list[str]]	Yes	No		Leg groups keyed by leg group id. Values are lists of leg names in that group.
LegGroupQtys	dict[int, LegGroupQtys]	Yes	No		Per-leg-group quantities (group qty and per-leg quantities) keyed by leg group id.
LegGroupGreeks	dict[int, LiveGreeks]	No	No		Per-leg-group greeks keyed by leg group id.
LegGroupPrices	dict[int, LivePrices]	No	No		Per-leg-group prices keyed by leg group id.
PositionGreeks	LiveGreeks	No	No		Aggregated greeks for the position.
PositionPrice	LivePrices	No	No		Aggregated prices for the position.

ListLegs

List live legs.

Args model: ListLegsArgs

Field	Type	Required	Nullable	Default	Description
LivePositionId	int	No	Yes		Optional filter by live position id.
LiveStrategyId	int	No	Yes		Optional filter by live strategy id.
LiveExecPlanId	int	No	Yes		Optional filter by live execution plan id.
BrokerAccountId	str	No	Yes		Optional filter by broker account id.
IsOpen	bool	No	Yes		Optional filter by open/closed state. null = both open and closed.
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListLegs call.

Returns (payload): ListLegsResult

Field	Type	Required	Nullable	Default	Description
Legs	list[LiveLeg]	No	No	new()	Legs returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

GetLegs

Get multiple legs by leg id.

Args model: GetLegsArgs

Field	Type	Required	Nullable	Default	Description
LegIds	list[int]	Yes	No		Live leg ids to retrieve.

Returns (payload): GetLegsResult

Field	Type	Required	Nullable	Default	Description
Legs	dict[int, LiveLeg]	Yes	No		Legs keyed by live leg id.
LegGreeks	dict[int, LiveGreeks]	No	Yes		Optional greeks keyed by live leg id (if available).
LegPrices	dict[int, LivePrices]	No	Yes		Optional prices keyed by live leg id (if available).

GetLeg

Get a single leg by leg id.

Args model: GetLegArgs

Field	Type	Required	Nullable	Default	Description
LegId	int	No	No		Live leg id to retrieve.

Returns (payload): GetLegResult

Field	Type	Required	Nullable	Default	Description
Leg	LiveLeg	Yes	No		Leg details.
LegGreeks	LiveGreeks	No	Yes		Optional greeks snapshot for the leg (if available).
LegPrices	LivePrices	No	Yes		Optional prices snapshot for the leg (if available).

ApplyPaperFills

Apply fills to an execution plan on a paper account.

Args model: ApplyPaperFillsArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
BrokerAccountId	str	Yes	No		Target paper broker account id to apply fills to.
ExecPlanId	int	Yes	No		Live execution plan id to apply paper fills for.
QtyMultiplier	Decimal	Yes	Yes		Optional quantity multiplier for entry flows (used to scale leg quantities). May be ignored/validated for non-entry flows.
PaperLegFills	dict[str, PaperLegFill]	Yes	No		Per-leg paper fills keyed by leg name.

Returns (payload): ApplyPaperFillsResult

Field	Type	Required	Nullable	Default	Description
Success	bool	Yes	No		Whether the paper fills were applied successfully.

SendOrder

Submit an order for a real (non-paper) brokerage account.

Args model: SendOrderArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
ReplacesOrder	int	Yes	Yes		Optional live order id to replace (maps to the underlying broker order id).
BrokerAccountId	str	Yes	No		Target broker account id to submit the order on.
ExecPlanId	int	Yes	No		Live execution plan id this order belongs to.
QtyMultiplier	Decimal	Yes	Yes		Optional quantity multiplier for entry flows (used to scale leg quantities). May be ignored/validated for non-entry flows.
LegGroupId	int	Yes	No		Leg group id within the execution plan to submit the order for.
LegGroupOrder	LegGroupOrder	Yes	No		Order parameters for the selected leg group (order type, limit/stop prices, leg names, etc.).

Returns (payload): SendOrderResult

Field	Type	Required	Nullable	Default	Description
LiveOrderId	int	No	Yes		Live order id created/updated by the server (if available).
OrderState	OrderState	No	Yes		Current order state (if available).
Rejection	OrderRejectionInfo	No	Yes		Rejection details when the order is rejected.

CancelOrder

Request cancellation of an existing live order.

Args model: CancelOrderArgs

Field	Type	Required	Nullable	Default	Description
IdempotencyKey	str	Yes	No		Client-provided idempotency key used to de-duplicate requests and enable safe retries.
LiveOrderId	int	Yes	No		Live order id to cancel.

Returns (payload): CancelOrderResult

Field	Type	Required	Nullable	Default	Description
LiveOrderId	int	Yes	No		Live order id that was cancelled (or cancellation was requested for).

GetOrder

Get a single order by order id.

Args model: GetOrderArgs

Field	Type	Required	Nullable	Default	Description
OrderId	int	Yes	No		Live order id to retrieve.

Returns (payload): GetOrderResult

Field	Type	Required	Nullable	Default	Description
Order	Order	Yes	No		Order details.

ListOrders

List orders for a given execution plan.

Args model: ListOrdersArgs

Field	Type	Required	Nullable	Default	Description
ExecPlanId	int	Yes	No		Live execution plan id to list orders for.
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListOrders call.

Returns (payload): ListOrdersResult

Field	Type	Required	Nullable	Default	Description
Orders	list[Order]	Yes	No		Orders returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

ListExecutions

List executions.

Args model: ListExecutionsArgs

Field	Type	Required	Nullable	Default	Description
LiveLegId	int	No	Yes		Optional filter by live leg id.
LivePositionId	int	No	Yes		Optional filter by live position id.
LiveStrategyId	int	No	Yes		Optional filter by live strategy id.
LiveExecPlanId	int	No	Yes		Optional filter by live execution plan id.
BrokerAccountId	str	No	Yes		Optional filter by broker account id.
Limit	int	No	Yes		Maximum number of items to return. The server may cap this value.
ContinuationToken	str	No	Yes		Pagination token returned by a previous ListExecutions call.

Returns (payload): ListExecutionsResult

Field	Type	Required	Nullable	Default	Description
Executions	list[LiveExecution]	Yes	No		Executions returned by this page.
ContinuationToken	str	No	Yes		Pagination token for the next page. null/empty when no more items are available.

GetExecution

Get a single execution by execution id.

Args model: GetExecutionArgs

Field	Type	Required	Nullable	Default	Description
ExecutionId	int	Yes	No		Live execution id to retrieve.

Returns (payload): GetExecutionResult

Field	Type	Required	Nullable	Default	Description
Execution	LiveExecution	Yes	No		Execution details.

GetExecutions

Get multiple executions by execution ids.

Args model: GetExecutionsArgs

Field	Type	Required	Nullable	Default	Description
ExecutionIds	list[int]	Yes	No		Live execution ids to retrieve.

Returns (payload): GetExecutionsResult

Field	Type	Required	Nullable	Default	Description
Executions	dict[int, LiveExecution]	Yes	No		Executions keyed by live execution id.