Skip to content
Asset Overview and Cash

Get Account Asset Overview

Returns an asset snapshot of the specified account in one call: account-level buying power and margin metrics, cash by currency, holding values of funds, bonds, and other assets, stock and crypto holdings, US option holdings, and money market fund holdings and status for idle cash. Use it to build an asset overview page without the asset push, or to show the withdrawable amount and money market fund tips on the withdrawal page. The response is a point-in-time snapshot and is not updated afterward; use the asset push for live changes.

The caller calculates total assets: convert the total cash of each currency (balance + frozen_buy_cash + external_amount) and the market value of each holding class with exchange rates, then add them. The withdrawal and currency exchange pages also use this operation to read money market fund holdings and prompt the Client to redeem first.

WhaleCore portfolioService() already wraps this capability through the asset subscription (setSubscribedAccounts) and the cash detail switch (cashDetailEnable). When you use WhaleCore, prefer the WhaleCore capability over calling this operation directly.

GEThttps://api.lbkrs.com/v3/portfolio/detail

Parameters

account_channelstringqueryRequired

Account channel. Use the account_channel of the current account

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get account asset overview” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
account_channelstring

Account channel

accountobject

Account-level funds and risk metrics

Child attributes
account_nostring

Account number

channel_currencystring

Base currency of the account channel. max_purchase, initial_margin, maintenance_margin, margin_within_day, and credit_limit are in this currency

available_cashstring

Maximum withdrawable amount

max_purchasestring

Maximum buying power

credit_limitstring

Margin financing limit

initial_marginstring

Initial margin requirement

maintenance_marginstring

Maintenance margin requirement

margin_callstring

Margin call amount

margin_within_daystring

Intraday risk control value

f_indicatorstring

Forced liquidation indicator. YES means the account has triggered forced liquidation risk and the risk status is dangerous; NO means it has not

Values
YES
NO
today_plstring

Stock profit and loss from today's executions, excluding unrealized profit and loss on holdings

cash_balancearray<object>

Cash by currency

Child attributes
currencystring

Currency code, such as HKD or USD

balancestring

Cash balance

settled_cashstring

Settled cash

withdraw_cashstring

Withdrawable cash

withdraw_cash_ex_mmfstring

Withdrawable cash excluding money market funds

frozen_buy_cashstring

Amount held by pending buy orders

external_amountstring

Amount withheld for IPO subscriptions

outstandingstring

Unsettled amount

debit_intereststring

Margin financing interest

opening_balance_todaystring

Opening cash balance, which is the balance at the end of the previous trading day

unit_trust_cash_balancearray<object>

Fund holdings and in-transit amounts by currency

Child attributes
currencystring

Currency code, such as HKD or USD

holding_valuestring

Holding value

pending_buy_valuestring

Amount of purchases pending confirmation

pending_buy_ordersstring

Number of purchases pending confirmation

pending_sold_valuestring

Amount of sales pending credit

pending_sold_ordersstring

Number of sales pending credit

bond_balancearray<object>

Bond holdings and in-transit amounts by currency

Child attributes
currencystring

Currency code, such as HKD or USD

holding_valuestring

Holding value

pending_buy_valuestring

Amount of purchases pending confirmation

pending_buy_ordersstring

Number of purchases pending confirmation

pending_sold_valuestring

Amount of sales pending credit

pending_sold_ordersstring

Number of sales pending credit

other_balancearray<object>

Other asset holdings and in-transit amounts by currency

Child attributes
currencystring

Currency code, such as HKD or USD

holding_valuestring

Holding value

pending_buy_valuestring

Amount of purchases pending confirmation

pending_buy_ordersstring

Number of purchases pending confirmation

pending_sold_valuestring

Amount of sales pending credit

pending_sold_ordersstring

Number of sales pending credit

stockholdobject

Stock holdings

Child attributes
holdingsarray<object>

Stock holdings

Child attributes
counter_idstring

Security ID (counter_id), such as ST/HK/700

namestring

Security name

marketstring

Market code, such as HK or US

currencystring

Holding currency

quantitystring

Holding quantity. It may be returned as a number; parse it as a numeric value

available_quantitystring

Sellable quantity. It may be returned as a number; parse it as a numeric value

average_coststring

Average purchase cost

diluted_avg_coststring

Diluted cost

prev_closestring

Previous close

last_donestring

Last price

market_pricestring

Price used to calculate market value

today_plstring

Profit and loss from today's executions, excluding unrealized profit and loss on holdings

achieves_plstring

Holding profit and loss based on average purchase cost

achieves_pl_percentstring

Holding profit and loss ratio based on average purchase cost

achieves_diluted_plstring

Holding profit and loss based on diluted cost

achieves_diluted_pl_percentstring

Holding profit and loss ratio based on diluted cost

pretrade_today_plstring

Profit and loss from today's executions when US pre-market and post-market prices are included. Use it only when that asset setting is on and the security is in the pre-market or clearing session

trade_statusstring

Security trading status code as a string. Values follow TradeStatus

crypto_holdobject

Crypto holdings

Child attributes
holdingsarray<object>

Crypto holdings

Child attributes
counter_idstring

Security ID (counter_id), such as ST/HK/700

namestring

Security name

marketstring

Market code, such as HK or US

currencystring

Holding currency

quantitystring

Holding quantity. It may be returned as a number; parse it as a numeric value

available_quantitystring

Sellable quantity. It may be returned as a number; parse it as a numeric value

average_coststring

Average purchase cost

diluted_avg_coststring

Diluted cost

prev_closestring

Previous close

last_donestring

Last price

market_pricestring

Price used to calculate market value

today_plstring

Profit and loss from today's executions, excluding unrealized profit and loss on holdings

achieves_plstring

Holding profit and loss based on average purchase cost

achieves_pl_percentstring

Holding profit and loss ratio based on average purchase cost

achieves_diluted_plstring

Holding profit and loss based on diluted cost

achieves_diluted_pl_percentstring

Holding profit and loss ratio based on diluted cost

pretrade_today_plstring

Profit and loss from today's executions when US pre-market and post-market prices are included. Use it only when that asset setting is on and the security is in the pre-market or clearing session

trade_statusstring

Security trading status code as a string. Values follow TradeStatus

us_optionobject

US option holdings

Child attributes
holdingsarray<object>

US option holdings

Child attributes
counter_idstring

Security ID (counter_id), such as ST/HK/700

namestring

Security name

marketstring

Market code, such as HK or US

currencystring

Holding currency

quantitystring

Holding quantity. It may be returned as a number; parse it as a numeric value

available_quantitystring

Sellable quantity. It may be returned as a number; parse it as a numeric value

average_coststring

Average purchase cost

diluted_avg_coststring

Diluted cost

prev_closestring

Previous close

last_donestring

Last price

today_plstring

Profit and loss from today's executions, excluding unrealized profit and loss on holdings

achieves_plstring

Holding profit and loss based on average purchase cost

achieves_pl_percentstring

Holding profit and loss ratio based on average purchase cost

achieves_diluted_plstring

Holding profit and loss based on diluted cost

achieves_diluted_pl_percentstring

Holding profit and loss ratio based on diluted cost

trade_statusstring

Security trading status code as a string. Values follow TradeStatus

contract_multiplierstring

Contract multiplier

strike_pricestring

Strike price

due_datestring

Expiration date

underlying_stock_codestring

Underlying stock code

mmfobject

Money market fund for idle cash

Child attributes
statusinteger

Status of the money market fund feature for idle cash:

  • 0 - Off
  • 1 - On
  • 2 - Turning on
  • 3 - Turning off
Values
0
1
2
3
holdingsarray<object>

Money market fund holdings

Child attributes
currencystring

Currency code, such as HKD or USD

namestring

Money market fund name

total_balancestring

Holding amount. One currency may be split into multiple records; sum them when you show the balance of that currency

yesterday_plstring

Yesterday's return

seven_days_plstring

Return over the last 7 days

history_plstring

Cumulative return

last_plstring

Latest return

last_pl_dtstring

Date of the latest return

Whale Docs