Skip to main content
GET
List wallets

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

limit
integer<int32>

Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.

startingAfter
string
endingBefore
string
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

The request has succeeded.

Canonical paginated envelope for the top-level wallet list.

object
string

Resource type discriminator.

limit
integer<int32>

The effective page size applied to this response, after clamping an out-of-range or unset requested limit into the supported bound.

hasMore
boolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursor
string

Opaque cursor for the next page. Present when another page can be requested; pass it as startingAfter. hasMore=false signals no more pages forward.

previousCursor
string

Opaque cursor pointing at the first item in this page. Present when data is non-empty, except on a list documented as forward only. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.

data
(Crypto wallet · object | Fiat wallet · object)[]

The page of results.

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.