HomeAPI ReferenceVaultsGet Master Wallet
GET/vaults/master-wallets

Get Master Wallet

Outcome - Lists the vault's own (MASTER) wallets, one per enabled asset.

Query Parameters

limitnumberdefault: 10nullable

Number of results per page, from 1 to 100.

cursorstringnullable

Cursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.

sortKeystringdefault: idnullable

Field to sort by. Allowed values: id, balance.

orderstringnullable

Sort direction: ASC or DESC.

filtersobjectnullable

Filters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.

Show child parameters (7)
idnumbernullable

Wallet ID. Example: filters[id]=2322

publicAddressstringnullable

Blockchain address. Example: filters[publicAddress]=0x1023...

assetIdnumbernullable

Asset ID. Example: filters[assetId]=12

networkIdnumbernullable

Network ID. Example: filters[networkId]=1

contractAddressstringnullable

Token contract address of the wallet's asset.

targetIdnumbernullable

ID of the owner: the RoxCustody client ID for CLIENT wallets, the vault ID for MASTER wallets.

typestringnullable

Wallet type: MASTER, CLIENT, GAS_STATION, ORDER or SYSTEM_FEES.

Responses

Response attributes

messagestring

Response message

dataarray

Array of master wallet records

Show child attributes (8)
idnumber

Wallet ID

balancestring

Available balance

pendingBalancestring

Pending balance

publicAddressstring

Public blockchain address of the wallet

transactionsCountstring

Number of transactions

targetIdstring

Target ID (vault ID for master wallets)

assetobject

Asset details

Show child attributes (11)
idnumber

Asset ID

namestring

Asset name

symbolstring

Asset symbol

contractAddressstringnullable

Token contract address (null for native coins)

decimalsnumber

Asset decimals

networkobject

Network details

Show child attributes (8)
idnumber

Network ID

namestring

Network name

symbolstring

Network symbol

logostring

Network logo URL

isSwappableboolean

Whether the network supports swapping

categorystring

Network category (e.g. EVM)

chainobject

Chain details

Show child attributes (5)
idnumber

Chain ID

namestring

Chain name

nativeCurrencyobject

Native currency details

Show child attributes (3)
namestring

Currency name

symbolstring

Currency symbol

decimalsnumber

Currency decimals

rpcUrlsobject

RPC URLs

Show child attributes (1)
defaultobject

Default RPC configuration

Show child attributes (1)
httparray

HTTP RPC URLs

blockExplorersobject

Block explorer details

Show child attributes (1)
defaultobject

Default block explorer

Show child attributes (3)
namestring

Explorer name

urlstring

Explorer URL

apiUrlstring

Explorer API URL

addressFormatobject

Address format validation rules

Show child attributes (2)
prefixesarray

Valid address prefixes

lengthRangearray

Valid address length range [min, max]

vaultStatusstring

Asset status within the vault

isHiddenboolean

Whether the asset is hidden

typestring

Asset type (COIN or TOKEN)

statusstring

Asset status

logostring

Asset logo URL

typestring

Wallet type (MASTER)

statusnumber

HTTP status code

metaobject

Cursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.

Show child attributes (5)
hasNextPageboolean

true if there are more results after this page

hasPreviousPageboolean

true if there are results before this page

nextCursorstring | null

Cursor for the next page, or null on the last page

previousCursorstring | null

Cursor for the previous page, or null on the first page

limitnumber

Page size used for this request

Was this page helpful?