Skip to content
Option Market

Get option ranking list

Returns a page of an option ranking by category, sort indicator, and direction. The market home page module uses scene=index with the default sort of the category; the full ranking page uses scene=extra and supports sorting and paging. The indicators[] of each row gives raw values in the order of the category indicators; format them with the matching format and color. This operation only reads data and has no side effects. If the request fails, the Broker App keeps the loaded data and lets the Client retry.

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

Parameters

scenestringqueryRequired

Usage scene:

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

indexextra

categorystringqueryRequired

Category key, from categories[].key

indicatorstringqueryRequired

Sort indicator key: the category master_indicator or the key of a sortable indicator

orderstringqueryRequired

Sort direction: desc for descending, asc for ascending

descasc

offsetintegerqueryRequired

Start offset, starting from 0

limitintegerqueryRequired

Number of rows to return

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 list” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Ranking rows

Child attributes
counter_idstring

Security ID (counter_id). Depending on the category, an underlying or an option contract

namestring

Security name

codestring

Security code

indicatorsarray<string>

Raw value of each indicator column

Whale Docs