Get All Users Cash Balance

Returns the cash balances of all platform users, with 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

Use page and size to control pagination. Returns each account together with its multi-currency cash amounts.

Returns

On success, returns the per-account cash-balance list with pagination info. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/asset/all_cash

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance.account

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

Parameters

pageinteger

page

sizeinteger

size

Responses

HTTP 200Success

Standard response envelopecodemessagedata

dataobjectdata structure

list_detailsobjectrequired

list_details

Child attributes

account_nostringrequired

account_no

total_cashobjectrequired

total_cash

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

Request

curl --request GET \
  --url 'https://b-api.lbkrs.com/v1/whaleapi/asset/all_cash' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list_details": {
      "account_no": "8600000001",
      "total_cash": {
        "USD": "125630.50",
        "HKD": "125630.50"
      }
    }
  }
}