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. 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.

includeHidden
enum<string>[]

claimed widens the default page to include wallets that default listing otherwise omits — see WalletListHidden. Omitting this param leaves default behavior unchanged. It also admits a custodial wallet the address-reuse guard would otherwise exclude, since both guards run as one exclusion pass.

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.

No deleted value: the single-wallet read path (GET /wallets/{id}, PATCH, /transactions) always filters deleted_at IS NULL, so a soft-deleted wallet the list surfaced would 404 on every follow-up read.

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
(Custodial wallet · object | Fiat wallet · object)[]
required

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

hasMore
boolean
required
nextCursor
string | null