Skip to main content
GET
List wallets

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

limit
integer<int32>
cursor
string

Opaque cursor from nextCursor on the previous page.

customerId
string

Scope to a customer. cst_ prefix.

type
enum<string>

Filter by wallet type: custodial and fiat return rows whose type is walletCrypto and walletFiat. An empty value is treated as omitted. noncustodial currently returns an empty list. Public wallet variants accepted by the top-level wallet list filter.

Available options:
custodial,
noncustodial,
fiat

Free-text search. Matches wallet id or on-chain address.

q
string

Alias for search.

orderBy
enum<string>

Order by available balance's estimated USD value.

Available options:
balance
order
enum<string>

Balance sort direction. Defaults to desc; requires orderBy=balance.

Available options:
asc,
desc
includeHidden
enum<string>[]

claimed adds wallets that a live deposit address or virtual account currently claims, which the default page leaves out. It also includes custodial wallets the default page leaves out for address reuse. Omitting this param leaves default behavior unchanged.

Values GET /wallets' includeHidden param accepts. claimed widens the default page to include wallets a live deposit address or virtual account currently claims. Omitting the param leaves default listing behavior unchanged. Deleted wallets are never listed.

Available options:
claimed

Response

200 - application/json

The request has succeeded.

Canonical paginated envelope for the top-level wallet list.

object
enum<string>
required
Available options:
list
data
(Crypto wallet · object | Fiat wallet · object)[]
required

The walletCrypto variant — one crypto asset on one network, held on the customer's behalf by the custody provider, currently "Coinme Inc.". address is the on-chain deposit address and is omitted until the provider reports one.

hasMore
boolean
required
nextCursor
string | null