private/get_address_book

Retrieves the address book entries of the given type. Returns all saved addresses that can be used for withdrawals, along with their labels and beneficiary information if available.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_address_book \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 31,
  "method": "private/get_address_book",
  "params": {
    "currency": "BTC",
    "type": "withdrawal"
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/get_address_book"

payload = {
    "jsonrpc": "2.0",
    "id": 31,
    "method": "private/get_address_book",
    "params": {
        "currency": "BTC",
        "type": "withdrawal"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 31,
    method: 'private/get_address_book',
    params: {currency: 'BTC', type: 'withdrawal'}
  })
};

fetch('https://test.deribit.com/api/v2/private/get_address_book', 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://test.deribit.com/api/v2/private/get_address_book",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 31,
    'method' => 'private/get_address_book',
    'params' => [
        'currency' => 'BTC',
        'type' => 'withdrawal'
    ]
  ]),
  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://test.deribit.com/api/v2/private/get_address_book"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 31,\n  \"method\": \"private/get_address_book\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"type\": \"withdrawal\"\n  }\n}")

	req, _ := http.NewRequest("GET", 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.get("https://test.deribit.com/api/v2/private/get_address_book")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 31,\n  \"method\": \"private/get_address_book\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"type\": \"withdrawal\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/get_address_book")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 31,\n  \"method\": \"private/get_address_book\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"type\": \"withdrawal\"\n  }\n}"

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

200

{
  "jsonrpc": "2.0",
  "id": 31,
  "result": [
    {
      "waiting_timestamp": 1720252232860,
      "creation_timestamp": 1719993033041,
      "requires_confirmation_change": false,
      "personal": true,
      "info_required": false,
      "beneficiary_first_name": "John",
      "beneficiary_last_name": "Doe",
      "beneficiary_address": "NL, Amsterdam, Street, 1",
      "requires_confirmation": true,
      "currency": "BTC",
      "agreed": true,
      "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz",
      "type": "withdrawal",
      "status": "waiting",
      "label": "Main Address"
    },
    {
      "waiting_timestamp": 1720252232760,
      "creation_timestamp": 1719993032041,
      "requires_confirmation_change": false,
      "personal": true,
      "info_required": false,
      "beneficiary_company_name": "MyCompany",
      "beneficiary_address": "NL, Haarlem, Street, 5",
      "requires_confirmation": false,
      "currency": "BTC",
      "agreed": true,
      "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
      "type": "withdrawal",
      "status": "waiting",
      "label": "One More Address"
    }
  ]
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, STETH, ETHW, USDC, USDT, EURR, SOL, XRP, USYC, PAXG, BNB, USDE

type · enum<string> · required

Address book type

Available options: transfer, withdrawal, deposit_source

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. currency · enum<string> · required

Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, STETH, ETHW, USDC, USDT, EURR, SOL, XRP, USYC, PAXG, BNB, USDE

result. address · string · required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result. creation_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. type · enum<string>

Address book type

Available options: transfer, withdrawal, deposit_source

result. label · string

Label of the address book entry

Example:

"Main address"

result. beneficiary_vasp_name · string

Name of beneficiary VASP

Example:

"Money's Gone"

result. beneficiary_vasp_did · string

DID of beneficiary VASP

Example:

"did:example:123456789abcdefghi"

result. beneficiary_vasp_website · string

Website of the beneficiary VASP

result. beneficiary_first_name · string

First name of the beneficiary (if beneficiary is a person)

Example:

"John"

result. beneficiary_last_name · string

Last name of the beneficiary (if beneficiary is a person)

Example:

"Doe"

result. beneficiary_company_name · string

Company name of the beneficiary (if beneficiary is a company)

Example:

"Company Name"

result. beneficiary_address · string

Geographical address of the beneficiary

Example:

"NL, Amsterdam, Street, 1"

result. agreed · boolean

Indicates that the user agreed to shared provided information with 3rd parties

Example:

true

result. personal · boolean

The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software

Example:

true

result. info_required · boolean

Signalises that addition information regarding the beneficiary of the address is required

Example:

true

result. status · enum<string>

Wallet address status, values: [admin_locked, waiting, confirmed, ready]

Available options: admin_locked, waiting, confirmed, ready

result. waiting_timestamp · boolean

Timestamp when the address will be ready

Example:

true

result. requires_confirmation · boolean

If address requires email confirmation for withdrawals

Example:

true

result. requires_confirmation_change · boolean

If email confirmation change is in progress

Example:

true

id · integer

The id that was sent in the request