querySubMembers
Retrieve a complete list of all sub-accounts under the master account, including details such as UID, username, account type, status, and UTA mode. Requires master account API key.
Instructions
Get a complete list of all sub-accounts under the master account. Use master account's API key.
Important notes (from official Bybit V5 documentation):
Only master account can call this endpoint
Sub-accounts CANNOT use this endpoint
Returns ALL sub-accounts in a single response (no pagination)
Includes comprehensive account information and UTA status
What information is returned:
✅ Sub-account UID and username
✅ Account type (normal, custodial, demo, escrow fund)
✅ Account status (normal, banned, frozen, deleted)
✅ Account mode (Classic, UTA 1.0/2.0, UTA Pro, Unified)
✅ Remark/notes for each sub-account
Supported Sub-account Types: This endpoint returns ALL types of sub-accounts:
Normal sub-accounts (type=1, MEMBER_RELATION_TYPE_OWN)
Custodial sub-accounts (type=6, MEMBER_RELATION_TYPE_ENTRUST_TRADE)
Demo sub-accounts (type=2, MEMBER_RELATION_TYPE_DEMO)
Escrow fund sub-accounts (for trading teams)
Process Flow:
Parse metadata from request context to get master account ID
Query normal + demo + trading custodial sub-accounts via ListSubMemberForOpenAPI
Queries member_relation table with decrypted login names
Includes types: OWN (1), DEMO (2), ENTRUST_TRADE (6)
Query escrow fund sub-accounts for trading teams via GetEscrowFundSubMember
Queries escrow_fund_member_relation table
Specific for trading team escrow accounts
Merge both lists of sub-accounts
If no sub-accounts found, return empty list
Extract all sub-account IDs for batch queries
Fetch UTA tags (UTA, UNIFIED, UTAPRO, UTAINVERSE) from member_tags table
For each sub-account:
Get basic info (UID, username, type, status, remark)
Calculate accountMode based on UTA tags
Default accountMode = 1 if no tags found
Return complete sub-account list
Account Mode Determination Logic: The account mode is determined by checking member tags in the following priority:
If both UTAPRO=SUCCESS and UTAINVERSE=SUCCESS → UTA 2.0 Pro (6)
If UTAINVERSE=SUCCESS → UTA 2.0 (5)
If UTAPRO=SUCCESS → UTA 1.0 Pro (4)
If UTA=SUCCESS → UTA 1.0 (3)
If UNIFIED=SUCCESS → Unified (7)
Otherwise → Classic/Default (1)
Difference from V5 Query:
This endpoint (V3): Returns ALL sub-accounts in single response, no pagination
/v5/user/submembers (V5): Uses cursor-based pagination with pageSize limit
Use Cases:
Get complete overview of all sub-accounts
Check sub-account statuses and configurations
Audit UTA upgrade status across all sub-accounts
Small to medium-sized sub-account lists (no pagination)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||