Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
order-groups

Create Order Group

Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.

post/portfolio/order_groups/create

Request body

subaccountinteger

Optional subaccount number to use for this order group (0 for primary, 1-63 for subaccounts). Subaccount-restricted API keys must omit this field or pass their locked subaccount.

contracts_limitinteger

Specifies the 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.

exchange_indexinteger

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

Example request

{
  "contracts_limit_fp": "10.00"
}

Response

Order group created successfully

order_group_idstring required

The unique identifier for the created order group

subaccountinteger required

Subaccount number that owns the created order group (0 for primary, 1-63 for subaccounts).

exchange_indexinteger

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