GET
/
wallets
curl --request GET \
  --url https://api.copper.co/platform/wallets
{
  "wallets": [
    {
      "available": "<string>",
      "balance": "<string>",
      "createdAt": "<string>",
      "currency": "<string>",
      "extra": {
        "externalAccountId": "<string>"
      },
      "locked": "<string>",
      "mainCurrency": "<string>",
      "organizationId": "<string>",
      "portfolioId": "<string>",
      "portfolioType": "custody",
      "reserve": "<string>",
      "stakeBalance": "<string>",
      "totalBalance": "<string>",
      "updatedAt": "<string>",
      "walletId": "<string>"
    }
  ]
}

Query Parameters

​
portfolioId
string

Filter by portfolio id

​
currencies
string[]

Filter wallets by currency

​
mainCurrency
string

Filter wallets by main currency

​
portfolioTypes
enum<string>[]

Filter wallets by portfolio types. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
excludedPortfolioTypes
enum<string>[]

Exclude wallets by portfolio types. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
nonEmpty
boolean
default:false

Filter only wallets with non-zero balance

​
limit
string

Limit for pagination

​
offset
string

Offset for pagination

Response

200
application/json
OK
​
wallets
object[]
required

List of wallets