Wallet

List crypto withdrawal addresses

Returns saved crypto withdrawal addresses for the authenticated account.

The id of each entry can be passed as address_book_id when submitting a crypto withdrawal.

Requires the deposit permission on the API key.

get/wallet/address-book

Query parameters

currencystring

Filter by currency code.

limitinteger

Number of records to return.

cursorstring

Opaque pagination cursor returned in a previous response meta.next_cursor.

Response

Address book returned successfully.

Example response

{
  "data": [
    {
      "id": "addr-001",
      "currency": "BTC",
      "network": "BTC",
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "label": "My cold wallet",
      "status": "crypto_address_status_active",
      "created_at": 1712000000,
      "updated_at": 1712000000
    }
  ],
  "meta": {
    "total": 3
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.