Skip to content
Option Market

Get market option alerts

Returns the latest market-wide option alerts of one alert type for the large-order and unusual-volume cards of the Option alerts module on the market page. To view all alerts of one underlying, use GET /v1/opchange/underlying/statistic, GET /v1/opchange/bigorder/lists, and GET /v1/opchange/unusualvol/lists. This operation only reads data and has no side effects. If the request fails, the Broker App shows an empty state.

GEThttps://api.lbkrs.com/v1/opchange/show/market/lists

Parameters

change_typeintegerqueryRequired

Alert type:

  • 1 - Large order
  • 2 - Unusual volume

12

limitintegerqueryRequired

Number of records to return. The Broker App uses 4

Responses

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

Alert records, newest first

Child attributes
idstring

Alert record ID

counter_idstring

Option contract ID (counter_id). Open the contract details when selected

namestring

Option contract name

alert_namestring

Alert name, such as large buy order or large sell order

alert_typestring

Alert subtype. For 12 or 13, show a direction arrow based on emotion and show the time as hours, minutes, and seconds. For other subtypes, show the time as month and day

alert_timestring

Alert time as a Unix timestamp in seconds. Display it in the time zone of the contract market

emotioninteger

Direction:

  • 1 - Positive (up arrow)
  • 2 - Negative (down arrow)
change_valuesarray<string>

Alert values. The Broker App shows the first value

Whale Docs