Skip to content
Fund Screening

Get Fund Filter Options

Returns the dimension, indicator, and option configuration of the advanced fund filter panel (dimensions) and the quick filter list (quicks), used in the quick filter strip of the fund list page and on the filter page. The panel layout is server-driven: render filter cards from dimensions[].indicators[], render attribute cards as single- or multiple-choice tags from options, and render metric cards as period options plus numeric inputs. After the Client selects conditions, call POST /v2/funds for results. For quick filters, read the match count from quicks[].total_count without another request.

GEThttps://api.lbkrs.com/v2/funds/options

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Fund Filter Options” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
dimensionsarray<object>

Filter dimensions

Child attributes
keystring

Dimension key, such as fund_attr (fund attributes), return, risk, or cost_performance; used as the field name in filter when submitting a filter

namestring

Dimension display name

span_countinteger

Default number of card columns per row in this dimension

indicatorsarray<object>

Filter cards in this dimension

Child attributes
keystring

Indicator key; used as the field name in the dimension object when submitting a filter

namestring

Indicator display name

select_typestring

Selection mode:

  • single - Single choice
  • multiple - Multiple choice
Values
single
multiple
span_countinteger

Number of option columns per row

node_typestring

Node type: an empty string is a regular node; input is a numeric input leaf

optionsarray<object>

Options

Child attributes
keystring

Option value; put it in the indicator array when submitting a filter

valuestring

Option display text

inputobject

Numeric input configuration

Child attributes
styleinteger

Input style:

  • 1 - Single value (for example, top X% in category ranking)
  • 2 - Range with start and end values (for example, return or maximum drawdown)
Values
1
2
content_typeinteger

Value type; 1 means percentage

minstring

Minimum allowed value

min_error_tipstring

Message shown when the input is below min

maxstring

Maximum allowed value

max_error_tipstring

Message shown when the input is above max

default_valuearray<string>

Default values: [min, max] for range input, [value] for single-value input

indicatorsarray<object>

Child nodes

quicksarray<object>

Quick filters

Child attributes
idinteger

Quick filter ID; put it in quick_ids when submitting a filter

titlestring

Title

sub_titlestring

Subtitle

total_countinteger

Number of matching funds

Whale Docs