API reference
Vaultody
GET
/vaults/{vaultId}/vault-accounts/details
List Vault Accounts
Retrieve all Vault Accounts associated with a specific Vault.
Path parameters
vaultId
string
required
The ID of the vault.
Query parameters
context
string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.
isHidden
boolean
When it is set to true, the endpoint will return only Vault Accounts that are marked as hidden in the dashboard (isHiddenInDashboard = true).
isHideEmpty
boolean
When it is set to true, the response will include only Vault Accounts that have a positive balance.
limit
integer
Defines how many items should be returned in the response per page basis.
startingAfter
string
Defines the id of the previous listed record id from which the current list should start from.
Response
Returns 200 the request has been successful.
apiVersion
string
required
Specifies the version of the API that incorporates this endpoint.
requestId
string
required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
context
string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.
data
object
required
limit
integer
required
Defines how many items should be returned in the response per page basis.
startingAfter
string
Defines the id of the previous listed record id from which the current list should start from.
hasMore
boolean
required
Defines whether or not there are more elements available after this set.
items
object[]
required
addressesCount
string
required
The total number of addresses associated with this Vault Account.
balances
object[]
required
assetId
string
required
The specific id of the assets.
assetName
string
required
Full name of the asset (e.g., Ethereum, Base, Optimism, Tron, Bitcoin, Dogecoin,).
assetUnit
string
required
The commonly used symbol for the asset (e.g., ETH, BTC, TRX, BNB).
blockchain
string
required
The blockchain network where this asset resides (e.g., ethereum, bitcoin, optimism, tron, binance-smart-chain).
exchangeRateUnit
string
required
The pricing unit used when calculating exchange rates.
latestExchangeRateToUSD
string
required
The latest exchange rate of the asset to USD.
totalAmount
string
required
The total amount of this asset held in the Vault Account.
createdAt
integer
required
The UNIX timestamp indicating when the Vault Account was first created.
index
integer
required
The sequential index of this Vault Account within its parent Vault.
isFavoriteInDashboard
boolean
required
Indicates whether the Vault Account has been marked as a "favorite" in the dashboard.
isHiddenInDashboard
boolean
required
Specifies whether this Vault Account is hidden from the main dashboard view.
vaultAccountColour
string
required
A HEX color value used to uniquely visually style this Vault Account in dashboards.
vaultAccountId
string
required
The unique id of the Vault Account.
vaultAccountName
string
required
The name of the Vault Account.
vaultId
string
required
The id of the Vault to which this Vault Account belongs.