This endpoint requires signature authentication. See our comprehensive Authentication via Signatures guide for implementation details.
Get your own node endpoint todayStart for free and get your app to production levels immediately. No credit card required.You can sign up with your GitHub, X, Google, or Microsoft account.
Parameters
Required parameters
-
action
(object, required) — The cancel action object containing:type
(string) — Must be"cancelByCloid"
cancels
(array) — Array of cancel objects with:asset
(number) — Asset indexcloid
(string) — Client order ID (128-bit hex string, e.g.,0x1234567890abcdef1234567890abcdef
)
-
nonce
(number, required) — Current timestamp in milliseconds (must be recent) -
signature
(object, required) — EIP-712 signature of the action
Optional parameters
vaultAddress
(string, optional) — Address when trading on behalf of a vault or subaccountexpiresAfter
(number, optional) — Timestamp in milliseconds after which the request is rejected
Returns
Returns an object with cancellation status:status
—"ok"
if request processedresponse
— Contains cancellation details:type
—"cancelByCloid"
data.statuses
— Array of status results for each cancellation attempt
Example request
Client Order ID (cloid)
The client order ID is a 128-bit hexadecimal string that you provide when placing an order. It allows you to:- Track orders using your own identification system
- Cancel orders without needing to store exchange-generated order IDs
- Implement idempotent order placement strategies
0x1234567890abcdef1234567890abcdef
Use cases
- Custom order tracking — Cancel orders using your internal order management system IDs
- Failover systems — Cancel orders without needing to query order IDs first
- Multi-system integration — Use consistent order IDs across different systems
- Idempotent operations — Safely retry cancellations using deterministic IDs
Client order IDs must be unique per user. Attempting to place an order with a duplicate cloid will be rejected.
Make sure to store the cloid when placing orders if you plan to use this cancellation method. The cloid must match exactly what was provided during order placement.
Body
application/json
Current timestamp in milliseconds
EIP-712 signature of the action with r, s, v components
Address when trading on behalf of a vault or subaccount (optional)
Timestamp in milliseconds after which the request is rejected (optional)