Skip to content
Longport WhaleLongport Whale
Private Fund Management

Private Fund List Configuration (SaaS)

Query the private fund listing configuration, used by operations to maintain the private fund products shown in the App.

Request parameters

  • Combine business filters through filters (see the filters field notes below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

The data is the private fund listing configuration; each record represents one listable private fund product and its settings.

Each record carries the fund code, upstream internal code, localized fund name, asset class, channel, currency, risk level, subscription rate, share precision, listing status (for example Online), and last update time.

Typically used to search by fund code or upstream internal code and verify a private product's listing status and display parameters.

Returns

On success, returns the matched records and pagination information. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.fund_product

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

Request body application/json

filtersobject

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

Child attributes
counter_idstring

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.

counter_id_pstring

Pcounter ID. Filters results by Pcounter ID.

Values are dynamic. Call GET /v1/datasets/refs/private_fund_internal_codes to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

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 Private Fund List Configuration (SaaS) 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
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

counter_idstring

Fund Code. Returned value: Fund Code.

name_localsstring

Name. Returned value: Name.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

verifystring

Status. Returned value: Status.

verify_valstring

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

channel_namestring

Channel. Returned value: Channel.

channel_name_valstring

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

currencystring

Currency. Returned value: Currency.

pcounter_idstring

Pcounter ID. Returned value: Pcounter ID.

risk_levelstring

Risk Level. Returned value: Risk Level.

risk_level_valstring

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

asset_classstring

Type. Returned value: Type.

asset_class_valstring

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

purchase_rate_showstring

Purchase Rate. Returned value: Purchase Rate.

share_unitstring

Decimal Places For Units. Returned value: Decimal Places For 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