Skip to content
Fund Strategy

Save Strategy Filter

Create or edit a portfolio-screening strategy package.

Request parameters

  • Required: name_locales (localized package name), conditions (hit condition list), display_cols (display column config), hit_funds (hit fund list).
  • Optional: id (package ID, provided when editing), subtitle_locales (localized subtitle), header_image_locales (localized header image), show_quick_filter (show quick filter), show_homepage (show on homepage), sort (sort order), status (status).
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Providing id edits an existing package; omitting it creates a new one. conditions defines the screening criteria, hit_funds is the set of matched funds, and display_cols controls the displayed columns.

Risk warning

This operation changes the content and display of portfolio screening on the client. Confirm the conditions and hit funds before calling.

Returns

On success returns the ID of the saved strategy package.

POSThttps://b-api.lbkrs.com/v1/admin/strategy/save

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.strategy_update

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

Request body application/json

idinteger

Strategy Package ID. Leave empty or 0 when creating; pass an existing strategy package ID when editing.

name_localesstringrequired

Name (Locales). This field is required.

subtitle_localesstring

Subtitle (Locales).

header_image_localesstring

Header Image (Locales).

show_quick_filterinteger

Show Quick Filter.

Allowed values: 1 Shown on the filter page, 0 Not shown

Values
1
Yes (show in quick filter)
0
No
show_homepageinteger

Show On Homepage.

Allowed values: 1 Shown on the homepage, 0 Not shown

Values
1
Yes (show on homepage)
0
No
sortinteger

Sort.

statusinteger

Status.

Allowed values: 0 Draft, 1 Online, 2 Offline

Values
0
Draft
1
Online
2
Offline
conditionsarray<object>required

Conditions. This field is required.

Child attributes
dimensionstring

Dimension.

metricstring

Metric.

periodstring

Period.

rulestring

Rule.

valuesstring

Values.

display_colsarray<object>required

Display Columns. This field is required.

Child attributes
col_indexinteger

Column Index.

original_metricstring

Original Metric.

is_default_sortinteger

Is Default Sort.

Allowed values: 1 Yes (default sort column), 0 No

Values
1
Yes (default sort column)
0
No
hit_fundsarray<object>required

Hit Funds. This field is required.

Child attributes
counter_idstring

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

statusinteger

Status.

Values
0
1

Responses

HTTP 200The request was processed successfully. data.id is the ID of the saved strategy package.
Standard response envelopecodemessagedata
dataobjectdata structure
idinteger

Strategy Package ID. ID of the saved strategy package.

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