Skip to content
Fund Screening

Filter Funds

Returns funds that match filter conditions or a quick filter, used on the fund list (ranking) page and the fund filter page. Advanced and quick filters are mutually exclusive:

  • Quick filter: pass an empty filter object and set quick_ids to the selected quicks[].id.
  • Advanced filter: pass an empty quick_ids array and organize conditions by dimension in filter.

The field names of filter are the dimension key values returned by GET /v2/funds/options (such as fund_attr, return, risk, and cost_performance). Each value is an object whose field names are indicator key values and whose values are arrays. For attribute indicators, pass the selected options[].key values: numeric codes (such as asset_class and risk_level) as integers and others as strings. For metric conditions, pass both the period leaf (such as return_rate_period) and the value leaf ([min, max] for a range, [value] for a single value). When neither mode carries any condition, all funds are returned.

Parse list items as FundB30Summary; earning_rate covers the period in time_interval. This operation is read-only.

POSThttps://api.lbkrs.com/v2/funds

Request body application/json

filterobjectrequired

Advanced filter conditions organized by dimension key; pass an empty object for a quick filter

Child attributes
fund_attrobject

Fund attribute conditions

Child attributes
asset_classarray<integer>

Fund type:

  • 1 - Money market
  • 2 - Bond
  • 3 - Balanced
  • 4 - Equity
  • 5 - Commodity

Prefer the server-provided asset_class_name for display

risk_levelarray<integer>

Product risk level:

  • 1 - Low
  • 2 - Low to medium
  • 3 - Medium
  • 4 - Medium to high
  • 5 - High
currencyarray<string>

Trading currencies, such as HKD or USD

fund_companyarray<string>

Fund companies, using option key values from the filter options

industryarray<string>

Top-holding industries, using option key values from the filter options

quick_idsarray<integer>

Quick filter IDs; pass an empty array for an advanced filter

time_intervalarray<string>required

Return period shown in the list, as a one-element array; defaults to ["1y"]. Same values as FundB30Summary.time_interval

Responses

HTTP 200The request succeeded. The response body contains the result of the “Filter Funds” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
fundsarray<object>

Matching funds

Child attributes
counter_idstring

Fund security ID starting with UT/; use it to open fund details or place orders

codestring

Fund display code

isinstring

ISIN

namestring

Fund name

currencystring

Trading currency, such as HKD or USD

asset_classinteger

Fund type:

  • 1 - Money market
  • 2 - Bond
  • 3 - Balanced
  • 4 - Equity
  • 5 - Commodity

Prefer the server-provided asset_class_name for display

Values
1
2
3
4
5
asset_class_namestring

Localized fund type name from the server

risk_levelinteger

Product risk level:

  • 1 - Low
  • 2 - Low to medium
  • 3 - Medium
  • 4 - Medium to high
  • 5 - High
Values
1
2
3
4
5
risk_level_namestring

Localized risk level name from the server

earning_ratestring

Return over time_interval, as a decimal; for example, 0.0523 means 5.23%

time_intervalstring

Return period:

  • ytd - Year to date
  • 1d - Past day
  • 1w - Past week
  • 1m - Past month
  • 3m - Past 3 months
  • 6m - Past 6 months
  • 1y - Past year
  • 2y - Past 2 years
  • 3y - Past 3 years
  • 5y - Past 5 years
  • 10y - Past 10 years
  • etd - Since inception
Values
ytd
1d
1w
1m
3m
6m
1y
2y
3y
5y
10y
etd
purchase_amountstring

Minimum subscription amount in currency

unit_valuestring

Latest unit NAV

holdingboolean

Whether the current account holds the fund

profilestring

Fund profile

descriptionstring

Fund description

recommendation_textstring

Recommendation text

fund_performancesarray<object>

Performance trend points by date; returned only for best-selling funds

Child attributes
datestring

Date

last_donestring

Unit NAV on that date

Whale Docs