Skip to main content
POST
/
v1
/
withdraw_request
Create withdraw request
curl --request POST \
  --url https://api.orderly.org/v1/withdraw_request \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "signature": "<string>",
  "userAddress": "<string>",
  "verifyingContract": "<string>",
  "message": {
    "brokerId": "<string>",
    "chainId": 123,
    "receiver": "<string>",
    "token": "<string>",
    "amount": "<string>",
    "withdrawNonce": "<string>",
    "timestamp": "<string>",
    "chainType": "<string>",
    "allowCrossChainWithdraw": true
  }
}
'
import requests

url = "https://api.orderly.org/v1/withdraw_request"

payload = {
"signature": "<string>",
"userAddress": "<string>",
"verifyingContract": "<string>",
"message": {
"brokerId": "<string>",
"chainId": 123,
"receiver": "<string>",
"token": "<string>",
"amount": "<string>",
"withdrawNonce": "<string>",
"timestamp": "<string>",
"chainType": "<string>",
"allowCrossChainWithdraw": True
}
}
headers = {
"orderly-timestamp": "<orderly-timestamp>",
"orderly-account-id": "<orderly-account-id>",
"orderly-key": "<orderly-key>",
"orderly-signature": "<orderly-signature>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'orderly-timestamp': '<orderly-timestamp>',
'orderly-account-id': '<orderly-account-id>',
'orderly-key': '<orderly-key>',
'orderly-signature': '<orderly-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
signature: '<string>',
userAddress: '<string>',
verifyingContract: '<string>',
message: {
brokerId: '<string>',
chainId: 123,
receiver: '<string>',
token: '<string>',
amount: '<string>',
withdrawNonce: '<string>',
timestamp: '<string>',
chainType: '<string>',
allowCrossChainWithdraw: true
}
})
};

fetch('https://api.orderly.org/v1/withdraw_request', 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/withdraw_request",
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([
'signature' => '<string>',
'userAddress' => '<string>',
'verifyingContract' => '<string>',
'message' => [
'brokerId' => '<string>',
'chainId' => 123,
'receiver' => '<string>',
'token' => '<string>',
'amount' => '<string>',
'withdrawNonce' => '<string>',
'timestamp' => '<string>',
'chainType' => '<string>',
'allowCrossChainWithdraw' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.orderly.org/v1/withdraw_request"

payload := strings.NewReader("{\n \"signature\": \"<string>\",\n \"userAddress\": \"<string>\",\n \"verifyingContract\": \"<string>\",\n \"message\": {\n \"brokerId\": \"<string>\",\n \"chainId\": 123,\n \"receiver\": \"<string>\",\n \"token\": \"<string>\",\n \"amount\": \"<string>\",\n \"withdrawNonce\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"chainType\": \"<string>\",\n \"allowCrossChainWithdraw\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

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>")
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.orderly.org/v1/withdraw_request")
.header("orderly-timestamp", "<orderly-timestamp>")
.header("orderly-account-id", "<orderly-account-id>")
.header("orderly-key", "<orderly-key>")
.header("orderly-signature", "<orderly-signature>")
.header("Content-Type", "application/json")
.body("{\n \"signature\": \"<string>\",\n \"userAddress\": \"<string>\",\n \"verifyingContract\": \"<string>\",\n \"message\": {\n \"brokerId\": \"<string>\",\n \"chainId\": 123,\n \"receiver\": \"<string>\",\n \"token\": \"<string>\",\n \"amount\": \"<string>\",\n \"withdrawNonce\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"chainType\": \"<string>\",\n \"allowCrossChainWithdraw\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/withdraw_request")

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

request = Net::HTTP::Post.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"signature\": \"<string>\",\n \"userAddress\": \"<string>\",\n \"verifyingContract\": \"<string>\",\n \"message\": {\n \"brokerId\": \"<string>\",\n \"chainId\": 123,\n \"receiver\": \"<string>\",\n \"token\": \"<string>\",\n \"amount\": \"<string>\",\n \"withdrawNonce\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"chainType\": \"<string>\",\n \"allowCrossChainWithdraw\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "withdraw_id": 123
  },
  "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.

Body

application/json
signature
string
required

The signature generated by signing the message object via EIP-712

userAddress
string
required

The address of the wallet signing the message object via EIP-712

verifyingContract
string
required

Contract address used to verify the wallet signature.

message
object
required

Message object signed by the wallet owner.

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