User Asset

Testnet Env

https://testnet.trade.vessel.finance

GET

/api/v1/userAsset

Last modified:2024-10-15 06:23:56

User Assets provides detailed information about a user's assets on our platform, including available balances, in-use amounts, pending withdrawals, and current market prices.

Request

Header Params

VESSEL-API-KEY

string

required

Default:

VESSEL-PASSPHRASE

string

required

Default:

VESSEL-SIGNATURE

string

required

Use signRequest script to generate

VESSEL-TIMESTAMP

string

required

Use signRequest script to set

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/userAsset' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

assets

array [object {6}]

required

An array containing information for each asset held by the user.

assetName

string

required

The symbol or identifier of the asset.

available

string

required

The amount of the asset available for trading.

inUse

string

required

The amount of the asset currently in use (e.g., tied up in open orders).

pendingWithdraw

string

required

The amount of the asset pending withdrawal.

todayTransactionAmount

string

required

Amount of deposits minus withdrawals for the asset from UTC 00:00 to the query time

price

string

required

The current market price of the asset.

Example

{
  "assets": [
    {
      "assetName": "WBTC",
      "available": "99999.9998",
      "inUse": "0",
      "pendingWithdraw": "0.0002",
      "todayTransactionAmount": "99999.9998",
      "price": "61121.82"
    },
    {
      "assetName": "USDC",
      "available": "0",
      "inUse": "0",
      "pendingWithdraw": "0",
      "todayTransactionAmount": "0",
      "price": "1"
    },
    {
      "assetName": "USDT",
      "available": "0",
      "inUse": "0",
      "pendingWithdraw": "0",
      "todayTransactionAmount": "0",
      "price": "1"
    }
  ]
}

User

Withdraw