API reference
Vaultody
GET
/vaults/{vaultId}/vault-accounts/{vaultAccountId}/list-assets
List Assets by Vault Account ID
Through this endpoint customers can obtain information about available assets in their vault accounts, with optional filtering by asset symbol.
Path parameters
vaultAccountId
string
required
Unique identifier of the vault account.
vaultId
string
required
Unique identifier 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.
assetUnit
string
Filters results by asset symbol, e.g ETH, LTC,BCH, BNB, TRX, USDT, USDC.
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
assetId
string
required
Unique identifier of the asset.
assetUnit
string
required
Asset symbol (e.g., BTC, ETH, LTC, USDC).
availableAmount
string
required
Amount of the asset available in the vault account.
blockchain
string
required
Blockchain network on which the asset exists (e.g., bitcoin, ethereum).
exchangeRateToUsd
string
required
Current exchange rate of the asset to USD.