Cancel up to 20 orders by id
curl --request POST \
--url https://{host}/v1/portfolio/orders/cancel_batch \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '
{
"order_ids": [
"16777291",
"16777292"
]
}
'import requests
url = "https://{host}/v1/portfolio/orders/cancel_batch"
payload = { "order_ids": ["16777291", "16777292"] }
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({order_ids: ['16777291', '16777292']})
};
fetch('https://{host}/v1/portfolio/orders/cancel_batch', 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://{host}/v1/portfolio/orders/cancel_batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_ids' => [
'16777291',
'16777292'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"DX-ACCESS-KEY: <api-key>",
"DX-ACCESS-SIGNATURE: <api-key>",
"DX-ACCESS-TIMESTAMP: <api-key>"
],
]);
$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://{host}/v1/portfolio/orders/cancel_batch"
payload := strings.NewReader("{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("DX-ACCESS-KEY", "<api-key>")
req.Header.Add("DX-ACCESS-TIMESTAMP", "<api-key>")
req.Header.Add("DX-ACCESS-SIGNATURE", "<api-key>")
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.post("https://{host}/v1/portfolio/orders/cancel_batch")
.header("DX-ACCESS-KEY", "<api-key>")
.header("DX-ACCESS-TIMESTAMP", "<api-key>")
.header("DX-ACCESS-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/portfolio/orders/cancel_batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["DX-ACCESS-KEY"] = '<api-key>'
request["DX-ACCESS-TIMESTAMP"] = '<api-key>'
request["DX-ACCESS-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"status": "canceled",
"canceled_qty": 123,
"seq": "182390"
}
]
}{
"error": {
"code": "unknown_field",
"num": null,
"origin": "gateway",
"message": "unknown_field",
"details": null
}
}{
"error": {
"code": "unauthorized",
"num": null,
"origin": "gateway",
"message": "unauthorized",
"details": null
}
}{
"error": {
"code": "missing_scope",
"num": null,
"origin": "gateway",
"message": "missing_scope",
"details": null
}
}{
"error": {
"code": "rate_limited",
"num": null,
"origin": "gateway",
"message": "rate_limited",
"details": null
}
}{
"error": {
"code": "shed",
"num": null,
"origin": "gateway",
"message": "shed",
"details": null
}
}Cancel up to 20 orders by id
Fanned into independent CANCEL commands (api.md §6.10). The response
is per-item and index-aligned: each entry is either a cancel result
or an error object. Unknown / foreign / already-terminal ids settle
as unknown_order. Partial success is normal, not an error. Costs N
write tokens.
POST
/
v1
/
portfolio
/
orders
/
cancel_batch
Cancel up to 20 orders by id
curl --request POST \
--url https://{host}/v1/portfolio/orders/cancel_batch \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '
{
"order_ids": [
"16777291",
"16777292"
]
}
'import requests
url = "https://{host}/v1/portfolio/orders/cancel_batch"
payload = { "order_ids": ["16777291", "16777292"] }
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({order_ids: ['16777291', '16777292']})
};
fetch('https://{host}/v1/portfolio/orders/cancel_batch', 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://{host}/v1/portfolio/orders/cancel_batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_ids' => [
'16777291',
'16777292'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"DX-ACCESS-KEY: <api-key>",
"DX-ACCESS-SIGNATURE: <api-key>",
"DX-ACCESS-TIMESTAMP: <api-key>"
],
]);
$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://{host}/v1/portfolio/orders/cancel_batch"
payload := strings.NewReader("{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("DX-ACCESS-KEY", "<api-key>")
req.Header.Add("DX-ACCESS-TIMESTAMP", "<api-key>")
req.Header.Add("DX-ACCESS-SIGNATURE", "<api-key>")
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.post("https://{host}/v1/portfolio/orders/cancel_batch")
.header("DX-ACCESS-KEY", "<api-key>")
.header("DX-ACCESS-TIMESTAMP", "<api-key>")
.header("DX-ACCESS-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/portfolio/orders/cancel_batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["DX-ACCESS-KEY"] = '<api-key>'
request["DX-ACCESS-TIMESTAMP"] = '<api-key>'
request["DX-ACCESS-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_ids\": [\n \"16777291\",\n \"16777292\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"status": "canceled",
"canceled_qty": 123,
"seq": "182390"
}
]
}{
"error": {
"code": "unknown_field",
"num": null,
"origin": "gateway",
"message": "unknown_field",
"details": null
}
}{
"error": {
"code": "unauthorized",
"num": null,
"origin": "gateway",
"message": "unauthorized",
"details": null
}
}{
"error": {
"code": "missing_scope",
"num": null,
"origin": "gateway",
"message": "missing_scope",
"details": null
}
}{
"error": {
"code": "rate_limited",
"num": null,
"origin": "gateway",
"message": "rate_limited",
"details": null
}
}{
"error": {
"code": "shed",
"num": null,
"origin": "gateway",
"message": "shed",
"details": null
}
}Authorizations
The public API key (alphanumeric access_key string).
Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.
base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.
Body
application/json
Maximum array length:
20A u64-domain value rendered as a decimal string (api.md §1).
Pattern:
^[0-9]+$Response
Per-item, index-aligned results (api.md §6.10).
Aggregate cancel-batch body (api.md §6.10).
⌘I