Skip to content
Longport WhaleLongport Whale
Assets Overview

Total Asset & Total Cash

Returns the total-asset composition by type and currency, plus the book total-cash breakdown.

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, default behavior, and business meaning.

Business notes

Filter by any combination of client_types, account_types, and broker_codes; join multiple values with a comma ,. Omit a filter to leave that dimension unfiltered.

Asset-type labels are localized according to the Accept-Language request header.

Returns

On success, returns the total-asset composition and book total-cash breakdown. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/portfolio/query_account_balances_summary

Authorization

AuthorizationstringheaderRequired

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

Permission

asset.summary_query

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

Parameters

client_typesstring

Client type.

  • Join multiple values with a comma ,
  • Omit this parameter to query all client types
  • Example: 1,2
account_typesstring

Account type.

  • Join multiple values with a comma ,
  • Omit this parameter to query all account types
  • Example: F,C
broker_codesstring

Filter by broker (AE) code.

  • Join multiple values with a comma ,
  • Omit this parameter to query all brokers
  • = means unassigned
  • Example: =,LBtestwbwhale123

Query the complete AE code list through GET /v1/datasets/refs/broker_accounts. Values vary by tenant and environment.

Responses

HTTP 200The request was processed successfully. data contains total_assets, total_asset_type, total_asset_currency, total_balance.
Standard response envelopecodemessagedata
dataobjectdata structure
total_assetsarray<object>

Total Assets (by currency). Total assets per currency, used for the total-assets display and currency switching at the top.

Child attributes
currencystring

Currency. e.g. HKD/USD/CNY/SGD

amountstring

Amount. Total asset amount for this currency (decimal string).

total_asset_typearray<object>

Total Asset by Type. Proportion by asset type (total-assets type pie chart).

Child attributes
equity_typestring

Asset type category.

Values
CASH
Cash
US
US Stocks
HK
Hong Kong Stocks
CN
Shanghai & Shenzhen
OTHER
Other
FUND
Fund
namestring

Type Name. Localized display name of the asset type, returned per Accept-Language (e.g. Cash).

ratiostring

Ratio (decimal string); multiply by 100 to show a percentage.

total_asset_currencyarray<object>

Total Asset by Currency. Proportion by currency (total-assets currency pie chart).

Child attributes
currencystring

Currency. Returned value: Currency.

ratiostring

Ratio. Decimal string, range 0–1; multiply by 100 to show a percentage.

total_balancearray<object>

Total Cash. Book total-cash details (by currency, corresponding to the "Book Total Cash" table).

Child attributes
currencystring

Currency. Returned value: Currency.

book_balancestring

Total Cash. Decimal string.

settled_amountstring

Settled. Returned value: Settled.

unsettle_amountstring

Outstanding. Returned value: Outstanding.

trade_0string

T+0 amount to be settled. Returned value: T+0 amount to be settled.

trade_1string

T+1 amount to be settled. Returned value: T+1 amount to be settled.

trade_2string

T+2 amount to be settled. Returned value: T+2 amount to be settled.

trade_nstring

T+N amount to be settled. Returned value: T+N amount to be settled.

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