AnnouncementsGuidesAPI ReferenceSupport
API Reference
Start typing to search…

Batch Order Cancel

delete https://EXCHANGE-REGION-ENDPOINT-URL.com/v1/orders/open

Request Parameters

Name

Description

Type

cancel_side

Order Side

  • all : both ask and bid sides (default)
  • ask : only ask side
  • bid : only bid side

String

pairs

Market pair list to cancel (ex. SGD-BTC,SGD-ETH)
*A maximum of 20 pairs can be canceled per request.

  • If pairs are passed, only orders in those market pairs will be canceled.
    (e.x. if cancel_side = all, pairs = SGD-BTC,SGD-ETH, only pending orders in SGD-BTC and SGD-ETH markets will be canceled)

String

excluded_pairs

Excluded market pair list. (ex. SGD-BTC,SGD-ETH)
*A maximum of 20 excluded_pairs can be passed per a request.

  • If excluded_pairs are passed, orders in those market pairs will be ignored.
    (e.x. if cancel_side =ask, excluded_pairs = SGD-BTC, pending orders except in SGD-BTC market will be canceled.

String

quote_currencies

Quote unit list to cancel. (ex. SGD,BTC)

  • If quote_currencies are passed, only orders in those quote units will be canceled.
    (e.x. if cancel_side =bid, quote_currencies = SGD, pending orders with only bid side in all SGD market pairs will be canceled.

String

count

A maximum number of orders to cancel. (default : 20, max : 300)

Number

order_by

Sorting method

  • asc : requesting cancellation in the order of oldest first.
  • desc : requesting cancellation in the order of newest first. (default)

String

*If no parameters are passed, a maximum of 20 recent orders, regardless of their sides, will be canceled.

❗️

This API only accepts the query parameter format. Please note that requesting with body is not supported.

❗️

Please Note That

  • Either pairs or quote_currencies can be passed. If neither is passed, pending orders in all markets will be requested to cancel.
  • Depending on order_by field, if asc, orders will be canceled in the order of oldest creation time, and if desc(default), orders will be canceled in the newest creation time will be canceled, up to specified count.
  • Only orders with WAIT status will be canceled. Orders with WATCH status cannot be canceled in this API.
    → Please use Order List Cancel(DELETE /v1/orders/uuids) or Order Cancel(DELETE /v1/order) instead to cancel orders with WATCH status.
  • This API has a separate rate limit : 1 request per 2 seconds
  • Since trades could be occurred during the cancellation process, their remaining volumes at the time of request could be differ from the volume after cancellation is completed.
  • If a market pair is included in pairs or quote_currencies but also is included in excluded_pairs, orders for that pair will not be canceled as per the request. ( excluded_pairsfirst)

Response

필드

설명

타입

success

information of orders successfully requested for cancellation

Object

success.count

The number of orders successfully requested for cancellation

Number

success.orders

List of the orders successfully requested for cancellation

Array[Object]

success.orders.uuid

UUID of the order

String

success.orders.identifier

User custom value for query
*Provided only for orders created after October 18, 2024

String

success.orders.market

Market pair of the order

String

failed

information of orders failed to request for cancellation

Object

failed.count

The number of orders failed to request for cancellation

Number

failed.orders

List of the orders failed to request for cancellation

Array[Object]

failed.orders.uuid

UUID of the order

String

failed.orders.identifier

User custom value for query
*Provided only for orders created after October 18, 2024

String

failed.orders.market

Market pair of the order

String

❗️

Cancellation Failure

Cancellation requests could fail for some orders due to reasons such as the order already being completely filled or canceled before the request, or temporary market suspension (rebranding, etc).

Language