https://api.lbkrs.com/v1/calc/op/screener/searchRequest body application/json
Underlying stock security ID (counter_id)
Expiration date in YYYYMMDD format. Use expire_date from List Expiration Dates for Option Strategies.
Scenario:
1- Expect the price to rise to the target2- Expect the price to fall to the target3- Expect a large move, at least to one boundary of the range4- Expect the price to stay within the range5- Holding the stock and hedging downside risk6- Holding the stock and collecting premium to improve returns
Scenarios 1, 2, 5, and 6 require price; scenarios 3 and 4 require up_price and down_price.
123456
Target price for single-target scenarios. Pass an empty string for other scenarios.
Upper bound of the price range for range scenarios. Pass an empty string for other scenarios.
Lower bound of the price range for range scenarios. Pass an empty string for other scenarios.
Stock position:
0- No position1- Long2- Short
012
Average cost of the stock position. Pass it when side is 1 or 2; pass an empty string when there is no position.
Filter by opening direction:
0- All1- Sell2- Buy
012
Sort field:
0- Probability of profit1- Maximum profit2- Maximum loss
012
Sort order:
0- Descending1- Ascending
01
Page number, starting from 1
Number of items per page. Fewer items than size means there are no more results.
Responses
HTTP 200The request succeeded. The response body contains the result of the “Search Option Strategy Recommendations” operation.codemessagedatadataobjectdata structureRecommended strategies, sorted by sort_key and order
Child attributes
Strategy title
Strategy type:
1- Long Call2- Long Put3- Short Call4- Short Put5- Covered Call6- Covered Put7- Protective Call8- Protective Put9- Long Straddle10- Long Strangle15- Bull Call spread16- Bull Put spread17- Bear Call spread18- Bear Put spread19- Short Straddle20- Short Strangle
12345678910151617181920
One leg of the strategy (stock or option contract)
Child attributes
Security ID (counter_id) of the leg, for example ST/US/AAPL for a stock or OP/US/AAPL261120C230000 for an option
Security name
Order direction of the leg:
0- Buy1- Sell
01
Option type:
C- CallP- Put
Not applicable to a stock leg
Strike price. Not applicable to a stock leg
Expiration date in YYYYMMDD format. Not applicable to a stock leg
Security type:
ST- StockOP- Option
STOP
Legs of a multi-leg strategy. May include both stock and option legs.
Child attributes
Security ID (counter_id) of the leg, for example ST/US/AAPL for a stock or OP/US/AAPL261120C230000 for an option
Security name
Order direction of the leg:
0- Buy1- Sell
01
Option type:
C- CallP- Put
Not applicable to a stock leg
Strike price. Not applicable to a stock leg
Expiration date in YYYYMMDD format. Not applicable to a stock leg
Security type:
ST- StockOP- Option
STOP
Premium direction when opening the position:
debit- Net premium paidcredit- Net premium received
debitcredit
Latest price of the strategy
Probability of profit as a decimal, for example 0.396 for 39.6%
Maximum profit. An empty value means the profit is theoretically unlimited.
Maximum loss. An empty value means the loss is theoretically unlimited.
Risk reminder type:
0- No reminder1- Covered Call reminder: selling the stock position during the period leaves the call option naked, which may raise the margin requirement2- Covered Put reminder: closing the short position during the period leaves the put option naked, which may raise the margin requirement
012