Skip to content
Option Market

Filter underlyings with active expiring options

Returns a page of underlyings with active expiring options by security type, sort indicator, and direction, for the stock and ETF tabs, sorting, and paging of the full Active expiring options page. The indicator columns come from GET /newmarket/rank/indicator/config (scene=expiring_option), and indicator[] follows that order. Fewer rows than limit means there is no more data. This operation only reads data and has no side effects. If the request fails, the Broker App shows an empty state and lets the Client retry.

POSThttps://api.lbkrs.com/newmarket/expire_option/filter

Request body application/json

security_typeintegerrequired

Underlying type:

  • 1 - Stock
  • 2 - ETF
Values
1
2
sort_indicatorstringrequired

Sort indicator key. The Broker App uses option_vol (option volume) by default

orderstringrequired

Sort direction:

  • 1 - Descending
  • 0 - Ascending
Values
1
0
limitintegerrequired

Page size. The Broker App uses 20

offsetintegerrequired

Start offset, starting from 0

Responses

HTTP 200The request succeeded. The response body contains the result of the “Filter underlyings with active expiring options” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
itemsarray<object>

Underlyings

Child attributes
counter_idstring

Underlying ID (counter_id). Open the option chain of the underlying when selected

namestring

Underlying name

codestring

Underlying code. Returned only by the filter endpoint

last_donestring

Last price of the underlying

chgstring

Change of the underlying as a decimal

amountstring

Turnover

optionsarray<object>

Active expiring options of the underlying

Child attributes
counter_idstring

Option contract ID (counter_id)

namestring

Option contract name

last_donestring

Last price

chgstring

Change as a decimal (0.05 means 5%)

amountstring

Turnover

expire_timestring

Expiry time as a Unix timestamp in seconds. Use it for the expiry countdown; show expired when it is earlier than the current time

volume_trendobject

Option volume trend for the trend chart

Child attributes
dataarray<object>

Trend points

Child attributes
datastring

Volume at this point

timestampstring

Time of this point as a Unix timestamp in seconds

point_countinteger

Total number of points on the chart, used for the x-axis length

indicatorarray<string>

Raw value of each indicator column. Returned only by the filter endpoint. The order matches the indicators returned by GET /newmarket/rank/indicator/config (scene=expiring_option)

Whale Docs