Transfers & Withdrawals

Register a deterministic deposit address for a wallet

Returns the deterministic on-chain deposit address for a wallet and records it so incoming deposits are watched and credited. Pass the wallet and optionally an existing subaccount id; when creating a new subaccount (subaccount omitted or 0) a non-zero manager_id is required. Repeated calls return the same cached address and keep it alive, while new registrations are rate limited per rolling window; unused addresses are dropped after 7 days.

POST

public

register_deposit_address

curl --request POST \
  --url https://api.derive.xyz/v3/public/register_deposit_address \
  --header 'Content-Type: application/json' \
  --data '
{
  "wallet": "<string>",
  "manager_id": null,
  "subaccount_id": 0
}
'

import requests

url = "https://api.derive.xyz/v3/public/register_deposit_address"

payload = {
    "wallet": "<string>",
    "manager_id": None,
    "subaccount_id": 0
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({wallet: '<string>', manager_id: null, subaccount_id: 0})
};

fetch('https://api.derive.xyz/v3/public/register_deposit_address', 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/public/register_deposit_address",
  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([
    'wallet' => '<string>',
    'manager_id' => null,
    'subaccount_id' => 0
  ]),
  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://api.derive.xyz/v3/public/register_deposit_address"

	payload := strings.NewReader("{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}")

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/public/register_deposit_address")
  .header("Content-Type", "application/json")
  .body("{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/public/register_deposit_address")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}"

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

{
  "deposit_address": "<string>",
  "wallet": "<string>",
  "manager_id": 1,
  "subaccount_id": 123
}

Body

application/json

deposit_type

enum<string>

required

Which factory to register against. Required: the same (wallet, subaccount, manager) has a distinct escrow address per factory, so callers must always be explicit about which flow they want.

Available options:

slow,

fast

wallet

string

required

Wallet address to watch for deposits.

manager_id

integer<uint32> | null

Manager the deposit routes under. Required (non-zero) when creating a new subaccount (subaccount_id omitted or 0); must be 0 or omitted for an existing subaccount — it salts the deposit address, so a nonzero value would mint a distinct escrow for the same destination.

Required range: x >= 0

subaccount_id

integer<int64>

default:0

Response

Success

deposit_address

string

required

deposit_type

enum<string>

required

Which cex-style deposit factory an address/deposit belongs to. Slow credits the depositor's own subaccount on-chain; Fast pools every deposit into an admin-set subaccount and the real owner is credited off-chain from the factory's DepositProcessed events.

Available options:

slow,

fast

wallet

string

required

manager_id

integer<uint32> | null

Required range: x >= 0

subaccount_id

integer<int64> | null

Withdraw an asset from a subaccount to L1

Preview EIP-712 encoding for a withdrawal

⌘I

curl --request POST \
  --url https://api.derive.xyz/v3/public/register_deposit_address \
  --header 'Content-Type: application/json' \
  --data '
{
  "wallet": "<string>",
  "manager_id": null,
  "subaccount_id": 0
}
'

import requests

url = "https://api.derive.xyz/v3/public/register_deposit_address"

payload = {
    "wallet": "<string>",
    "manager_id": None,
    "subaccount_id": 0
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({wallet: '<string>', manager_id: null, subaccount_id: 0})
};

fetch('https://api.derive.xyz/v3/public/register_deposit_address', 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/public/register_deposit_address",
  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([
    'wallet' => '<string>',
    'manager_id' => null,
    'subaccount_id' => 0
  ]),
  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://api.derive.xyz/v3/public/register_deposit_address"

	payload := strings.NewReader("{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}")

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/public/register_deposit_address")
  .header("Content-Type", "application/json")
  .body("{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/public/register_deposit_address")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"wallet\": \"<string>\",\n  \"manager_id\": null,\n  \"subaccount_id\": 0\n}"

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

{
  "deposit_address": "<string>",
  "wallet": "<string>",
  "manager_id": 1,
  "subaccount_id": 123
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

Register a deterministic deposit address for a wallet

Body

Response