Skip to content
Longport WhaleLongport Whale
Cash

Query Account Cash Balance

Returns the cash-balance information for a securities account, with optional currency filtering.

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

Returns the account's total cash total_cash, total available cash total_available_cash, total withdrawable cash total_withdraw_cash, and the per-currency cash breakdown cash_list.

Unlike the full-cash query endpoint, this one accepts currency to filter by a single currency; omit currency to return all currencies.

Returns

On success, returns the account cash-balance information. See the response definition for field meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

portfolio.asset

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

Parameters

account_nostringRequired

Account Number

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

currencystring

currency

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
total_cashstringrequired

total cash amount. total cash amount

total_available_cashstringrequired

total available amount. total available amount

total_withdraw_cashstringrequired

total withdraw cash amount. total withdraw cash amount

cash_listarray<object>required

cash lish. cash lish

Child attributes
currencystringrequired

currency type. currency type

cash_amountstringrequired

cash amount. cash amount

available_amountstringrequired

aviable amount. aviable amount

withdraw_amountstringrequired

withdrawable amount. withdrawable amount

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