Put/Call Option Chain

API to retrieve put/call option chain for an underlying symbol for a specific expiry date.

NOTE

The Put/Call Option chain is currently not available for the MCX Exchange.

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

Query Parameters

Name	Required	Type	Description
instrument_key	true	string	Key of an underlying symbol. For the regex pattern applicable to this field, see the Field Pattern Appendix.
expiry_date	true	string	Expiry date in format: YYYY-MM-DD.

Responses

• 200
• 4XX

---

Response Body

{
  "status": "success",
  "data": [
    {
      "expiry": "2024-02-15",
      "pcr": 1684.0638,
      "strike_price": 19500,
      "underlying_key": "NSE_INDEX|Nifty 50",
      "underlying_spot_price": 22122.25,
      "call_options": {
        "instrument_key": "NSE_FO|37263",
        "market_data": {
          "ltp": 2291.8,
          "close_price": 2259.9,
          "volume": 1200,
          "oi": 2350,
          "bid_price": 2292.85,
          "bid_qty": 50,
          "ask_price": 2302.25,
          "ask_qty": 800,
          "prev_oi": 0
        },
        "option_greeks": {
          "vega": 0,
          "theta": 0,
          "gamma": 0,
          "delta": 1,
          "iv": 0
        }
      },
      "put_options": {
        "instrument_key": "NSE_FO|37264",
        "market_data": {
          "ltp": 0.7,
          "close_price": 1.5,
          "volume": 12367100,
          "oi": 3957550,
          "bid_price": 0.65,
          "bid_qty": 382600,
          "ask_price": 0.7,
          "ask_qty": 88300,
          "prev_oi": 14400
        },
        "option_greeks": {
          "vega": 0.2278,
          "theta": -0.5966,
          "gamma": 0,
          "delta": -0.0026,
          "iv": 31.43
        }
      }
    }
  ]
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object	Data object for put/call option chain.
data[].expiry	string	Expiry date (for derivatives). Date format is YYYY-MM-dd.
data[].pcr	number	Put Call Ratio.
data[].strike_price	number	The strike price for the option.
data[].underlying_key	string	The instrument_key for the underlying asset.
data[].underlying_spot_price	number	The spot price for the underlying asset.
data[].call_options	object	Data object for call options
data[].call_options.instrument_key	string	The unique identifier used across Upstox APIs for instrument identification. For the regex pattern applicable to this field, see the Field Pattern Appendix.
data[].call_options.market_data	object	Call option market data
data[].call_options.option_greeks	object	Call option greeks
data[].put_options	object	Data object for call options
data[].put_options.instrument_key	string	The unique identifier used across Upstox APIs for instrument identification. For the regex pattern applicable to this field, see the Field Pattern Appendix.
data[].put_options.market_data	object	Put option market data
data[].put_options.option_greeks	object	Put option greeks

Option Market Data

Name	Type	Description
market_data.ltp	number	Last traded price.
market_data.close_price	number	Closed price.
market_data.volume	number	The total amount of the asset that was traded during the timeframe.
market_data.oi	number	Open interest.
market_data.bid_price	number	Bid price.
market_data.bid_qty	number	Bid quantity.
market_data.ask_price	number	Ask price.
market_data.ask_qty	number	Ask quantity.
market_data.prev_oi	number	Previous Open interest.

Option Greek Data

Name	Type	Description
option_greeks.vega	number	Rate of change of premium based on change in volatility.
option_greeks.theta	number	Measures the impact on premium based on time left for expiry.
option_greeks.gamma	number	Rate of change of delta itself.
option_greeks.delta	number	Measures the rate of change of options premium based on the directional movement of the underlying.
option_greeks.iv	number	Implied Volatality.

Error codes

Error code	Description
UDAPI100011	Invalid Instrument key - You need to provide proper instrument key for this operation.
UDAPI1088	Invalid date - You need to provide the expiry_date in proper format: YYYY-MM-DD

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...