HomeAPI ReferenceWalletsGet All Clients' Wallets
GET/wallets/client-wallets

Get All Clients' Wallets

Outcome - Returns all the clients' wallets for each of the integrated blockchains.

Query Parameters

pagenumbernullable

Specifies the page number of results to return.

limitnumbernullable

Limits the number of results returned.

sortKeystringnullable

Sort results by one of the following: 'id', 'balance'.

orderstringnullable

Sort order: 'asc' for ascending or 'desc' for descending.

searchstringnullable

Searches by Wallet Public Address or Asset Name or Asset Contract Address.

clientIdstringnullable

Filter by Client ID.

filtersobjectnullable

Filters results.

Show child parameters (4)
publicAddressstringnullable

Public address of the wallet.

typestringnullable

Filter by wallet type.

targetIdnumbernullable

The ID of the client or vault that owns the wallet. (Use null for master wallets or the vault id).

assetIdnumbernullable

The ID of the associated asset.

Responses

Response attributes

messagestring

Response message

dataarray

Array of wallet records

Show child attributes (9)
idnumber

Wallet ID

balancestring

Available balance

pendingBalancestring

Pending balance

publicAddressstring

Public blockchain address of the wallet

transactionsCountstring

Number of transactions

targetIdstring

Target ID

protocolnumber

Protocol version or type

assetobject

Asset details

Show child attributes (8)
idnumber

Asset ID

namestring

Asset name

symbolstring

Asset symbol

contractAddressstringnullable

Token contract address

decimalsnumber

Asset decimals

typestring

Asset type (COIN or TOKEN)

statusstring

Asset status

logostring

Asset logo URL

typestring

Wallet type

metaobject

Pagination details

Show child attributes (5)
hasNextPageboolean

Has next page

hasPreviousPageboolean

Has previous page

nextCursorstring

Next cursor

previousCursorstring

Previous cursor

limitnumber

Limit

statusnumber

HTTP status code

Was this page helpful?