---
title: "Get Crypto Addresses"
method: GET
path: "/crypto-addresses"
tags: ["address-book"]
---

# Get Crypto Addresses

`GET /crypto-addresses`

## Request

- Base URL: `https://api.copper.co/platform`
- URL: `https://api.copper.co/platform/crypto-addresses`
- Auth: none declared
- TypeScript: <https://skmtc.dev/copper-co/apis/copper-platform-api/docs/crypto-addresses/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve information about crypto addresses in an organization's address book

## Query parameters

- `cryptoAddressIds` string[]
- `currencies` string[]
- `mainCurrencies` string[]
- `addressTags` AddressTag[]
- `addresses` string[]
- `memo` string
- `limit` string
- `offset` string
- `isWhitelist` boolean
- `addressTypes` AddressType[]

## Response `200`

OK

- CryptoAddresses
  - `cryptoAddresses` CryptoAddress[], required: List of crypto addresses
    - `_embedded` CryptoAddressEmbedded
      - `currencyConfigurations` CurrencyConfiguration[]: Crypto address currency configuration
        - `createdAt` string, required: Created at timestamp
        - `createdBy` string, required: Created by user id
        - `cryptoAddressId` string, required: Crypto address id
        - `currency` string, required: Currency of an address
        - `currencyConfigurationId` string, required: Currency configuration id
        - `extra` CurrencyConfigurationExtra
        - `isWhitelist` boolean, required: Indicates, if an address is whitelisted
        - `lastUsedAt` string: Last used at
        - `portfolioIds` string[]: Portfolio ids, if address set for particular portfolios
        - `updatedAt` string: Last updated Updated at timestamp
        - `updatedBy` string: Updated by user id
    - `acceptTokens` boolean: Indicates an address can be used for tokens on the same blockchain network
    - `address` string, required: Address
    - `addressTags` AddressTag[]: Address tags
    - `addressType` 'externally-owned-account' | 'internal-account' | 'smart-contract' | 'payable-smart-contract', required
    - `category` 'smart-contract' | 'payable-smart-contract' | 'mining' | 'unknown' | 'self-hosted' | 'vasp'
    - `createdAt` string, required: Created at timestamp
    - `createdBy` string, required: Created by user id
    - `cryptoAddressId` string, required: Crypto address id
    - `currency` string, required: Currency of an address
    - `extra` CryptoAddressExtra
    - `isWhitelist` boolean, required: Indicates, if an address is whitelisted
    - `lastUsedAt` string: Last used at
    - `mainCurrency` string: Main currency of an address
    - `memo` string: Address memo (destination tag for XRP)
    - `name` string, required: Name of an address
    - `organizationId` string: Organization id
    - `portfolioIds` string[]: Portfolio ids, if address set for particular portfolios
    - `updatedAt` string: Last updated Updated at timestamp
    - `updatedBy` string: Updated by user id

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `409`: Conflict

---

[API](https://skmtc.dev/copper-co/apis/copper-platform-api.md) - [All operations](https://skmtc.dev/copper-co/apis/copper-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/copper-co/apis/copper-platform-api/revisions/44296120fc7d?raw)