How It Works
- Create a group with a contracts limit (1–1,000,000). The server generates the group ID and returns it in the response.
- Place orders with the group’s ID. Each order is tracked against the group.
- As orders execute, filled contract counts accumulate within a rolling 15-second window.
- If the rolling total exceeds the limit, the group is triggered: all resting orders in the group are canceled.
Group States
| State | Behavior |
|---|---|
| Active | Orders can be placed; rolling volume is tracked against the limit |
| Triggered | All resting orders canceled; new orders rejected until the group is reset |
- The rolling 15-second volume exceeds the contracts limit
- A manual Trigger action is issued, which cancels all orders regardless of whether the limit has been reached
- The limit is Updated to a value below the current rolling volume