Skip to main content

Get Balance in Sub-Account

Info
  • This endpoint requires signature. For specific signature rules, please refer to Authentication
  • This endpoint will trigger rate limit. For specific rules, please refer to Rate Limit.

Overview​

This endpoint is used to retrieve the sub-account balances for the corresponding market based on the market_type. The definition of market_type can be found in Enum Value Definitions - market_type.

This endpoint does not explicitly define the request and response; when market_type differs, the request parameters and response data align with the corresponding endpoints in the balance module (see "Adaptation Relationships" below).

HTTP request​

GET /account/subs/balance

Request parameters​

Parameter NameRequiredTypeNotes
sub_user_nametruestringSub-account username
market_typetrueenumMarket type, see enumeration values in market_type

Note: Apart from the two parameters mentioned above, other optional parameters vary depending on the market_type. Please refer to the corresponding documentation below.

Adaptation Relationships (Routed by market_type to the request/response definitions in the following documentation)​

Request example​

  • GET /account/subs/balance?sub_user_name=sub2&market_type=SPOT
  • GET /account/subs/balance?sub_user_name=sub2&market_type=MARGIN&market=CETUSDT
  • GET /account/subs/balance?sub_user_name=sub2&market_type=FUTURES