RFQ
private/cancel_block_proposal
Ends an open block proposal and returns it. When the maker calls it, the status becomes cancelled. When the recipient_wallet of the proposal calls it, the status becomes declined. Only an open proposal can be cancelled or declined. After a successful call, the proposal can never execute. Fails with block_proposal_not_found (11117) if no proposal has that id, or if the caller is neither its maker nor its recipient. Fails with block_proposal_not_open (11118) if the proposal is not open, for example because it has executed or an accept is in progress. Requires the block_trade off-chain scope.
POST
/
private
/
cancel_block_proposal
private/cancel_block_proposal
curl --request POST \
--url https://api.derive.xyz/v3/private/cancel_block_proposal \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet": "<string>"
}
'import requests
url = "https://api.derive.xyz/v3/private/cancel_block_proposal"
payload = {
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet": "<string>"
}
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({proposal_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', wallet: '<string>'})
};
fetch('https://api.derive.xyz/v3/private/cancel_block_proposal', 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_block_proposal",
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([
'proposal_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'wallet' => '<string>'
]),
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_block_proposal"
payload := strings.NewReader("{\n \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\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_block_proposal")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/cancel_block_proposal")
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 \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"block_trade_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creation_timestamp": 123,
"currency": "<string>",
"direction": "buy",
"expires_at_sec": 123,
"last_update_timestamp": 123,
"legs": [
{
"amount": "<string>",
"direction": "buy",
"instrument_name": "<string>",
"price": "<string>"
}
],
"listed": true,
"maker_wallet": "<string>",
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk_universe_id": 1,
"status": "open",
"recipient_wallet": "<string>"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Authorizations
Body
application/json
Response
Success
A block proposal as its maker and its recipient see it.
private/cancel_block_proposal
curl --request POST \
--url https://api.derive.xyz/v3/private/cancel_block_proposal \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet": "<string>"
}
'import requests
url = "https://api.derive.xyz/v3/private/cancel_block_proposal"
payload = {
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet": "<string>"
}
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({proposal_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', wallet: '<string>'})
};
fetch('https://api.derive.xyz/v3/private/cancel_block_proposal', 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_block_proposal",
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([
'proposal_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'wallet' => '<string>'
]),
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_block_proposal"
payload := strings.NewReader("{\n \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\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_block_proposal")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/cancel_block_proposal")
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 \"proposal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"wallet\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"block_trade_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creation_timestamp": 123,
"currency": "<string>",
"direction": "buy",
"expires_at_sec": 123,
"last_update_timestamp": 123,
"legs": [
{
"amount": "<string>",
"direction": "buy",
"instrument_name": "<string>",
"price": "<string>"
}
],
"listed": true,
"maker_wallet": "<string>",
"proposal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk_universe_id": 1,
"status": "open",
"recipient_wallet": "<string>"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}