---
title: "GET /private/get_address_book"
method: GET
path: "/private/get_address_book"
tags: ["Wallet", "Private"]
---

# GET /private/get_address_book

`GET /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](https://docs.deribit.com/articles/managing-withdrawals-api)

**Scope:** `wallet:read`

[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_address_book)

## Query parameters

- `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
- `type` 'transfer' | 'withdrawal' | 'deposit_source', required — Address book type

## Response `200`

Success response

- PrivateAddressBookResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` AddressBookItem[], required
    - `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
    - `address` string, required — Address in proper format for currency
    - `creation_timestamp` integer, required — The timestamp (milliseconds since the Unix epoch)
    - `type` 'transfer' | 'withdrawal' | 'deposit_source' — Address book type
    - `label` string — Label of the address book entry
    - `beneficiary_vasp_name` string — Name of beneficiary VASP
    - `beneficiary_vasp_did` string — DID of beneficiary VASP
    - `beneficiary_vasp_website` string — Website of the beneficiary VASP
    - `beneficiary_first_name` string — First name of the beneficiary (if beneficiary is a person)
    - `beneficiary_last_name` string — Last name of the beneficiary (if beneficiary is a person)
    - `beneficiary_company_name` string — Company name of the beneficiary (if beneficiary is a company)
    - `beneficiary_address` string — Geographical address of the beneficiary
    - `agreed` boolean — Indicates that the user agreed to shared provided information with 3rd parties
    - `personal` boolean — The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
    - `info_required` boolean — Signalises that addition information regarding the beneficiary of the address is required
    - `status` 'admin_locked' | 'waiting' | 'confirmed' | 'ready' — Wallet address status, values: [`admin_locked`, `waiting`, `confirmed`, `ready`]
    - `waiting_timestamp` boolean — Timestamp when the address will be ready
    - `requires_confirmation` boolean — If address requires email confirmation for withdrawals
    - `requires_confirmation_change` boolean — If email confirmation change is in progress

---

[API](https://skmtc.net/deribit/apis/deribit-api.md) · [All operations](https://skmtc.net/deribit/apis/deribit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/deribit/deribit-api/revisions/c254e4a8a23c/schema)