Skip to content
Fund Management

Toggle Fund Visibility

Show or hide a fund in the App display layer, for a single fund or in batch. Public and private funds share this endpoint, distinguished by type.

Request parameters

  • Required: option (show or hide), type (fund type: fund for public, private for private).
  • Optional: counter_id (single symbol), counter_ids (symbol list for batch), audit_frontend_resource (audit context).
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Pass counter_id for a single fund or counter_ids for batch; option controls show or hide. This only affects App display and does not change the fund's listing (on/off shelf) status.

Risk warning

This operation changes a fund's visibility to customers in the App. Confirm the symbols and target state before calling.

Returns

On success the show/hide change is applied; see the 200 response for the exact payload.

POSThttps://b-api.lbkrs.com/funds/admin/toggle-fund

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

counter_idstring

Counter ID. Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

counter_idsarray<string>

Counter ID List. Submit Counter ID List as a JSON array.

optionbooleanrequired

Show. Boolean flag for show. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
typestringrequired

Fund Type. Specifies Fund Type. This field is required.

Values
fund
Public Fund
private
Private Fund
audit_frontend_resourceobject

Audit Context. Provides audit context for this operation.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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