List assets
Through this endpoint, users can quickly view all their current balances, with the flexibility to filter assets based on their network type, whether it be testnet or mainnet.
Path Parameters
-
RequirednetworkType string
The specific type of the vault - MAIN or TEST.
Query Paramaters
-
Optionalcontext 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. -
Optionallimit integer
Defines how many items should be returned in the response per page basis.
-
OptionalstartingAfter string
Defines the id of the previous listed record id from which the current list should start from.
Response Schema
Content Type: application/json
The request has been successful.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2024-05-09 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Vaultody and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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.Example : yourExampleString -
Requireddata object
-
Requiredlimit integer
Defines how many items should be returned in the response per page basis.
Example : 50 -
OptionalstartingAfter string
Defines the id of the previous listed record id from which the current list should start from.
Example : 5ca21f92cf5431000105d1a7 -
RequiredhasMore boolean
Defines whether or not there are more elements available after this set.
Example : true -
Requireditems arrayExample : Array ( )
-
RequiredallocatedAmaunt string
Allocated amount for the specific asset.
Example : 0 -
RequiredavailableAmount string
Available amount for the specific asset.
Example : 0.00023054 -
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Bitcoin, Ethereum etc.
Example : bitcoin -
RequiredblockedAmount string
Blocked amount for the specific asset.
Example : 0 -
RequiredexchangeRate string
The current exchange rate.
Example : 39884.82228404232 -
Requiredid string
The specific asset ID.
Example : 6523e058a06ebf1322d7dd6f -
Requiredsymbol string
The specific symbol - BTC, ETH, BNB, TRX.
Example : BTC -
OptionaltokenData object
-
RequiredcontractAddress string
Token identifier.
Example : TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3 -
RequiredcontractType string
The specific standard for the token, e.g. TRC-20, BEP-20.
Example : TRC-20
-
-
RequiredtotalAmount string
Total amount for the specific asset.
Example : 0.00023054 -
Requiredtype string
The type of the asset - Coin or Token.
Example : COIN
-
-