Wallet
Private

Changed on

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.

Coinbase wallet type

For Coinbase wallet type accounts currency accepts any portfolio currency or "all", and type accepts withdrawal, transfer or deposit (deposit addresses created via private/create_deposit_address). The returned entries are Coinbase address book entry objects: they include the entry id (usable instead of address in the other address book methods), kind (onchain or ctn), network, network_display_name, tag and the Coinbase travel rule fields (name, country, financial_institution, account, account_location, entity_type, wallet_type, is_self) when set.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

get/private/get_address_book

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/get_address_book
  • Auth
    none declared

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

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

The currency symbol. Legacy wallet type: wallet currencies only. Coinbase wallet type: any portfolio currency or "all".

type'transfer' | 'withdrawal' | 'deposit_source' | 'deposit' required

Address book type. deposit_source is legacy wallet type only; deposit is Coinbase wallet type only.

Address book type. Legacy wallet type: withdrawal, transfer or deposit_source. Coinbase wallet type: withdrawal, transfer or deposit.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "creation_timestamp": 1536569522277,
      "label": "Main address",
      "beneficiary_vasp_name": "Money's Gone",
      "beneficiary_vasp_did": "did:example:123456789abcdefghi",
      "beneficiary_first_name": "John",
      "beneficiary_last_name": "Doe",
      "beneficiary_company_name": "Company Name",
      "beneficiary_address": "NL, Amsterdam, Street, 1",
      "agreed": true,
      "personal": true,
      "info_required": true,
      "waiting_timestamp": true,
      "requires_confirmation": true,
      "requires_confirmation_change": true
    }
  ]
}

Changes

  • f1c92835a183Revision changes
    • breaking

      removed the enum value BNB from the query request parameter currency

    • breaking

      removed the enum value ETHW from the query request parameter currency

    • breaking

      removed the enum value PAXG from the query request parameter currency

    • breaking

      removed the enum value SOL from the query request parameter currency

    • breaking

      removed the enum value STETH from the query request parameter currency

    • breaking

      removed the enum value USDE from the query request parameter currency

    • breaking

      removed the enum value USYC from the query request parameter currency

    • breaking

      removed the enum value XRP from the query request parameter currency

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new enum value deposit to the query request parameter type