private/list_address_beneficiaries

Lists address beneficiaries with optional filtering and pagination. Returns all saved beneficiary information for addresses, with support for filtering by currency, address, wallet type, VASP details, and date ranges.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

cURL

cURL

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

import requests

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

payload = {
    "jsonrpc": "2.0",
    "id": 42,
    "method": "private/list_address_beneficiaries",
    "params": {
        "currency": "BTC",
        "limit": 10
    }
}
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: 42,
    method: 'private/list_address_beneficiaries',
    params: {currency: 'BTC', limit: 10}
  })
};

fetch('https://test.deribit.com/api/v2/private/list_address_beneficiaries', 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/list_address_beneficiaries",
  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' => 42,
    'method' => 'private/list_address_beneficiaries',
    'params' => [
        'currency' => 'BTC',
        'limit' => 10
    ]
  ]),
  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/list_address_beneficiaries"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 42,\n  \"method\": \"private/list_address_beneficiaries\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"limit\": 10\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/list_address_beneficiaries")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 42,\n  \"method\": \"private/list_address_beneficiaries\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"limit\": 10\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 42,\n  \"method\": \"private/list_address_beneficiaries\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"limit\": 10\n  }\n}"

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

200

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "data": [
      {
        "currency": "BTC",
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
        "user_id": 1026,
        "agreed": true,
        "personal": false,
        "unhosted": false,
        "beneficiary_vasp_name": "Money's Gone",
        "beneficiary_vasp_did": "did:example:123456789abcdefghi",
        "beneficiary_vasp_website": "https://example.com",
        "beneficiary_first_name": "John",
        "beneficiary_last_name": "Doe",
        "beneficiary_company_name": "Example Corp",
        "beneficiary_address": "NL, Amsterdam, Street, 1",
        "created": 1536569522277,
        "updated": 1536569522277
      }
    ],
    "continuation": "xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT",
    "count": 1
  }
}

Query Parameters

currency · enum<string>

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

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

address · string

Address in currency format

tag · string

Tag for XRP addresses

created_before · integer

Filter by creation timestamp (before) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

created_after · integer

Filter by creation timestamp (after) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

updated_before · integer

Filter by update timestamp (before) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

updated_after · integer

Filter by update timestamp (after) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

personal · boolean

Filter by personal wallet flag

unhosted · boolean

Filter by unhosted wallet flag

beneficiary_vasp_name · string

Filter by beneficiary VASP name Name of beneficiary VASP

Example:

"Money's Gone"

beneficiary_vasp_did · string

Filter by beneficiary VASP DID DID of beneficiary VASP

Example:

"did:example:123456789abcdefghi"

beneficiary_vasp_website · string

Website of the beneficiary VASP

limit · integer · default: 100

Maximum number of results to return

Required range: 1 <= x <= 1000

continuation · string

Continuation token for pagination

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

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. data · object[]

Hide child attributes

result.data. currency · enum<string> · required

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

Available options: BTC, ETH, USDC, USDT, EURR

result.data. address · string · required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result.data. user_id · integer · required

Unique user identifier

Example:

57874

result.data. agreed · boolean · required

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

Example:

true

result.data. personal · boolean · required

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.data. unhosted · boolean · required

Indicates if the address belongs to an unhosted wallet

Example:

false

result.data. beneficiary_vasp_name · string · required

Name of beneficiary VASP

Example:

"Money's Gone"

result.data. beneficiary_vasp_did · string · required

DID of beneficiary VASP

Example:

"did:example:123456789abcdefghi"

result.data. beneficiary_address · string · required

Geographical address of the beneficiary

Example:

"NL, Amsterdam, Street, 1"

result.data. created · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.data. updated · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.data. tag · string | null

Tag for XRP addresses (optional)

result.data. beneficiary_vasp_website · string

Website of the beneficiary VASP

result.data. beneficiary_first_name · string

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

Example:

"John"

result.data. beneficiary_last_name · string

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

Example:

"Doe"

result.data. beneficiary_company_name · string

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

Example:

"Company Name"

result. continuation · string

Continuation token for pagination.

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

result. count · integer

Total number of results available

Example:

42

id · integer

The id that was sent in the request