Skip to content
Longport WhaleLongport Whale
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 price trend, available expiration dates, leverage level, sort order, strategy type, and strategy filter, 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 /v2/calc/op/guide/search.

GEThttps://api.lbkrs.com/v2/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 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
tendencyarray<object>

Price trend candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 1 - Up
  • 2 - Down
Values
1
2
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

leveragearray<object>

Leverage level candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 1 - Low Leverage
  • 2 - Medium Leverage
  • 3 - High Leverage
Values
1
2
3
defaultboolean

Whether this is the default selected item

sortarray<object>

Sort order candidate list

Child attributes
namestring

Name

valueinteger

Sort order value. Observed values are 0 (price ascending) and 3 (win probability descending)

strategyarray<object>

Strategy type description list, used to explain the meaning of items[].strategy in the search results

Child attributes
namestring

Strategy name

valueinteger

Value:

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

Strategy introduction text

imagestring

Strategy icon URL

actioninteger

Action direction:

  • 0 - Buy
  • 1 - Sell
Values
0
1
image_detailstring

Strategy detail image URL

filterarray<object>

Strategy filter candidate list

Child attributes
namestring

Name

valueinteger

Value:

  • 0 - All
  • 1 - Buy Call
  • 2 - Sell Call
  • 3 - Buy Put
  • 4 - Sell Put (note that this numbering differs from strategy[].value)
Values
0
1
2
3
4
tendencysarray<integer>

List of price trend values this filter option applies to

Whale Docs