Rox CustodyDocs
HomeAPI ReferenceVaultsGet Master Wallet
GET/vaults/master-wallets

Get Master Wallet

Outcome - Returns the master wallets for the authenticated vault. Uses cursor-based pagination for efficient navigation through large datasets.

Query Parameters

cursorstringnullable

Cursor for pagination. Use the `nextCursor` or `previousCursor` from a previous response to navigate between pages.

limitnumbernullable

Limits the number of results returned per page.

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)

metaobject

Cursor-based pagination details

Show child attributes (5)
hasNextPageboolean

Whether there is a next page of results

hasPreviousPageboolean

Whether there is a previous page of results

nextCursorstringnullable

Cursor to use for fetching the next page. Pass this as the `cursor` query parameter.

previousCursorstringnullable

Cursor to use for fetching the previous page. Pass this as the `cursor` query parameter.

limitnumber

Number of items per page

statusnumber

HTTP status code

Was this page helpful?

PreviousGet Vault Payment PolicyNextVerify Webhook