Sign in

v4

latestOpenAPI 3.0.02026-08-04103181301.4 KB
order-groups

Get Order Group

Retrieves details for a single order group including all order IDs and auto-cancel status.

get/portfolio/order_groups/{order_group_id}

Path parameters

order_group_idstring required

Order group ID

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.

Response

Order group retrieved successfully

is_auto_cancel_enabledboolean required

Whether auto-cancel is enabled for this order group

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.

ordersstring[] required

List of order IDs that belong to this order group

exchange_indexinteger

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

Example response

{
  "contracts_limit_fp": "10.00"
}