Get Crypto Assets Balance

This API allows you to retrieve the balances of cryptocurrency assets in a user's account.

Endpoint Information

  • Request Header: X-BH-TOKEN: ******

  • Request Method: GET

  • Request Path: /v2/user/account/assets

  • Authorization Required: Yes

Response Structure

The response will include the following fields:

{
  "code": 200,                      // (number: response code)
  "msg": "SUCCESS",                 // (string: message)
  "data": {                         // (object: account asset details)
    "canDeposit": false,            // (boolean: whether the account can deposit)
    "balances": [                   // (array: list of asset balances)
      {
        "asset": "",                // (string: name of the asset)
        "assetId": "",              // (string: ID of the asset)
        "assetName": "",            // (string: display name of the asset)
        "total": "",                // (string: total amount of the asset)
        "free": "",                 // (string: free amount of the asset)
        "locked": ""                // (string: locked amount of the asset)
      }
    ]
  }
}

Example Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "canDeposit": true,
    "balances": [
      {
        "asset": "BTC",
        "assetId": "1",
        "assetName": "Bitcoin",
        "total": "1.5",
        "free": "1.0",
        "locked": "0.5"
      },
      {
        "asset": "ETH",
        "assetId": "2",
        "assetName": "Ethereum",
        "total": "10.0",
        "free": "5.0",
        "locked": "5.0"
      }
    ]
  }
}

Notes

  • Ensure that you include the necessary authorization tokens in the request headers for successful execution.

  • The canDeposit field indicates whether deposits are allowed for the account.