Skip to content
Option Market

Get option ranking categories

Returns the option ranking categories of a usage scene, with the indicator columns and default sort of each category. Use them to render the category tabs and table header, and to get category, indicator, and order for GET /newmarket/op/rank/list. This operation only reads configuration and has no side effects. If the request fails, the Broker App hides the option ranking.

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

Parameters

scenestringqueryRequired

Usage scene:

  • index - Option ranking module on the market home page
  • extra - Full option ranking page

indexextra

typestringquery

Session type. Send extend during the US pre-market session when the Client has turned on pre-market quotes. Otherwise, send an empty string or omit it

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get option ranking categories” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
categoriesarray<object>

Ranking categories

Child attributes
keystring

Category key. Send it as category in the ranking list request

namestring

Category name

tipstring

Category explanation. When not empty, show an explanation entry

indicatorsarray<object>

Indicator columns. The order matches list[].indicators[] in the ranking list

Child attributes
keystring

Indicator key. Send it as indicator in the ranking list request

namestring

Indicator name, used as the column title

is_sortboolean

Whether the column can be sorted

formatstring

Value format:

  • percent_signed - Signed percentage after multiplying by 100
  • percent - Percentage after multiplying by 100
  • big - Abbreviated large number
  • Any other value - Display as is
colorstring

Coloring rule: volatile uses rise and fall colors by sign. Other values use the default text color

master_indicatorstring

Default sort indicator key

default_orderstring

Default sort direction: desc for descending, asc for ascending

Whale Docs