---
title: "List crypto address book entries"
method: GET
path: "/v3/address-book/crypto"
tags: ["Crypto Address Book"]
---

# List crypto address book entries

`GET /v3/address-book/crypto`

## Request

- Base URL: `https://confirmo.net/api`
- URL: `https://confirmo.net/api/v3/address-book/crypto`
- Auth: HTTP bearer

Returns the authenticated merchant's crypto address book, newest first, in a paginated envelope. Optionally narrowed by status, hosting type, network, designation, address and creation date; the total in the envelope counts the filtered set. Deleted (retired) entries are included, with status DELETED, unless the statuses filter leaves them out.

## Query parameters

- `statuses` string[]
- `hostingType` 'SELF_HOSTED' | 'VASP'
- `networkId` 'ARC-BLOCKCHAIN-MAINNET' | 'BITCOIN-BLOCKCHAIN-MAINNET' | 'BITCOIN-LIGHTNING-MAINNET' | 'BSC-BLOCKCHAIN-MAINNET' | 'ETHEREUM-ARBITRUM-ONE-MAINNET' | 'ETHEREUM-BLOCKCHAIN-MAINNET' | 'ETHEREUM-OPTIMISM-MAINNET' | 'PLASMA-BLOCKCHAIN-MAINNET' | 'ETHEREUM-POLYGON-MAINNET' | 'LITECOIN-BLOCKCHAIN-MAINNET' | 'SOLANA-BLOCKCHAIN-MAINNET' | 'TRON-BLOCKCHAIN-MAINNET'
- `designations` string[]
- `address` string
- `createdAtFrom` integer
- `createdAtTo` integer
- `limit` integer
- `offset` integer

## Response `200`

Crypto address book entries returned successfully

- DataPageToCryptoAddressBookEntry
  - `data` union[]: The collection of items.
    - union
      - SelfHostedAddressBookEntry: An address book entry for a self-hosted wallet.
        - `address` string, required
        - `createdAt` integer
        - `designations` string[]
        - `hostingType` 'SELF_HOSTED' | 'VASP'
        - `id` string
        - `label` string
        - `networkId` string
        - `notifyOptions` CryptoAddressBookEntryNotifyOptions, required
          - `email` string, email
          - `url` string, uri
        - `status` 'PENDING' | 'ACTIVE' | 'REJECTED' | 'EXPIRED' | 'DELETED'
        - `updatedAt` integer
      - VaspAddressBookEntry: An address book entry for an account held at an exchange (a Virtual Asset Service Provider). Identified by its exchange account rather than by an address, because exchange deposit addresses rotate.
        - `address` string
        - `createdAt` integer
        - `designations` string[]
        - `hostingType` 'SELF_HOSTED' | 'VASP'
        - `id` string
        - `label` string
        - `networkId` string
        - `notifyOptions` CryptoAddressBookEntryNotifyOptions, required
          - `email` string, email
          - `url` string, uri
        - `status` 'PENDING' | 'ACTIVE' | 'REJECTED' | 'EXPIRED' | 'DELETED'
        - `updatedAt` integer
        - `vasp` VaspAddressBookEntryVasp, required: The merchant's account at an exchange: which exchange, and who the merchant is there.
          - `accountUsername` string, required
          - `identifier` string, required
  - `limit` integer: The number of returned items.
  - `offset` integer: The number of skipped items.
  - `order` string: The sort column and the order of returned items.
  - `query` string: The searched string in items.
  - `totalCount` integer: The total number of items owned by the merchant.

## Other responses

- `400`: Invalid filter or pagination, or the address book feature is disabled
- `403`: No authenticated merchant in the request context
- `409`: Conflict

---

[API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)