Skip to content
Market Data

Get Option Strategy Guide Configuration

Get the filter configuration for the option strategy guide (the “Strategy Guide” feature on the option chain page). The response includes candidate lists across dimensions such as investment objective, available expiration dates, price trend, sort order, strategy type, and investment style, used to render the filter conditions on the guide page. Each candidate item's value is the value to pass to the corresponding parameter of POST /calc/op/guide/search.

GEThttps://api.lbkrs.com/calc/op/guide/config

Parameters

counter_idstringqueryRequired

Underlying stock counter_id

quote_colorintegerqueryRequired

Price trend color scheme:

  • 0 - Red for gains, green for losses
  • 1 - Red for losses, green for gains; affects the color scheme of the returned strategy[].image and image_detail images

01

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Option Strategy Guide Configuration” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
expectationarray<object>

Investment objective candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 1 - Trend Profit
  • 2 - Steady Profit

12

descriptionstring

Explanatory text for this investment objective

expire_datearray<object>

Available expiration date list

Child attributes
namestring

Expiration date display text, in YYYY.MM.DD format

valueinteger

Expiration date, in YYYYMMDD format

to_daysinteger

Days remaining from now

tendencyarray<object>

Price trend candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 1 - Up
  • 2 - Down

12

sortarray<object>

Sort order candidate list

Child attributes
namestring

Name

valueinteger

Sort order value. Observed values include 0 (price ascending) and 3 (win probability descending); the available sort orders may differ across investment objective + price trend combinations (see the items field)

itemsarray<object>

The investment objective + price trend combinations this sort order applies to

Child attributes
expectationinteger

Investment objective value

tendencyinteger

Price trend value

strategyarray<object>

Strategy type candidate list

Child attributes
namestring

Strategy name

valueinteger

Value:

  • 1 - Buy Call
  • 2 - Sell Put
  • 3 - Sell Call
  • 4 - Buy Put

1234

introductionstring

Strategy introduction text

imagestring

Strategy icon URL

actioninteger

Action direction:

  • 0 - Buy
  • 1 - Sell

01

image_detailstring

Strategy detail image URL

stylearray<object>

Investment style candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 1 - Conservative
  • 2 - Moderate
  • 3 - Aggressive

123

defaultboolean

Whether this is the default selected item

Whale Docs