Cancel an order by client order id
curl --request DELETE \
--url https://api.example.com/api/orders \
--header 'Content-Type: application/json' \
--data '
{
"client_order_id": "ord-100"
}
'import requests
url = "https://api.example.com/api/orders"
payload = { "client_order_id": "ord-100" }
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({client_order_id: 'ord-100'})
};
fetch('https://api.example.com/api/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'client_order_id' => 'ord-100'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/orders"
payload := strings.NewReader("{\n \"client_order_id\": \"ord-100\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.example.com/api/orders")
.header("Content-Type", "application/json")
.body("{\n \"client_order_id\": \"ord-100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_order_id\": \"ord-100\"\n}"
response = http.request(request)
puts response.read_body{
"order_id": "698471892348",
"canceled_quantity": "15.00",
"total_filled_quantity": "10.00",
"cancel_reason": "USER_REQUEST"
}{
"error": "INVALID_FIELD",
"message": "side must be one of: BUY, SELL, BUY_NO, SELL_NO"
}Orders
Cancel an order by client order id
Cancels one of your active orders by client order ID. Requires TRADE permission.
DELETE
/
api
/
orders
Cancel an order by client order id
curl --request DELETE \
--url https://api.example.com/api/orders \
--header 'Content-Type: application/json' \
--data '
{
"client_order_id": "ord-100"
}
'import requests
url = "https://api.example.com/api/orders"
payload = { "client_order_id": "ord-100" }
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({client_order_id: 'ord-100'})
};
fetch('https://api.example.com/api/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'client_order_id' => 'ord-100'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/orders"
payload := strings.NewReader("{\n \"client_order_id\": \"ord-100\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.example.com/api/orders")
.header("Content-Type", "application/json")
.body("{\n \"client_order_id\": \"ord-100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_order_id\": \"ord-100\"\n}"
response = http.request(request)
puts response.read_body{
"order_id": "698471892348",
"canceled_quantity": "15.00",
"total_filled_quantity": "10.00",
"cancel_reason": "USER_REQUEST"
}{
"error": "INVALID_FIELD",
"message": "side must be one of: BUY, SELL, BUY_NO, SELL_NO"
}Body
application/json
Client order id of your active order to cancel.
Example:
"ord-100"
Response
Order canceled
Id of the canceled order, as a canonical decimal string.
Example:
"698471892348"
Quantity removed from the book by the cancel, in contracts, as a decimal string.
Example:
"15.00"
Total quantity the order filled before it was canceled, in contracts, as a decimal string.
Example:
"10.00"
Why the order was canceled, for example USER_REQUEST.
Example:
"USER_REQUEST"
Was this page helpful?