Added
New "group_id" and "group_role" fields on orders
October 8th, 2026
Adds two optional fields to the Order and OrderLeg schemas so callers can identify which bracket, OTO, or OCO order an individual order belongs to:
group_id: an opaque UUID shared by every order in the samebracket,oto, orocoorder, including legs and replacements.group_role: one ofentry,take_profit, orstop_lossfrom the newOrderGroupRoleenum. Forocoorders, the top-level order istake_profit.
Both keys are omitted for orders that are not part of a bracket, oto, or oco order. New bracket-order response examples have been added.
Broker API
Trade events delivered over SSE carry group_id and group_role on the order payload, so stream-only clients can group legs that arrive individually with legs: null. A bracket-leg trade update example has been added.
Affected Endpoints
POST /v1/trading/accounts/{account_id}/ordersGET /v1/trading/accounts/{account_id}/ordersGET /v1/trading/accounts/{account_id}/orders/{order_id}GET /v1/trading/accounts/{account_id}/orders:by_client_order_idPATCH /v1/trading/accounts/{account_id}/orders/{order_id}DELETE /v1/trading/accounts/{account_id}/ordersPOST /v1/trading/accounts/{account_id}/orders/estimationDELETE /v1/trading/accounts/{account_id}/positionsDELETE /v1/trading/accounts/{account_id}/positions/{symbol_or_asset_id}GET /v1/rebalancing/runsGET /v1/rebalancing/runs/{run_id}GET /v2/events/trades
Trading API
POST /v2/ordersGET /v2/ordersGET /v2/orders/{order_id}GET /v2/orders:by_client_order_idPATCH /v2/orders/{order_id}DELETE /v2/positionsDELETE /v2/positions/{symbol_or_asset_id}