Cancel Order

POST 
/private/CancelOrder

Cancel a particular open order (or set of open orders) by txid, userref or cl_ord_id

API Key Permissions Required: Orders and trades - Create & modify orders or Orders and trades - Cancel & close orders

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

txid object

Open order transaction ID (txid) or user reference (userref)

oneOf

string

string

integer

integer

cl_ord_id string

An alphanumeric client order identifier which uniquely identifies an open order for each client.

Responses

200

Open order cancelled.

application/json

Schema

Schema

result object

count int32

Number of orders cancelled

pending boolean

If true, orders are pending cancellation

error array[]

Example (from schema)

{
  "error": [],
  "result": {
    "count": 1
  }
}

Loading...