Wallet
Private

Changed on

Removes an entry from the address book. This method allows you to delete a saved address that is no longer needed.

Coinbase wallet type

For Coinbase wallet type accounts the required parameters are currency (portfolio currencies or "all") and type, plus one of address or id (the entry identifier returned by private/get_address_book). Use network and tag together with address to disambiguate entries sharing the same address.

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write

Try in API console

get/private/remove_from_address_book

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/remove_from_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' required

Address book type

addressstring

Address in proper format for currency

Example:1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Address in currency format, it must be in address book. Required for legacy wallet type. Coinbase wallet type: required when id is not provided; use network and tag to disambiguate entries sharing the same address.

networkstring
Example:networks/ethereum-mainnet

Blockchain network for the wallet operation, given as a network resource name (e.g. "networks/ethereum-mainnet"). Coinbase wallet type only. The networks available for each currency are returned by public/get_currencies in the coinbase_networks field. Required for operations that target an on-chain address or a deposit address; also used to disambiguate address book entries when the same address exists on multiple networks.

tagstring

Destination tag / memo for networks that support one. Coinbase wallet type only. Used together with address and network; also serves to disambiguate address book entries that share the same address.

idstring
Example:0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b

Unique identifier (UUID7) of the address book entry, as returned in the id field of private/get_address_book results. Coinbase wallet type only. Can be used instead of address (with network and tag) to identify the entry.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

resultstring required

ok

Example response

{
  "result": "ok"
}

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

      removed the enum value deposit_source from the query request parameter type

    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter network

    • info

      added the new optional query request parameter tag

    • info

      the query request parameter address became optional