HomeAPI ReferenceVaultsGet Vault Assets
GET/vaults/assets

Get Vault Assets

Outcome - Lists the assets (coins and tokens) enabled in this vault. Use the asset id in transactions, wallet lookups and payment orders.

Query Parameters

pagenumberdefault: 1nullable

Page number, starting at 1.

limitnumberdefault: 10nullable

Number of results per page.

sortKeystringdefault: idnullable

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

orderstringnullable

Sort direction: ASC or DESC.

searchstringnullable

Search by name, symbol, contract address or id.

filtersobjectnullable

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

Show child parameters (6)
idnumbernullable

Asset ID

networkIdnumbernullable

Network ID

contractAddressstringnullable

Token contract address

typestringnullable

COIN, TOKEN or CUSTOM_TOKEN

statusstringnullable

ACTIVE, PENDING, HELD_BY_CORPORATE or HELD_BY_SUPER_ADMIN

isSwappablebooleannullable

true for assets that can be swapped

Responses

Response attributes

messagestring

Response message

dataarray

Array of vault assets

Show child attributes (12)
idnumber

Asset ID

namestring

Asset name

symbolstring

Asset symbol

contractAddressstring

Asset contract address

decimalsnumber

Asset decimals

networkobject

Network information

Show child attributes (5)
idnumber

Network ID

namestring

Network name

symbolstring

Network symbol

isSwappableboolean

Whether the network supports swapping

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 (2)
httparray

HTTP RPC URLs

webSocketarray

WebSocket 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

createdAtstring

Asset creation timestamp

updatedAtstring

Asset last updated timestamp

vaultStatusstring

Asset status in vault

typestring

Asset type (TOKEN, COIN, etc.)

statusstring

Asset status (ACTIVE, INACTIVE, etc.)

logostring

Asset logo URL

statusnumber

HTTP status code

metaobject

Page pagination. Increase the page query parameter to get the next page.

Show child attributes (6)
totalItemsnumber

Total number of matching items

itemsPerPagenumber

Page size used for this request

totalPagesnumber

Total number of pages

currentPagenumber

The page returned

hasPreviousPageboolean

true if currentPage > 1

hasNextPageboolean

true if currentPage < totalPages

Was this page helpful?