---
title: "Get Wallets"
method: GET
path: "/wallets"
tags: ["wallets"]
---

# Get Wallets

`GET /wallets`

## Request

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

When you perform a request without specifying any additional filters like `portfolioId` or `currency`, the method returns all wallets which have non-zero balances only.

## Query parameters

- `portfolioId` string
- `currencies` string[]
- `mainCurrency` string
- `portfolioTypes` PortfolioType[]
- `excludedPortfolioTypes` PortfolioType[]
- `nonEmpty` boolean
- `limit` string
- `offset` string

## Response `200`

OK

- Wallets
  - `wallets` Wallet[], required: List of wallets
    - `available` string: Available balance of a wallet
    - `balance` string: Total balance of a wallet, including reserved, but excluding the stakeBalance
    - `createdAt` string: Created at timestamp
    - `currency` string, required: Currency of a wallet
    - `extra` WalletExtra
      - `externalAccountId` string: Third-party identifier (ID of an external account)
    - `locked` string: Locked balance of a wallet for ClearLoop, including the funds delegated to all sub-accounts
    - `mainCurrency` string: Main currency (blockchain network) of a wallet
    - `organizationId` string: Organization id
    - `portfolioId` string, required: Portfolio id
    - `portfolioType` 'custody' | 'trading-vault' | 'trading' | 'external' | 'clearloop'
    - `reserve` string: Reserved balance of a wallet (e.g. for open orders)
    - `stakeBalance` string: The balance of funds that are locked in staking
    - `totalBalance` string: The overall balance of a wallet
    - `updatedAt` string: Last updated at timestamp
    - `walletId` string, required: Wallet 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)