Skip to content
Market Rankings

Get List Indicator Configuration

Retrieves the indicator columns and default sort of a list for a scene, used to render the list's column headers. It is currently used for the active expiring options list and the related ETFs list on the security detail page; after getting the default sort, call the corresponding list operation.

GEThttps://api.lbkrs.com/newmarket/rank/indicator/config

Parameters

scenestringqueryRequired

List scene:

  • expiring_option - Active expiring options list
  • index_etf - Related ETFs list of a security

expiring_optionindex_etf

Responses

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

Indicator columns in display order; show an empty state when empty

Child attributes
keystring

Indicator key, for example last_done or chg; pass it to the list operation as the sort indicator

namestring

Display name of the indicator, used as the column header

is_sortboolean

Whether the column can be sorted

formatstring

Display format of the indicator value:

  • percent_signed - Multiply by 100 and show as a signed percentage
  • percent - Multiply by 100 and show as a percentage
  • big - Show as an abbreviated large number
  • raw - Show as is
colorstring

How to color the indicator value:

  • volatile - Use up and down colors by sign
  • regular - Use the regular text color
default_configobject

Default sort

Child attributes
keystring

Default sort indicator key

orderinteger

Default sort direction: 1 is descending; other values are ascending

Whale Docs