Skip to content
Asset Overview and Cash

Get Cash Details by Currency

Returns the cash breakdown of the current account by currency, including total amount, withdrawable cash, cash frozen for buys, unsettled amount, dividends in transit, pending deposits, interest and fees, and amounts used by margin financing and short selling. Use it on the Cash Details page to expand each currency. Pass currency to query one currency; omit it to return all currencies. For counts of frozen, unsettled, fund subscription, and IPO subscription items, use it with Get Cash Status Labels.

WhaleCore portfolioService() already wraps this capability through the cash detail switch (cashDetailEnable; once on, the asset push includes cash details). When you use WhaleCore, prefer the WhaleCore capability over calling this operation directly.

GEThttps://api.lbkrs.com/v5/portfolio/cash_info

Parameters

account_channelstringquery

Account channel. Use the account_channel of the current account

currencystringquery

Query only this currency, such as HKD. Omit it to return all currencies

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get cash details by currency” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
account_channelstring

Account channel

account_nostring

Account number

cash_balancearray<object>

Cash details by currency

Child attributes
currencystring

Currency code, such as HKD or USD

total_amountstring

Total cash in the currency

balancestring

Cash balance

withdraw_cashstring

Available balance, which is the withdrawable cash

withdraw_cash_ex_mmfstring

Withdrawable cash excluding money market funds

frozen_buy_cashstring

Frozen funds held by pending buy orders

outstandingstring

Unsettled amount

external_amountstring

Amount withheld for IPO subscriptions

pending_depositstring

Deposit amount not yet credited

dividends_in_transitstring

Dividends in transit. You can hide it when it is 0

opening_balance_todaystring

Opening cash balance

interest_amountstring

Total interest

credit_intereststring

Credit interest

debit_intereststring

Debit interest

financing_intereststring

Margin financing interest

security_lending_intereststring

Securities lending interest

margin_amountstring

Margin financing amount

short_occupiedstring

Amount used by short positions

portfolio_management_feestring

Portfolio management fee

va_custody_feestring

Virtual asset custody fee

Whale Docs