Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
order-groups

Update Order Group Limit

Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.

put/portfolio/order_groups/{order_group_id}/limit

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

contracts_limitinteger

New maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match.

contracts_limit_fpstring

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

Example request

{
  "contracts_limit_fp": "10.00"
}

Response

Order group limit updated successfully

EmptyResponse required

An empty response body