Skip to content
Account Profile & Status

Query Account List V2

Returns a batch of accounts using cursor-based pagination.

Request parameters

  • This endpoint has no required parameters; see the field definitions for optional parameters.
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Page through results with the cursor account_id and page size page_size (default 10, up to 500). Returns the account list and the next-page cursor next_account_id.

Returns

On success, returns the account list and next-page cursor. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v2/whaleapi/account/list

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

kyc.hk_account

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

account_idstringRequired
page_sizestringRequired

Responses

HTTP 200Success
Standard response envelopecodemessagedata
dataobjectdata structure
next_account_idstringrequired

next_account_id

listobjectrequired

list

Child attributes
member_idstringrequired

member_id

account_nostringrequired

account_no

open_account_timestringrequired

open_account_time

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs