Skip to main content

Get Sub-Account List

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.
Reminder
  • This endpoint can only be accessed using the ACCESS ID of the main account

HTTP request

GET /account/subs

Request parameters

Parameter NameRequiredTypeNotes
sub_user_namefalsestringSub-account username
is_frozenfalseboolFrozen or not.Default is false
pagefalseintNumber of pagination. Default is 1
limitfalseintNumber in each page. Default is 10

Return parameters

Parameter NameTypeNotes
sub_user_namestringSub-account username
is_frozenboolWhether the sub-account is frozen or not.
is_authorizedboolWhether it is authorized or not.
permissions[]stringSub-account permission list
balance_usdstringMarket value of sub-account balance

Request example

GET /account/subs?is_frozen=false&page=1&limit=10

Response example

{
"code": 0,
"message": "OK",
"data": [
{
"sub_user_name": "sub2",
"is_frozen": true,
"is_authorized": false,
"permissions": ["FUTURES", "API"],
"balance_usd": "3564.23"
}
],
"pagination": {
"total": 1,
"has_next": false
}
}