Market Info
Market Info¶
Get Index List¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id | |
| exch* | Exchange |
{
"request_time": "11:09:32 03-06-2024",
"values": [
{
"idxname": "HangSeng BeES-NAV",
"token": "26016"
},
{
"idxname": "India VIX",
"token": "26017"
},
{
"idxname": "Nifty 50",
"token": "26000"
},
{
"idxname": "Nifty IT",
"token": "26008"
},
{
"idxname": "Nifty Next 50",
"token": "26013"
},
{
"idxname": "Nifty Bank",
"token": "26009"
},
{
"idxname": "Nifty 500",
"token": "26004"
},
{
"idxname": "Nifty 100",
"token": "26012"
},
{
"idxname": "Nifty Midcap 50",
"token": "26014"
},
{
"idxname": "Nifty Realty",
"token": "26018"
},
{
"idxname": "Nifty Infra",
"token": "26019"
},
{
"idxname": "Nifty Energy",
"token": "26020"
},
{
"idxname": "Nifty FMCG",
"token": "26021"
},
{
"idxname": "Nifty MNC",
"token": "26022"
},
}
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok or Not_Ok | TopListNames success or failure indication. |
| values | Array Of Basket, Criteria pair. | |
| request_time | This will be present only in a successful response. | |
| emsg | This will be present only in case of errors. |
Basket, Criteria pair Object :
| Json Fields | Possiblevalue | Description |
|---|---|---|
| idxname | Index Name | |
| token | Index token used to subscribe |
Get Option Chain¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id | |
| tsym* | Trading symbol of any of the option or future. Option chain for that underlying will be returned. (use url encoding to avoid special char error for symbols like M&M) | |
| exch* | Exchange (UI need to check if exchange in NFO / CDS / MCX / or any other | |
| strprc* | Mid price for option chain selection | |
| cnt* | Number of strike to return on one side of the mid price for PUT and CALL. (example cnt is 4, total 16 contracts will be returned, if cnt is is 5 total 20 contract will be returned) |
{
"stat": "Ok",
"values": [
{
"exch": "NFO",
"token": "107231",
"tsym": "HEROMOTOCO27JUN24C5250",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5250.00"
},
{
"exch": "NFO",
"token": "90876",
"tsym": "HEROMOTOCO27JUN24C5300",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5300.00"
},
{
"exch": "NFO",
"token": "107238",
"tsym": "HEROMOTOCO27JUN24C5350",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5350.00"
},
{
"exch": "NFO",
"token": "90878",
"tsym": "HEROMOTOCO27JUN24C5400",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5400.00"
},
{
"exch": "NFO",
"token": "107277",
"tsym": "HEROMOTOCO27JUN24C5450",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5450.00"
},
{
"exch": "NFO",
"token": "90874",
"tsym": "HEROMOTOCO27JUN24C5200",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5200.00"
},
{
"exch": "NFO",
"token": "107213",
"tsym": "HEROMOTOCO27JUN24C5150",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5150.00"
},
{
"exch": "NFO",
"token": "90872",
"tsym": "HEROMOTOCO27JUN24C5100",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5100.00"
},
{
"exch": "NFO",
"token": "107211",
"tsym": "HEROMOTOCO27JUN24C5050",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5050.00"
},
{
"exch": "NFO",
"token": "90870",
"tsym": "HEROMOTOCO27JUN24C5000",
"optt": "CE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5000.00"
},
{
"exch": "NFO",
"token": "107236",
"tsym": "HEROMOTOCO27JUN24P5250",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5250.00"
},
{
"exch": "NFO",
"token": "90877",
"tsym": "HEROMOTOCO27JUN24P5300",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5300.00"
},
{
"exch": "NFO",
"token": "107273",
"tsym": "HEROMOTOCO27JUN24P5350",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5350.00"
},
{
"exch": "NFO",
"token": "90879",
"tsym": "HEROMOTOCO27JUN24P5400",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5400.00"
},
{
"exch": "NFO",
"token": "107281",
"tsym": "HEROMOTOCO27JUN24P5450",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5450.00"
},
{
"exch": "NFO",
"token": "90875",
"tsym": "HEROMOTOCO27JUN24P5200",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5200.00"
},
{
"exch": "NFO",
"token": "107216",
"tsym": "HEROMOTOCO27JUN24P5150",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5150.00"
},
{
"exch": "NFO",
"token": "90873",
"tsym": "HEROMOTOCO27JUN24P5100",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5100.00"
},
{
"exch": "NFO",
"token": "107212",
"tsym": "HEROMOTOCO27JUN24P5050",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5050.00"
},
{
"exch": "NFO",
"token": "90871",
"tsym": "HEROMOTOCO27JUN24P5000",
"optt": "PE",
"pp": "2",
"ls": "150",
"ti": "0.05",
"strprc": "5000.00"
}
]
}
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok or Not_Ok | Market watch success or failure indication. |
| values | Array of json objects. (object fields given in below table) | |
| emsg | This will be present only in case of errors. That is : 1) Invalid Input | |
| 2) Session Expired |
| Json Fields of object in values | Possiblevalue | Description |
|---|---|---|
| Array | ||
| exch | CDS, NFO ... | Exchange |
| tsym | Trading symbol of the scrip (contract) | |
| token | Token of the scrip (contract) | |
| optt | Option Type | |
| strprc | Strike price | |
| pp | Price precision | |
| ti | Tick size | |
| ls | Lot size |
Get Linked Scrips¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id | |
| token* | Trading symbol of any of the options or future. Option chain for that underlying will be returned. (use url encoding to avoid special char error for symbols like M&M) | |
| exch* | Exchange (UI need to check if exchange in NFO / CDS / MCX / or any other exchange which has options, if not don't allow) |
{
"request_time": "11:49:07 03-06-2024",
"stat": "Ok",
"equls": [
{
"exch": "NSE",
"token": "1348",
"tsym": "HEROMOTOCO-EQ",
"pp": "2",
"ti": "0.05",
"ls": "1",
"mult": "1"
},
{
"exch": "BSE",
"token": "500182",
"tsym": "HEROMOTOCO",
"pp": "2",
"ti": "0.05",
"ls": "1",
"mult": "1"
}
],
"fut": [
{
"exch": "NFO",
"token": "56428",
"tsym": "HEROMOTOCO29AUG24F",
"pp": "2",
"ls": "150",
"ti": "0.05",
"mult": "1",
"exd": "29-AUG-2024"
},
{
"exch": "NFO",
"token": "51772",
"tsym": "HEROMOTOCO25JUL24F",
"pp": "2",
"ls": "150",
"ti": "0.05",
"mult": "1",
"exd": "25-JUL-2024"
},
{
"exch": "NFO",
"token": "44193",
"tsym": "HEROMOTOCO27JUN24F",
"pp": "2",
"ls": "150",
"ti": "0.05",
"mult": "1",
"exd": "27-JUN-2024"
}
],
"opt_exp": [
{
"exd": "25-JUL-2024",
"tsym": "HEROMOTOCO25JUL24P7200",
"exch": "NFO"
},
{
"exd": "27-JUN-2024",
"tsym": "HEROMOTOCO27JUN24P6600",
"exch": "NFO"
},
{
"exd": "29-AUG-2024",
"tsym": "HEROMOTOCO29AUG24P7000",
"exch": "NFO"
}
]
}
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok or Not_Ok | Market watch success or failure indication. |
| equls | Array of json objects equls. (object fields given in below table) | |
| fut | Array of json objects fut. (object fields given in below table) | |
| opt_exp | Array of json objects opt_exp. (object fields given in below table) | |
| emsg | This will be present only in case of errors. That is : 1) Invalid Input | |
| 2) Session Expired |
| equls Json Fields of object in values Array | Possiblevalue | Description |
|---|---|---|
| exch | NSE, BSE ... | Exchange |
| tsym | Trading symbol of the scrip (contract) | |
| token | Token of the scrip (contract) | |
| pp | Price precision | |
| ti | Tick size | |
| ls | Lot size | |
| mult | Contract price multiplier, (used for order value calculation) |
| fut Json Fields of object in values Array | Possiblevalue | Description |
|---|---|---|
| exch | NFO, MCX ... | Exchange |
| tsym | Trading symbol of the scrip (contract) | |
| token | Token of the scrip (contract) | |
| exd | Expiry date | |
| pp | Price precision | |
| ti | Tick size | |
| ls | Lot size | |
| mult | Contract price multiplier, (used for order value calculation) |
| opt_exp Json Fields of object in values Array | Possiblevalue | Description |
|---|---|---|
| exd | Used for calling option chain api | |
| exch | NFO, MCX ... | Exchange |
| tsym | One of the random Trading symbol on given expiry, useful in calling option chain |
Exch Msg¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id | |
| exch | Exchange (Select from ‘exarr’ Array provided in User Details response) |
[
{
"stat": "Ok",
"exch_tm": "03-06-2024 11:35:59",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR USDINR 26 SEP 2024 84.0000 CE is: 0.1250 - 0.7950"
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 11:24:57",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR USDINR 26 SEP 2024 84.0000 CE is: 0.2250 - 0.7950"
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:49:42",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR USDINR 26 JUN 2024 83.2500 CE is: 0.0900 - 0.6950"
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:41:12",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR USDINR 26 JUN 2024 83.2500 CE is: 0.1300 - 0.6950"
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 58.2500 PE is: Rs 2.8325 - Rs 3.8400."
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 58.2500 CE is: Rs 1.1025 - Rs 1.6950."
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 58.0000 PE is: Rs 2.6925 - Rs 3.6750."
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 58.0000 CE is: Rs 1.1750 - Rs 1.7925."
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 57.7500 PE is: Rs 2.5550 - Rs 3.5125."
},
{
"stat": "Ok",
"exch_tm": "03-06-2024 09:08:34",
"exch": "CDS",
"exch_msg": "The revised price range for OPTCUR JPYINR 27 MAR 2025 57.7500 CE is: Rs 1.2475 - Rs 1.8900."
}
]
Response Details :
Response data will be in json format with below fields in case of success
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok | Whi Exch Msg success or failure indication. |
| exchmsg | It will be present only in a successful response. | |
| exchtm | Exchange Time |
Response data will be in json format with below fields in case of failure:
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Not_Ok | Order book failure indication. |
| request_time | Response received time. | |
| emsg | Error message |
Get Broker Msg¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id |
[
{
"stat": "Ok",
"norentm": "2024-06-03 09:27:15",
"msgtyp": "Admin Message",
"dmsg": "Market Update: Most of the Index gap up 3% because Exit polls is outlook supports of BJP"
},
{
"stat": "Ok",
"norentm": "2024-06-03 09:25:43",
"msgtyp": "Research Call",
"dmsg": "SHORT STRADDLE: SELL FINNIFTY 22350 CE AT 320 SL 390 TGT 170 & SELL FINNIFTY 22320 PE AT 312 SL 390 TGT 170 Disclaimer: Make investment decision based on your risk appetite)",
"token": "55300",
"exch": "NFO"
}
]
Response Details : Response data will be in json format with below fields in case of success.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok | Broker Msg success or failure indication. |
| dmsg | This will be present only in case of success. Number of days to expiry will be present in same. | |
| norentm | Noren Time |
Get Underlying Exch Token¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey | Key Obtained on login success |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid | User id of the logged in user. | |
| exch* | Exchange name | |
| token* | Token |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| und_exch | Underlying Exch seg | |
| und_tk | Underlying Token | |
| emsg | This will be present only in case of errors. |
Exchange Status¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User id of the logged in user. |
[
{
"stat": "Ok",
"exch": "NFO",
"exchstat": "OPEN",
"exchtype": "NORMAL",
"description": "03-Jun-2024 09:15:00 The Normal market has opened for 03 JUN 2024.",
"norentm": "1717386300",
"noren_nsecs": "21506911",
"exch_tm": "03-06-2024 09:15:00"
},
{
"stat": "Ok",
"exch": "NSE",
"exchstat": "PREOPEN_CLOSED_ST",
"exchtype": "CALL_AUCTION2",
"description": "03-Jun-2024 12:14:12 The Call Auction 2 Market has closed for session: 3 dated 03 JUN 2024.",
"norentm": "1717397052",
"noren_nsecs": "4733477",
"exch_tm": "03-06-2024 12:14:12"
},
{
"stat": "Ok",
"exch": "NSE",
"exchstat": "OPEN",
"exchtype": "ODD_LOT",
"description": "03-Jun-2024 09:15:00 The Oddlot market has opened for 03 JUN 2024.",
"norentm": "1717386300",
"noren_nsecs": "50633098",
"exch_tm": "03-06-2024 09:15:00"
},
{
"stat": "Ok",
"exch": "NSE",
"exchstat": "OPEN",
"exchtype": "NORMAL",
"description": "03-Jun-2024 09:15:00 The Normal market has opened.",
"norentm": "1717386300",
"noren_nsecs": "25955815",
"exch_tm": "03-06-2024 09:15:00"
},
{
"stat": "Ok",
"exch": "CDS",
"exchstat": "OPEN",
"exchtype": "NORMAL",
"description": "03-Jun-2024 09:00:00 The Normal market has opened for 03 JUN 2024.",
"norentm": "1717385400",
"noren_nsecs": "14228427",
"exch_tm": "03-06-2024 09:00:00"
},
{
"stat": "Ok",
"exch": "MCX",
"exchstat": "OPEN",
"exchtype": "NORMAL",
"description": "",
"norentm": "00",
"noren_nsecs": "00"
}
]
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | success or failure indication. | |
| exch | Exchange Segment | |
| exchstat | Exchange status | |
| exchtype | Exch Type |
System Info¶
Get AMO Status Flag¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | Logged in User Id | |
| exch* | Exchange |
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok or Not_Ok | AMO status success or failure indication. |
| exch | Exchange | |
| mode | STOP ACCEPT PUSH | AMO Mode |
Calculators¶
Span Calculator¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| actid* | Any Account id, preferably actual account id if sending from post login screen | |
| pos* | Array of json objects. (object fields given in below table) |
| Json Fields of object in values Array | Possiblevalue | Description |
|---|---|---|
| prd | M / I | Product name |
| exch | NFO, CDS, MCX ... | Exchange |
| instname | FUTSTK, FUTIDX, OPTSTK, FUTCUR... | Instrument name |
| symname | USDINR, ACC, ABB, NIFTY.. | Symbol name |
| exd | 06-DEC-2022 | DD-MON-YYYY format |
| optt | CE, PE | Option Type |
| strprc | 11900.00, 71.0025 | Strike price |
| buyqty | Buy Open Quantity | |
| sellqty | Sell Open Quantity | |
| netqty | Net traded quantity |
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Ok or Not_Ok | Market watch success or failure indication. |
| span | Span value | |
| expo | Exposure margin | |
| span_trade | Span value ignoring input fields buyqty, sellqty | |
| expo_trade | Exposure margin ignoring input fields buyqty, sellqty |
Get Option Greek¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| exd* | Expiry Date | |
| strprc* | Strike Price | |
| sptprc* | Spot Price | |
| int_rate* | Init Rate | |
| volatility* | Volatility | |
| optt | Option Type |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| cal_price | Cal Price | |
| put_price | Put Price | |
| cal_delta | Cal Delta | |
| put_delta | Put Delta | |
| cal_gamma | Cal Gamma | |
| put_gamma | Put Gamma | |
| cal_theta | Cal Theta | |
| put_theta | Put Theta | |
| cal_rho | Cal Rho | |
| put_rho | Put Rho | |
| cal_vego | Cal Vego | |
| put_vego | Put Vego |
{
"request_time":"17:22:58 28-07-2021",
"stat":"OK",
"cal_price":"1441",
"put_price":"0.417071",
"cal_delta":"0.997304",
"put_delta":"-0.002696",
"cal_gamma":"0.000001",
"put_gamma":"0.000001",
"cal_theta":"-31.535015",
"put_theta":"-31.401346",
"cal_rho":"0.000119",
"put_rho":"-0.016590",
"cal_vego":"0.006307",
put_vego":"0.006307"
}
Brokerage Calculator¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User Id | |
| actid* | Account Id | |
| exch* | Exchange Segment | |
| tsym* | Trading Symbol | |
| qty* | Quantity | |
| prc* | Price | |
| prd* | Product | |
| trantype* | Transaction Type |
Response Details :
Response data will be in json format with below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| request_time | This will be present only in a successful response. | |
| stat | Ok or Not_Ok | success or failure message. |
| brkage_amt | Brokerage Amount | |
| stt_amt | STT/CTT Amount | |
| exch_chrg | Exchange Charges | |
| sebi_chrg | SEBI Charges | |
| stamp_duty | Stamp Charges | |
| clr_chrg | Clearing Charges | |
| gst | GST | |
| tot_chrg | Total charges | |
| remarks | Remarks | |
| url | Url |