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"
  }
}
'

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