Skip to content
ETF Screener

Get ETF Screener Configuration

Returns the top-level and second-level categories, filters, and returnable indicator columns for ETF screening in a market. Use it to render the category tabs, filter panel, and list header in the ETF section. Use the category keys, filters, and column keys to build Search ETFs requests.

GEThttps://api.lbkrs.com/calc/filter/etf/config

Parameters

marketstringqueryRequired

Market code, for example US or HK

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get ETF Screener Configuration” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
titlesarray<object>

Top-level categories with their second-level categories

Child attributes
keystring

Top-level category key; use it as first_title_key in search

namestring

Top-level category name

sec_titlesarray<object>

Second-level categories; use key as sec_title_key in search

Child attributes
keystring

Key

namestring

Display name

filtersarray<object>

Filters

Child attributes
keystring

Filter key; use it as filters[].key in search

namestring

Filter name

itemsarray<object>

Options. The first option is the default “All” option

Child attributes
namestring

Option name

valuestring

Option value; use it as filters[].value in search

returnsarray<object>

Returnable indicator columns

Child attributes
keystring

Indicator key; use it in returns and as sort_key in search

namestring

Column name

is_sortboolean

Whether the list can be sorted by this column

formatstring

Value format:

  • percent - Decimal shown as a percentage
  • percent_signed - Decimal shown as a signed percentage
  • big - Abbreviated large number
  • raw - Shown as returned
colorstring

Color rule:

  • volatile - Colored by rise or fall
  • regular - Regular color
Whale Docs