Get Sub-account List

Description

Query Sub-account List

HTTP Request

• GET /api/v3/user/sub-list
• Rate limit: 10/sec/UID
• Unified account management read permissions are required
• Only the main account can call this API

Request

curl -X GET "https://api.bitget.com/api/v3/user/sub-list?limit=100&cursor=18484" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*" \
   -H "ACCESS-PASSPHRASE:*" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "locale:en-US" \
   -H "Content-Type: application/json"

Request Parameters

Parameter	Type	Required	Comments
limit	String	No	Items per page The default value is 100, and the maximum value is 100.
cursor	String	No	Cursor ID Used for pagination. Do not pass it for the first query. For subsequent queries (second page and beyond), use the cursor returned from the previous query.

Response

{
  "code": "00000",
  "msg": "success",
  "requestTime": 1740212430491,
  "data": {
    "list": [
      {
        "subUid": "xxx",
        "username": "llt****@virtual-bitget.com",
        "status": "normal",
        "accountMode": "CLASSIC",
        "type": "VIRTUAL_CHILD",
        "note": "xxxx",
        "createdTime": "1740129303268",
        "updatedTime": "1740129303268"
      },
      {
        "subUid": "xxx",
        "username": "zml****@virtual-bitget.com",
        "status": "normal",
        "accountMode": "UNIFIED",
        "type": "VIRTUAL_CHILD",
        "note": "xxx",
        "createdTime": "1740211445018",
        "updatedTime": "1740211445018"
      },
      {
        "subUid": "xxx",
        "username": "tmr****@virtual-bitget.com",
        "status": "freeze",
        "accountMode": "UNIFIED",
        "type": "VIRTUAL_CHILD",
        "note": "xxx",
        "createdTime": "1740131800692",
        "updatedTime": "1740212129476"
      }
    ],
    "hasNext": false,
    "cursor": "18484"
  }
}

Response Parameters

Parameter	Type	Comments
cursor	String	Cursor ID
hasNext	String	Is there more data on the next page
list	Array	Sub-account List
> username	String	Sub-account name
> subUid	String	Sub-account ID
> status	String	Account Status normal Normal frozen Frozen
> accountMode	String	Account Mode CLASSIC Classic Account Mode UNIFIED Unified Account Mode
> type	String	Account Type COMMON Regular Sub-account BROKER_CHILD Broker Sub-account VIRTUAL_CHILD Virtual Sub-account VIRTUAL_STRATEGY_CHILD Strategy Virtual Sub-account COPPER_CHILD Cooper Sub-account CONTRACT_EXPERIENCE Contract Experience Account ENTRUST_CHILD Custodial Sub-account TRADE_PRO Trade Pro Account VIRTUAL_TRACE_CHILD Contract Copy Trading Virtual Sub-account CONTRACT_TRADER_CHILD Contract Trader Virtual Sub-account DEMO_ACCOUNT Demo Account TRADE_PRO_DEMO_ACCOUNT Trade Pro Demo Account STRATEGY_DEMO_ACCOUNT Strategy Demo Account PAP_TRADING_ACCOUNT PAP Trading Account
> note	String	Note
> createdTime	String	Creation Time, Unix Millisecond Timestamp
> updatedTime	String	Last Modified Time, Unix Millisecond Timestamp