Get a Sub-Account Balance

This endpoint returns the account info of a sub-user specified by the subUserId.

HTTP REQUEST

GET /api/v1/sub-accounts/{subUserId}

Example

GET /api/v1/sub-accounts/5caefba7d9575a0688f83c45?includeBaseAmount=false

{
  "subUserId": "5caefba7d9575a0688f83c45",
  "subName": "sdfgsdfgsfd",
  "mainAccounts": [
    {
      "currency": "BTC",
      "balance": "8",
      "available": "8",
      "holds": "0",
      "baseCurrency": "BTC",
      "baseCurrencyPrice": "1",
      "baseAmount": "1.1"
    }
  ],
  "tradeAccounts": [
    {
      "currency": "BTC",
      "balance": "1000",
      "available": "1000",
      "holds": "0",
      "baseCurrency": "BTC",
      "baseCurrencyPrice": "1",
      "baseAmount": "1.1"
    }
  ],
  "marginAccounts": [
    {
      "currency": "BTC",
      "balance": "1.1",
      "available": "1.1",
      "holds": "0",
      "baseCurrency": "BTC",
      "baseCurrencyPrice": "1",
      "baseAmount": "1.1"
    }
  ]
}

API KEY PERMISSIONS

This endpoint requires the General permission.

REQUEST URL

This endpoint support Spot URL

REQUEST RATE LIMIT

Manage weight：15

PARAMETERS

Param	Type	Mandatory	Description
subUserId	String	Yes	the user ID of a sub-account.
includeBaseAmount	boolean	Yes	false: do not display the currency which asset is 0, true: display all currency

RESPONSES

Param	Description
subUserId	The user ID of a sub-user.
subName	The username of a sub-user.
currency	Currency
balance	Total funds in an account.
available	Funds available to withdraw or trade.
holds	Funds on hold (not available for use).
baseCurrency	Calculated on this currency.
baseCurrencyPrice	The base currency price.
baseAmount	The base currency amount.