Option Chain¶
The Option Chain API shows a list of all available Call and Put options for a stock or index. It helps users see prices, strike levels, and trading activity for each option. This is useful for traders to decide which option to buy or sell based on market data.It includes details like: Strike prices,Last traded prices,Open interest,Expiry date,Trading symbols
Type | API | Details |
---|---|---|
POST | optionChain/getUnderlying |
Get list of available underlying instruments |
POST | optionChain/getUnderlyingExp |
Get option chain data for expiry & underlying |
POST | optionChain/getOptionChain |
Get expiry dates for selected underlying |
Get Undrelying List¶
This API fetches a list of available underlying indices or instruments (e.g., BANKEX, SENSEX) for a specific exchange. It is used when a user selects an exchange and needs to choose from the supported underlyings for placing orders or filtering contracts.
Request Structure
Input Parameter
Field | Type | Description |
---|---|---|
exch | String | Exchange identifier (e.g., "Bse_fo" ) |
Response Structure
{
"status": "Ok",
"message": "Success",
"result": [
{
"list_underlying": [
"BANKEX",
"SENSEX"
]
}
]
}
Response Parameters
Field | Type | Description |
---|---|---|
status | String | Status of the API response (e.g., "Ok" ) |
message | String | Message describing the result (e.g., "Success" ) |
result | Array | Contains underlying instrument data |
list_underlying | Array | List of underlying indices/instruments for the exchange |
Get Underlying Expiry Date¶
This API returns the list of available expiry dates for a given underlying symbol from a specific exchange. It is typically used before fetching option chain data, so the client can select an expiry.
Request Structure
Input Parameter
Field | Type | Description |
---|---|---|
underlying | String | Underlying asset symbol (e.g., BANKEX ) |
exch | String | Exchange code (e.g., bse_fo ) |
Response Structure
{
"status": "Ok",
"message": "Success",
"result": [
{
"underlying": "BANKEX",
"underlying_expiry": [
"24JUN25",
"29JUL25",
"26AUG25"
]
}
]
}
Response Parameters
Field | Type | Description |
---|---|---|
status | String | API status (e.g., "Ok" ) |
message | String | Descriptive message (e.g., "Success" ) |
result | Array | Contains expiry data for the underlying |
underlying | String | Underlying symbol name (e.g., "BANKEX" ) |
underlying_expiry | Array | List of expiry dates available for the underlying |
Get Option Chain¶
This API retrieves the option chain data for a specific underlying instrument on a given expiry date. It returns both Call (CE) and Put (PE) option details for multiple strike prices, along with market metadata such as lot size, tick size, PCR, and token info. This is useful for option trading, analysis, or populating an options trading interface.
Request Structure
Input Parameter
Field | Type | Description |
---|---|---|
underlying | String | Underlying asset symbol (e.g., BANKEX ) |
expiry | String | Expiry date in ddMMMyy format |
interval | Number | Strike price interval |
exch | String | Exchange code (e.g., bse_fo ) |
Response Structure
{
"status": "Ok",
"message": "Success",
"result": [
{
"data": [ ... ],
"exchange": "bse_fo",
"futLTP": "0",
"futToken": "0",
"lotsize": "30",
"pcr": "0",
"spotLTP": "0",
"spotToken": "12",
"ticksize": "0.05"
}
]
}
Response Parameters
Field | Type | Description |
---|---|---|
status | String | API status ("Ok" if successful) |
message | String | API message ("Success" if successful) |
result | Array | Container holding the full option chain data |
data | Array | List of strike prices and their respective CE/PE data |
strikeprice | String | The strike price for the option |
exchange | String | Name of the exchange (e.g., bse_fo ) |
futLTP | String | Last traded price of the futures contract |
futToken | String | Token ID for the futures instrument |
lotsize | String | Lot size of the instrument |
pcr | String | Put-Call Ratio |
spotLTP | String | Last traded price of the spot instrument |
spotToken | String | Token ID for the spot instrument |
ticksize | String | Minimum price movement |
CE/PE | Object | Call or Put Option object for the strike |
forInsName | String | Full instrument name (e.g., BANKEX 24th JUN 61800 PE ) |
gval | String | Greeks value (optional, mostly "0" ) |
ltp | String | Last traded price of the option |
oi | String | Open interest |
pdc | String | Previous day close |
pdoi | String | Previous day open interest |
token | String | Unique token ID for the instrument |
tradingsymbol | String | Trading symbol used for placing orders |