/wallets/client-walletsGet All Clients' Wallets
Outcome - Lists client wallets in this vault, for all clients or, with clientId, for one client.
Query Parameters
limitnumberdefault: 10nullableNumber of results per page, from 1 to 100.
cursorstringnullableCursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.
sortKeystringdefault: idnullableField to sort by. Allowed values: id, balance.
orderstringnullableSort direction: ASC or DESC.
clientIdstringnullableYour client id (externalId). Returns only this client's wallets.
filtersobjectnullableFilters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.
Show child parameters (7)
idnumbernullableWallet ID. Example: filters[id]=2322
publicAddressstringnullableBlockchain address. Example: filters[publicAddress]=0x1023...
assetIdnumbernullableAsset ID. Example: filters[assetId]=12
networkIdnumbernullableNetwork ID. Example: filters[networkId]=1
contractAddressstringnullableToken contract address of the wallet's asset.
targetIdnumbernullableID of the owner: the RoxCustody client ID for CLIENT wallets, the vault ID for MASTER wallets.
typestringnullableWallet type: MASTER, CLIENT, GAS_STATION, ORDER or SYSTEM_FEES.
Responses
Response attributes
messagestringResponse message
dataarrayArray of wallet records
Show child attributes (9)
idnumberWallet ID
balancestringAvailable balance
pendingBalancestringPending balance
publicAddressstringPublic blockchain address of the wallet
transactionsCountstringNumber of transactions
targetIdstringTarget ID
protocolnumberProtocol version or type
assetobjectAsset details
Show child attributes (8)
idnumberAsset ID
namestringAsset name
symbolstringAsset symbol
contractAddressstringnullableToken contract address
decimalsnumberAsset decimals
typestringAsset type (COIN or TOKEN)
statusstringAsset status
logostringAsset logo URL
typestringWallet type
statusnumberHTTP status code
metaobjectCursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.
Show child attributes (5)
hasNextPagebooleantrue if there are more results after this page
hasPreviousPagebooleantrue if there are results before this page
nextCursorstring | nullCursor for the next page, or null on the last page
previousCursorstring | nullCursor for the previous page, or null on the first page
limitnumberPage size used for this request
Was this page helpful?