Skip to main content

Get Max Transferable Amount

API Description

This interface allows the Master Account to query the maximum transferable amount for a specific currency in a sub-account. This value represents the available balance in the sub-account's Asset Account that can be transferred out.

Note: Get Max Transferable Amount is only available via RESTful API.

Precautions

  1. Master Account Only: This endpoint can only be called using the API Key of a Master Account.
  2. Asset Account Scope: The returned value typically reflects the available balance in the Asset Account. Funds frozen in open orders (Spot/Futures) are not included in the transferable amount.

Authentication

This is a Private interface. It requires authentication using the Master Account's API Key and Secret Key. For details on signature generation, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface.

Request Method

POST

Endpoint

/api/v1/private?command=subAccount_transferAvailable

Frequency Limit

The frequency limit for this interface is 3 requests/s per user ID. For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section here.

Request Parameters

ParameterMandatoryTypeDescription
coinCodetrueStringThe currency symbol to query (e.g., USDT).
subUidtrueLongThe CoinW UID of the sub-account.

Response Parameters

ParameterTypeDescription
dataStringThe numerical value of the maximum transferable amount (e.g., "99.5").

Request Example

The following Python code shows how to query the max transferable USDT amount for a sub-account.

Note: For a complete code example, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface.

api_url = "/api/v1/private?command=subAccount_transferAvailable"
method = "post"
params = {"coinCode": "USDT","subUid": "111*****"}

SpotRestfulPrivate(host, api_url, method, api_key, params, secret_key)# function SpotRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface)

Response Example

The following is an example response returned by the above request:

{
"code": "200",
"data": "99",
"msg": "SUCCESS",
"success": true,
"failed": false
}