Cancel single order

xo-orderbook-client-rs

// Requires an authenticated client (see POST /order for setup).
let resp = client
    .cancel_order("0x0011223344556677889900aabbccddeeff00112233445566778899aabbccddee")
    .await?;
println!("canceled: {:?}, not canceled: {:?}", resp.canceled, resp.not_canceled);

import requests

url = "https://orderbooks.xo.market/order"

payload = { "orderID": "42" }
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({orderID: '42'})
};

fetch('https://orderbooks.xo.market/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://orderbooks.xo.market/order",
  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([
    'orderID' => '42'
  ]),
  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://orderbooks.xo.market/order"

	payload := strings.NewReader("{\n  \"orderID\": \"42\"\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))

}

require 'uri'
require 'net/http'

url = URI("https://orderbooks.xo.market/order")

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  \"orderID\": \"42\"\n}"

response = http.request(request)
puts response.read_body

{
  "canceled": [
    "42"
  ],
  "notCanceled": {}
}

DELETE

order

xo-orderbook-client-rs

// Requires an authenticated client (see POST /order for setup).
let resp = client
    .cancel_order("0x0011223344556677889900aabbccddeeff00112233445566778899aabbccddee")
    .await?;
println!("canceled: {:?}, not canceled: {:?}", resp.canceled, resp.not_canceled);

import requests

url = "https://orderbooks.xo.market/order"

payload = { "orderID": "42" }
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({orderID: '42'})
};

fetch('https://orderbooks.xo.market/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://orderbooks.xo.market/order",
  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([
    'orderID' => '42'
  ]),
  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://orderbooks.xo.market/order"

	payload := strings.NewReader("{\n  \"orderID\": \"42\"\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))

}

require 'uri'
require 'net/http'

url = URI("https://orderbooks.xo.market/order")

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  \"orderID\": \"42\"\n}"

response = http.request(request)
puts response.read_body

{
  "canceled": [
    "42"
  ],
  "notCanceled": {}
}

Body

application/json

orderId

integer<int64>

required

marketId

string

required

signature

string

required

EIP-712 sig over CancelOrder(orderId, marketId)

signatureType

enum<integer>

required

0 = EOA, 3 = EIP-1271 smart wallet

Available options:

0,

3

signer

string

Required when signatureType = 3

Response

Wire shape uses camelCase (canceled / notCanceled) per the CLOB SDK contract. American spelling — one l (NOT cancelled). Shared by DELETE /order, DELETE /orders, DELETE /cancel-all, DELETE /cancel-market-orders.

canceled

string[]

required

Order ids that were successfully cancelled, decimal strings.

notCanceled

object

required

Map of <order_id> → <reason> for orders that could not be cancelled. Common reasons: "already filled", "not found", "not owner".

Show child attributes

Overview

Authentication

Market Data

Markets

Trade

Account

WebSockets

Market Data

Markets

Trade

Account

Authentication

Body

Response