Cancel batch of orders by order IDs
Queues cancellation for multiple orders by providing identifiers in a batch.
The request body can contain either or both of:
- order_ids: Array of order IDs assigned by Paradex
- client_order_ids: Array of client-assigned order IDs
{
"order_ids": ["order-id-1", "order-id-2"],
"client_order_ids": ["client-id-1", "client-id-2"]
}
Returns a 200 OK status code with detailed results for each order:
{
"results": [
{
"id": "order-id-1",
"client_id": "client-id-X",
"account": "account-1",
"market": "BTC-USD-PERP",
"status": "QUEUED_FOR_CANCELLATION"
},
{
"id": "order-id-2",
"client_id": "client-id-Y",
"account": "account-1",
"market": "ETH-USD-PERP",
"status": "ALREADY_CLOSED"
},
{
"id": "order-id-3",
"client_id": "client-id-1",
"account": "account-1",
"market": "BTC-USD-PERP",
"status": "QUEUED_FOR_CANCELLATION"
},
{
"client_id": "client-id-2",
"status": "NOT_FOUND"
}
]
}
Each result includes:
- id: Order ID (if the order was found)
- client_id: Client order ID (if available)
- account: Account that owns the order
- market: Market of the order
- status: One of:
- QUEUED_FOR_CANCELLATION: Order was successfully queued for cancellation
- ALREADY_CLOSED: Order was already in a closed state
- NOT_FOUND: The order with the provided ID/client ID was not found
Confirmation of cancellation will be sent via websocket or can be verified from GET /orders/:id endpoint.
Orders that are already in a CLOSED state will be included in the response with status "ALREADY_CLOSED".
Request body
Example request
{
"client_order_ids": [
"[\"client-id-1\"",
"\"client-id-2\"]"
],
"order_ids": [
"[\"order-id-1\"",
"\"order-id-2\"]"
]
}Response
List of cancellation results
Changes
Changed in 8 of the 65 revisions of this API.2329
- ●
added the new
BLOCK_TRADE_REPLAYED_SIGNATUREenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
EVM_VAULT_OPERATORS_DISABLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
VAULT_DATA_PRIVATEenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
- ○
removed the
INVALID_RHINOFI_QUOTEenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
INVALID_RHINOFI_QUOTE_COMMITenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
INVALID_RHINOFI_REQUESTenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
- ●
added the new
IP_NOT_ALLOWEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
MARKET_NOT_SETTLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
- ●
added the new
BLOCK_TRADE_INVALID_SIGNATUREenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_SIGNER_KEY_UNAUTHORIZEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
- ●
added the new
EVM_ADDRESS_ALREADY_ONBOARDEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
INSUFFICIENT_EVM_BALANCEenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PORTFOLIO_MARGIN_INVALID_ACCOUNT_KINDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PORTFOLIO_MARGIN_ONBOARDING_DISABLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
- ○
removed the
BAD_STARKNET_REQUESTenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
INVALID_PRICE_PRECISIONenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
TRANSACTION_NOT_FOUNDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
- ▲
the
response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ●
added the new
BLOCK_TRADE_ACCOUNT_MISMATCHenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_ALREADY_CANCELLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_EXPIREDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_INVALID_STATUSenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_MISSING_SIGNATUREenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_MISSING_SIGNERSenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_MISSING_TRADESenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_NOT_ENABLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_NOT_FOUNDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BLOCK_TRADE_UNAUTHORIZEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
EVM_SIGNATURE_VERIFICATION_FAILEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
INVALID_EVM_SIGNATUREenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
MEDIA_NOT_FOUNDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
OFFER_ALREADY_CANCELLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
OFFER_INVALID_STATUSenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
OFFER_PARENT_MISMATCHenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
OFFER_PARENT_NOT_ACCEPTINGenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
OFFER_UNAUTHORIZEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PORTFOLIO_MARGIN_CONFIG_NOT_FOUNDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
SUBKEY_NOT_ACTIVATABLEenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
XP_TRANSFERS_DISABLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ○
removed the
INVALID_JOIN_WAITLIST_REQUESTenum value from the////response property for the response statusresponse-property-enum-value-removed
- ▲
- ▲
added required request body
request-body-added-required
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲