Skip to main content
DELETE
/
v1
/
batch-order
Batch cancel orders
curl --request DELETE \
  --url https://api.orderly.org/v1/batch-order \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
import requests

url = "https://api.orderly.org/v1/batch-order"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {
  method: 'DELETE',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/batch-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.orderly.org/v1/batch-order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orderly.org/v1/batch-order"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

	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.orderly.org/v1/batch-order")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/batch-order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "status": "CANCEL_ALL_SENT"
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

orderly-account-id
string
required

Account ID of the authenticated account.

orderly-key
string
required

Public orderly key used to sign the request.

orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

order_ids
string
required

List of order_ids, comma-separated, with a maximum of 10 order ids per request.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

data
object
required
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989