querySubMembersV5

Query all sub-accounts of the master account with pagination support. Use master account's API key.

Important notes (from official Bybit V5 documentation):

• Only master account can call this endpoint

• Returns paginated list of sub-accounts with comprehensive information

• Supports cursor-based pagination

• Includes account status, type, and configuration details

• Shows UTA (Unified Trading Account) mode for each sub-account

Required Permissions:

• Master API key with appropriate permissions

Pagination:

• Default page size: 100 (auto-set if not provided or <= 0)

• Maximum page size: 100

• Use nextCursor for fetching next page

• Returns 0 as nextCursor when no more pages

• First request: Use nextCursor=0 or omit

What information is returned:

1. ✅ Sub-account UID and username

2. ✅ Account type (normal=1 or custodial=6)

3. ✅ Account status (normal, banned, frozen, deleted)

4. ✅ Account mode (Classic, UTA 1.0/2.0, UTA Pro, Unified)

5. ✅ Remark/notes for each sub-account

6. ✅ Next cursor for pagination

Process Flow:

1. Parse metadata from request context to get master account ID

2. Validate pageSize (auto-adjust to 100 if invalid, error if > 100)

3. If first page (nextCursor=0): Check for entrust trading team sub-accounts

   • Query "SPECIAL_EXCHANGE_MEMBER" tag to identify exchange members

   • Get entrust trading team sub-accounts via QueryEntrustMembersByExchangeID

   • Fetch their relationship data from member_relations table

4. Get paginated sub-accounts via GetMemberRelationByPageV3

   • Adjusted page size = requested pageSize - entrust accounts count

   • Fetch from member_relations table ordered by ID

5. Combine entrust accounts + regular sub-accounts

6. Calculate nextCursor: ID of last sub-account if page is full, else 0

7. Fetch login names for all sub-accounts from member_login table

8. Fetch account tags (UTA, UNIFIED, UTAPRO, UTAINVERSE) for account mode determination

9. Filter sub-accounts: Only return type=1 (normal) and type=6 (custodial)

10. Calculate account mode based on tag combinations

11. Return sub-account list with nextCursor

Account Types:

• Type 1: Normal sub-account - standard trading sub-account (MEMBER_RELATION_TYPE_OWN)

• Type 6: Custodial sub-account - for institutional custody use (MEMBER_RELATION_TYPE_ENTRUST_TRADE)

Account Status:

• Status 1: Normal (active)

• Status 2: Login banned

• Status 4: Frozen

• Status 8: Deleted (soft delete)

Account Mode Determination Logic: The account mode is determined by checking member tags in the following priority:

1. If both UTAPRO=SUCCESS and UTAINVERSE=SUCCESS → UTA 2.0 Pro (6)

2. If UTAINVERSE=SUCCESS → UTA 2.0 (5)

3. If UTAPRO=SUCCESS → UTA 1.0 Pro (4)

4. If UTA=SUCCESS → UTA 1.0 (3)

5. If UNIFIED=SUCCESS → Unified (7)

6. Otherwise → Classic (1)

Special Features:

• Entrust Trading Team Support: First page includes entrust trading team sub-accounts

• Tag-based Mode Detection: Uses member_tags table to determine UTA status

• Cursor-based Pagination: Efficient for large sub-account lists

• Filtered Results: Only shows type=1 and type=6 accounts

Use Cases:

• List all sub-accounts for management dashboard

• Check sub-account statuses and modes

• Audit sub-account configurations

• Monitor UTA upgrade status across sub-accounts

• Paginate through large numbers of sub-accounts