GetInstruments : Returns array of instruments by selected exchange
Supported parameters
| Exchange | String value like MCX | Name of supported exchange. How to get list of supported exchanges you can find here |
| InstrumentType | String value like FUTIDX | Optional parameter applicable for F&O segments . Name of supported Instrument Type. How to get list of supported values you can find here (Applicable only for Future and Option) |
| Product | String value like BANKNIFTY | Optional parameter. Name of supported Product. How to get list of supported values you can find here |
| Expiry | String value like 30Jul2015 | Optional parameter. Name of supported Expiry Date. How to get list of supported values you can find here (Applicable only for Future and Option) |
| OptionType | String value like CE | Optional parameter. Name of supported Option Type. How to get list of supported values you can find here (Applicable only for Future and Option) |
| StrikePrice | String value like 0 | Optional parameter. Name of supported StrikePrice. How to get list of supported values you can find here (Applicable only for Future and Option) |
| Series | String value like EQ | Optional parameter applicable for Stock Segments .We can use this parameter to filter those symbols by series wise (Applicable only for Equity / CASH) |
| showDummyISIN | [true]/[false], default = [false] | Optional parameter. When true, instruments with dummy ISIN will be included in response. (Applicable only for Equity / CASH) |
| showETF | [true]/[false], default = [false] | Optional parameter. When true, ETF instruments will be included in response. (Applicable only for Equity / CASH) |
| showInterOperable | [true]/[false], default = [false] | Optional parameter. When true, Inter Operable instruments will be included in response with special character (#/ $). (Applicable only for Equity / CASH) |
| OnlyActive | [true]/[false], default = [true] | Optional parameter. By default, function will return only active instruments. Function will return all (active + expired) instruments if value equals false |
| detailedInfo | [true]/[false], default = [false] | Optional parameter. By default function will return limited fields in response, function will return additional fields in response when this parameter is set as true. |
What is returned ?
| Identifier (Symbol), Name (Instrument Type), Expiry (Expiry Date), StrikePrice, Product, OptionType, ProductMonth, TradeSymbol (ShortIdentifier for same Identifier/Symbol), QuotationLot (Lot Size), When detailedInfo=true, following additional information will be sent (if available from Exchange)TokenNumber (Token number of Symbol), LowPriceRange (Lower circuit limit),HighPriceRange(Upper circuit limit),ISIN code, Series, High52Week, Low52Week. |
Sample request(JavaScript)
var request =
{
MessageType: "GetInstruments",
Exchange: "NFO",
InstrumentType:"FUTIDX",
//Product:"NIFTY",
//OptionType:"PE",
//Expiry:"30jul2020",
//Series:"EQ",
//detailedInfo: "true"
};
var message = JSON.stringify(request);
websocket.send(message);
Example of returned data in JSON format
{"Request":{"Exchange":"NFO","InstrumentType":"FUTIDX","OnlyActive":true,"MessageType":"GetInstruments"},
"Result":[{"Identifier":"FUTIDX_MIDCPNIFTY_25NOV2024_XX_0","Name":"FUTIDX","Expiry":"25Nov2024","StrikePrice":0.0,"Product":"MIDCPNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"25Nov2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"MIDCPNIFTY25NOV24FUT","QuotationLot":50.0,"Description":"","TokenNumber":"36540","LowPriceRange":10904.75,"HighPriceRange":13328.0,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_FINNIFTY_26NOV2024_XX_0","Name":"FUTIDX","Expiry":"26Nov2024","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"26Nov2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY26NOV24FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35117","LowPriceRange":20927.7,"HighPriceRange":25578.25,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_BANKNIFTY_27NOV2024_XX_0","Name":"FUTIDX","Expiry":"27Nov2024","StrikePrice":0.0,"Product":"BANKNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"27Nov2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"BANKNIFTY27NOV24FUT","QuotationLot":15.0,"Description":"","TokenNumber":"35013","LowPriceRange":45267.3,"HighPriceRange":55326.65,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTY_28NOV2024_XX_0","Name":"FUTIDX","Expiry":"28Nov2024","StrikePrice":0.0,"Product":"NIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"28Nov2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTY28NOV24FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35089","LowPriceRange":21241.55,"HighPriceRange":25961.9,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTYNXT50_29NOV2024_XX_0","Name":"FUTIDX","Expiry":"29Nov2024","StrikePrice":0.0,"Product":"NIFTYNXT50","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"29Nov2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTYNXT5029NOV24FUT","QuotationLot":10.0,"Description":"","TokenNumber":"35150","LowPriceRange":60980.5,"HighPriceRange":74531.75,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_BANKNIFTY_24DEC2024_XX_0","Name":"FUTIDX","Expiry":"24Dec2024","StrikePrice":0.0,"Product":"BANKNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"24Dec2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"BANKNIFTY24DEC24FUT","QuotationLot":15.0,"Description":"","TokenNumber":"35025","LowPriceRange":45547.55,"HighPriceRange":55669.2,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTY_26DEC2024_XX_0","Name":"FUTIDX","Expiry":"26Dec2024","StrikePrice":0.0,"Product":"NIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"26Dec2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTY26DEC24FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35005","LowPriceRange":21370.7,"HighPriceRange":26119.75,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTYNXT50_27DEC2024_XX_0","Name":"FUTIDX","Expiry":"27Dec2024","StrikePrice":0.0,"Product":"NIFTYNXT50","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"27Dec2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTYNXT5027DEC24FUT","QuotationLot":10.0,"Description":"","TokenNumber":"35000","LowPriceRange":61249.75,"HighPriceRange":74860.8,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_MIDCPNIFTY_30DEC2024_XX_0","Name":"FUTIDX","Expiry":"30Dec2024","StrikePrice":0.0,"Product":"MIDCPNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"30Dec2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"MIDCPNIFTY30DEC24FUT","QuotationLot":50.0,"Description":"","TokenNumber":"35004","LowPriceRange":10950.35,"HighPriceRange":13383.8,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_FINNIFTY_31DEC2024_XX_0","Name":"FUTIDX","Expiry":"31Dec2024","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"31Dec2024","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY31DEC24FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35426","LowPriceRange":21052.75,"HighPriceRange":25731.1,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_MIDCPNIFTY_27JAN2025_XX_0","Name":"FUTIDX","Expiry":"27Jan2025","StrikePrice":0.0,"Product":"MIDCPNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"27Jan2025","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"MIDCPNIFTY27JAN25FUT","QuotationLot":50.0,"Description":"","TokenNumber":"35007","LowPriceRange":10989.0,"HighPriceRange":13430.95,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_FINNIFTY_28JAN2025_XX_0","Name":"FUTIDX","Expiry":"28Jan2025","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"28Jan2025","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY28JAN25FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35239","LowPriceRange":21169.55,"HighPriceRange":25873.9,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_BANKNIFTY_29JAN2025_XX_0","Name":"FUTIDX","Expiry":"29Jan2025","StrikePrice":0.0,"Product":"BANKNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"29Jan2025","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"BANKNIFTY29JAN25FUT","QuotationLot":15.0,"Description":"","TokenNumber":"35012","LowPriceRange":45852.8,"HighPriceRange":56042.35,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTY_30JAN2025_XX_0","Name":"FUTIDX","Expiry":"30Jan2025","StrikePrice":0.0,"Product":"NIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"30Jan2025","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTY30JAN25FUT","QuotationLot":25.0,"Description":"","TokenNumber":"35006","LowPriceRange":21516.95,"HighPriceRange":26298.5,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0},
{"Identifier":"FUTIDX_NIFTYNXT50_31JAN2025_XX_0","Name":"FUTIDX","Expiry":"31Jan2025","StrikePrice":0.0,"Product":"NIFTYNXT50","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"31Jan2025","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTYNXT5031JAN25FUT","QuotationLot":10.0,"Description":"","TokenNumber":"35279","LowPriceRange":61549.25,"HighPriceRange":75226.9,"ISIN":"","Series":"","High52Week":0.0,"Low52Week":0.0}
],"MessageType":"InstrumentsResult"}
