Skip to content
Longport WhaleLongport Whale
Configuration

Fund Balance Connect Position Info

Query the per-account holdings for a fund linked to Cash Plus (money-market fund), used by operators to gauge the impact before onlining, offlining, or removing a fund.

Request parameters

  • Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.
  • filters is required and must include counter_id.

Business notes

The data aggregates holdings of one fund by customer account. Specify the fund with counter_id, and optionally distinguish by equity_type (holding type).

Each record carries the securities account number and that account's holding units, counting only accounts with a non-zero position, so you can see how many customers hold a given fund and how many units each holds.

Returns

On success, returns the matching records with pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobjectrequired

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstringrequired

Fund Code. Filters results by Fund Code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000. Required.

equity_typestring

Equity Type. Filters results by Equity Type.

Allowed values: STOCK, FUND, MMF, OPTION, BOND, OTHER_OTC OTC

Values
STOCK
FUND
MMF
OPTION
BOND
OTHER_OTC
pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Fund Balance Connect Position Info records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
account_nostring

Account No.. Returned value: Account No..

account_no_valstring

Account No. (raw value). Raw value of account_no. The account_no field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

total_holdingstring

Holding Units. Returned value: Holding Units.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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