Skip to main content

Get Max Transferable Balance

API Description​

This interface allows querying the maximum transferable balance in a user's futures account.

Note: Max Transferable Balance data is only available via RESTful API.

Precautions​

None

Authentication​

This is a private interface and requires authentication. For details on using the RESTful API, refer to Common > Authentication & Code Snippet > Futures > RESTful Private Interface.

Request Method​

GET

Endpoint​

/v1/perpum/account/available

Frequency Limit​

The frequency limit for this interface is 5 requests/s per user ID and IP. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters​

This interface does not require any request parameters.

Response Parameters​

ParameterTypeDescription
dataBigDecimalMaximum transferable amount

Request Example​

The following Python code shows how to get the maximum transferable balance of a user's futures account.

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

params = {}
api_url = "/v1/perpum/account/available"
method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)    # function FuturesRestfulPrivate() is defined in section (Common > Authentication & Code Snippet > Futures > RESTful Private Interface)

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

Response Example​

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

{'code': 0, 'data': {'value': '438.799142390000018'}, 'msg': ''}