v3

OpenAPI 3.0.02026-07-31103181312.8 KB
order-groups

Trigger Order Group

Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.

put/portfolio/order_groups/{order_group_id}/trigger

Path parameters

order_group_idstring required

Order group ID

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0.

exchange_indexinteger

Identifier for an exchange shard. Defaults to 0 if unspecified.

Request body

EmptyResponse required

An empty response body

Response

Order group triggered successfully

EmptyResponse required

An empty response body