private/cancel_algo_order
Cancels a single active algo order identified by order_id and subaccount_id, stopping any further child-order execution. Requires any trade scope; returns the cancelled order.
curl --request POST \
--url https://api.derive.xyz/v3/private/cancel_algo_order \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subaccount_id": 123
}
'import requests
url = "https://api.derive.xyz/v3/private/cancel_algo_order"
payload = {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subaccount_id": 123
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', subaccount_id: 123})
};
fetch('https://api.derive.xyz/v3/private/cancel_algo_order', 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.derive.xyz/v3/private/cancel_algo_order",
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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subaccount_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <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://api.derive.xyz/v3/private/cancel_algo_order"
payload := strings.NewReader("{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<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://api.derive.xyz/v3/private/cancel_algo_order")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/cancel_algo_order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"amount": "<string>",
"average_price": "<string>",
"creation_timestamp": 123,
"direction": "buy",
"extra_fee": "<string>",
"filled_amount": "<string>",
"instrument_name": "<string>",
"is_transfer": true,
"last_update_timestamp": 123,
"limit_price": "<string>",
"max_fee": "<string>",
"mmp": true,
"nonce": "<string>",
"order_fee": "<string>",
"order_id": "<string>",
"order_status": "open",
"order_type": "limit",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature": "<string>",
"signature_expiry_sec": 123,
"signed_limit_price": "<string>",
"signer": "<string>",
"subaccount_id": 123,
"time_in_force": "gtc",
"trigger_price": "<string>",
"algo_duration_sec": 123,
"algo_num_slices": 123,
"algo_slices_completed": 123,
"algo_type": "twap",
"cancel_reason": "",
"label": "",
"trigger_price_type": "mark",
"trigger_reject_message": "<string>",
"trigger_type": "stoploss"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Authorizations
The wallet the request acts for.
The current time in milliseconds, as a decimal string.
EIP-191 signature of the timestamp, by the wallet or one of its session keys.
Response
Success
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
buy, sell Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
open, filled, rejected, cancelled, expired, untriggered, algo_active limit, market Optional UUID v4 string
Optional UUID v4 string
Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted
gtc, post_only, fok, ioc Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted
twap , user_request, mmp_trigger, insufficient_margin, signed_max_fee_too_low, cancel_on_disconnect, ioc_or_market_partial_fill, session_key_deregistered, subaccount_withdrawn, compliance, trigger_failed, validation_failed, algo_completed, max_crossed_orders mark, index stoploss, takeprofit curl --request POST \
--url https://api.derive.xyz/v3/private/cancel_algo_order \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subaccount_id": 123
}
'import requests
url = "https://api.derive.xyz/v3/private/cancel_algo_order"
payload = {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subaccount_id": 123
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', subaccount_id: 123})
};
fetch('https://api.derive.xyz/v3/private/cancel_algo_order', 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.derive.xyz/v3/private/cancel_algo_order",
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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subaccount_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <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://api.derive.xyz/v3/private/cancel_algo_order"
payload := strings.NewReader("{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<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://api.derive.xyz/v3/private/cancel_algo_order")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/cancel_algo_order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subaccount_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"amount": "<string>",
"average_price": "<string>",
"creation_timestamp": 123,
"direction": "buy",
"extra_fee": "<string>",
"filled_amount": "<string>",
"instrument_name": "<string>",
"is_transfer": true,
"last_update_timestamp": 123,
"limit_price": "<string>",
"max_fee": "<string>",
"mmp": true,
"nonce": "<string>",
"order_fee": "<string>",
"order_id": "<string>",
"order_status": "open",
"order_type": "limit",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature": "<string>",
"signature_expiry_sec": 123,
"signed_limit_price": "<string>",
"signer": "<string>",
"subaccount_id": 123,
"time_in_force": "gtc",
"trigger_price": "<string>",
"algo_duration_sec": 123,
"algo_num_slices": 123,
"algo_slices_completed": 123,
"algo_type": "twap",
"cancel_reason": "",
"label": "",
"trigger_price_type": "mark",
"trigger_reject_message": "<string>",
"trigger_type": "stoploss"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}