search
HomeGithubDiscordBlog

OptionsMultiOrder

hashtag
OptionsMultiOrder

hashtag
Options Multi-Order

hashtag
Endpoint URL

This API Function Places Multiple Option Legs with Common Underlying by Auto-Resolving Symbols based on Offset. BUY legs are executed first for margin efficiency, then SELL legs.

Local Host   :  POST http://127.0.0.1:5000/api/v1/optionsmultiorder
Ngrok Domain :  POST https://<your-ngrok-domain>.ngrok-free.app/api/v1/optionsmultiorder
Custom Domain:  POST https://<your-custom-domain>/api/v1/optionsmultiorder

hashtag
Sample API Request (Iron Condor Strategy)

{
    "apikey": "<your_app_apikey>",
    "strategy": "Iron Condor",
    "underlying": "NIFTY",
    "exchange": "NSE_INDEX",
    "legs": [
        {
            "offset": "OTM10",
            "option_type": "CE",
            "action": "BUY",
            "quantity": 75,
            "expiry_date": "30DEC25",
            "splitsize": 0
        },
        {
            "offset": "OTM10",
            "option_type": "PE",
            "action": "BUY",
            "quantity": 75,
            "expiry_date": "30DEC25",
            "splitsize": 0
        },
        {
            "offset": "OTM5",
            "option_type": "CE",
            "action": "SELL",
            "quantity": 75,
            "expiry_date": "30DEC25",
            "splitsize": 0
        },
        {
            "offset": "OTM5",
            "option_type": "PE",
            "action": "SELL",
            "quantity": 75,
            "expiry_date": "30DEC25",
            "splitsize": 0
        }
    ]
}

hashtag
Sample API Response (Live Mode)

hashtag
Sample API Response (Analyze Mode)

hashtag
Sample API Request (Straddle with LIMIT Orders)

hashtag
Sample API Request (Future as Underlying)

hashtag
Parameter Description (Request Level)

Parameters
Description
Mandatory/Optional
Default Value

apikey

App API key

Mandatory

-

strategy

Strategy name

Mandatory

-

underlying

Underlying symbol (NIFTY, BANKNIFTY, NIFTY30DEC25FUT)

Mandatory

-

exchange

Exchange code (NSE_INDEX, NSE, NFO, BSE_INDEX, BSE, BFO)

Mandatory

-

legs

Array of leg objects (1-20 legs)

Mandatory

-

*Note: expiry_date should be specified per-leg to support calendar and diagonal spreads

hashtag
Parameter Description (Per Leg)

Parameters
Description
Mandatory/Optional
Default Value

offset

Strike offset (ATM, ITM1-ITM50, OTM1-OTM50)

Mandatory

-

option_type

Option type (CE for Call, PE for Put)

Mandatory

-

action

Action (BUY/SELL)

Mandatory

-

quantity

Quantity (must be multiple of lot size)

Mandatory

-

expiry_date

Expiry date in DDMMMYY format (e.g., 30DEC25)

Mandatory

-

splitsize

Auto-split order into chunks of this size (0=no split)

Optional

0

pricetype

Price type (MARKET/LIMIT/SL/SL-M)

Optional

MARKET

product

Product type (MIS/NRML)**

Optional

MIS

price

Limit price

Optional

0

trigger_price

Trigger price for SL orders

Optional

0

disclosed_quantity

Disclosed quantity

Optional

0

**Note: Options only support MIS and NRML products (CNC not supported)

***Note: Per-leg expiry_date enables diagonal and calendar spreads with different expiries in a single API call

hashtag
Response Parameters

Parameter
Description
Type

status

API response status (success/error)

string

underlying

Underlying symbol from request

string

underlying_ltp

Last Traded Price of underlying

number

mode

Trading mode (analyze/live)***

string

results

Array of leg results

array

***Note: mode field is only present in Analyze Mode responses

hashtag
Result Parameters (Per Leg)

Parameter
Description
Type

leg

Leg number (1, 2, 3, ...)

number

symbol

Resolved option symbol

string

exchange

Resolved exchange (NFO/BFO)

string

offset

Strike offset from request

string

option_type

Option type (CE/PE)

string

action

Action (BUY/SELL)

string

status

Leg status (success/error)

string

orderid

Broker order ID (or SB-xxx for analyze mode)

string

message

Error message (only if status is error)

string

hashtag
Execution Order - BUY First Strategy

The API automatically sorts and executes legs in the following order for margin efficiency:

  1. BUY legs execute first (in parallel) - establishes long positions

  2. Wait for all BUY orders to complete

  3. SELL legs execute next (in parallel) - establishes short positions

This order ensures:

  • Margin benefit from hedged positions

  • Better fill rates on protective legs

  • Reduced margin requirements for spreads

hashtag
Live Mode vs Analyze Mode

Live Mode

  • When: Analyze Mode toggle is OFF in OpenAlgo settings

  • Behavior: Places real orders with connected broker

  • Order ID Format: Broker's order ID (e.g., "240123000001234")

  • Response: No "mode" field present

Analyze Mode (Sandbox)

  • When: Analyze Mode toggle is ON in OpenAlgo settings

  • Behavior: Places virtual orders in sandbox environment

  • Order ID Format: Sandbox ID with "SB-" prefix (e.g., "SB-1234567890")

  • Response: Includes "mode": "analyze" field

  • Features: Virtual capital, realistic execution, auto square-off

Note: Same API call works in both modes. The system automatically detects which mode is active.

hashtag
Common Option Strategies with Request/Response Examples

1. Iron Condor (4 Legs)

Request:

Response:

2. Long Straddle (2 Legs)

Request:

Response:

3. Short Straddle (2 Legs)

Request:

Response:

4. Short Strangle (2 Legs)

Request:

Response:

5. Bull Call Spread (2 Legs)

Request:

Response:

6. Bear Put Spread (2 Legs)

Request:

Response:

7. Iron Butterfly (4 Legs)

Request:

Response:

8. Long Call Butterfly (3 Legs)

Request:

Response:

9. Call Ratio Spread (1:2 Ratio)

Request:

Response:

10. Jade Lizard (3 Legs)

Request:

Response:

11. Put Ratio Spread (1:2 Ratio)

Request:

Response:

12. Calendar Spread (Different Expiries - Single API Call)

Note: Calendar spreads use the same strike but different expiry dates. Use per-leg expiry_date to specify different expiries.

Request:

Response:

13. Diagonal Spread (Different Strikes & Expiries - Single API Call)

Note: Diagonal spreads combine different strike prices AND different expiry dates. Use per-leg expiry_date to specify different expiries.

Request (Bullish Diagonal Call Spread):

Response:

Note: BUY legs always execute first for margin efficiency, regardless of order in the request.

hashtag
Product Types for Options

Product
Description
Margin
Square-off
Use Case

MIS

Margin Intraday

Lower

Auto (3:15 PM)

Intraday trading

NRML

Normal (Carry Forward)

Higher

Manual

Overnight positions

Note: CNC (Cash & Carry) is not supported for options trading.

hashtag
Error Response

hashtag
Partial Success Response

hashtag
Common Error Messages

Error Message
Cause
Solution

Invalid openalgo apikey

API key is incorrect or expired

Check API key in settings

Option symbol not found

Calculated strike doesn't exist

Check offset and expiry_date

Quantity must be a positive integer

Invalid quantity value

Provide valid quantity

Insufficient funds

Not enough margin (Live mode)

Add funds or reduce quantity

Master contract needs update

Symbol database is outdated

Update master contract data

Legs must contain 1 to 20 items

Too many or no legs provided

Provide 1-20 legs

hashtag
Features

  1. Multi-Leg Execution: Execute up to 20 legs in a single API call

  2. BUY-First Strategy: Automatically executes BUY legs before SELL for margin efficiency

  3. Parallel Execution: Legs within same group (BUY/SELL) execute in parallel

  4. Auto Symbol Resolution: Automatically calculates ATM and resolves option symbols

  5. Dual Mode Support: Works in both Live and Analyze (Sandbox) modes

  6. All Order Types: Supports MARKET, LIMIT, SL, and SL-M orders per leg

  7. Real-time LTP: Uses current market price for ATM calculation

  8. Strategy Tracking: Associates all legs with strategy name for analytics

  9. Telegram Alerts: Automatic notifications for order placement

  10. Partial Success Handling: Returns status for each leg individually

hashtag
Rate Limiting

  • Limit: 10 requests per second

  • Scope: Per API endpoint

  • Response: 429 status code if limit exceeded

hashtag
Best Practices

  1. Test in Analyze Mode First: Enable Analyze Mode to test strategies without real money

  2. Verify Lot Sizes: Ensure all leg quantities are multiples of lot size

  3. Verify Offset: Ensure offset value is valid (ATM, ITM1-ITM50, OTM1-OTM50)

  4. Use Appropriate Product: MIS for intraday, NRML for overnight

  5. Handle Partial Failures: Check status of each leg in response

  6. Monitor Margin: Check available margin before placing multi-leg orders

  7. Update Master Contracts: Keep symbol database updated for accurate symbol resolution

  8. Consistent Quantities: Use same quantity across legs for proper hedging

  9. Use BUY-First Design: Let the API handle execution order for margin benefits

hashtag
Comparison with Single Options Order

Feature
optionsorder
optionsmultiorder

Legs per call

1

1-20

API calls needed

Multiple for strategy

Single for entire strategy

Execution control

Manual sequencing

Automatic BUY-first

Margin efficiency

Depends on order

Optimized automatically

Error handling

Per order

Per leg with partial success

Latency

Higher (multiple RTT)

Lower (single RTT)

hashtag
Use Cases

  1. Spread Strategies: Bull/Bear spreads, ratio spreads

  2. Volatility Strategies: Straddles, strangles, butterflies

  3. Income Strategies: Iron condors, jade lizards

  4. Hedging: Multi-leg protective positions

  5. Complex Combos: Custom multi-leg strategies

PreviousOptionsOrderNextBasketOrder

Last updated