Skip to content
Longport WhaleLongport Whale
Client Notification

Cash/balance Connect Details

Returns a per-currency breakdown of a client account's cash and Money Market Fund (MMF) balances, used by risk control to review a client's usable funds during margin call collection, currency-exchange reminders, and similar scenarios.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

Each record represents one currency and carries the ledger balance, settled balance, unsettled balance, cash available, MMF balance, and reference exchange rate.

The data comes from the client's fund snapshot and reconstructs the cash composition and MMF holdings by currency, helping assess how much can be applied to repayment or withdrawn.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_cash_mmf_detail

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes
idstring

Id

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
currencystring

Currency

total_amountstring

Ledger Balance

settled_amountstring

Settled Balance

outstanding_amountstring

Unsettled Balance

available_withdrawstring

Cash Available

mmf_valuesstring

MMF

exchange_ratestring

Ref Exchange Rate

totalintegerrequired

Total

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