GetInstruments

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. Name of supported Instrument Type. How to get list of supported values you can find here
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
OptionType String value like CE Optional parameter. Name of supported Option Type. How to get list of supported values you can find here
StrikePrice String value like 0 Optional parameter. Name of supported StrikePrice. How to get list of supported values you can find here
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 circut limit)
Sample request(JavaScript)
var request =
{
                MessageType: "GetInstruments",
                Exchange: "NFO",
		InstrumentType:"FUTIDX",
		//Product:"NIFTY",
		//OptionType:"PE",
		//Expiry:"30jul2020"	
		//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_FINNIFTY_15JUL2021_XX_0","Name":"FUTIDX","Expiry":"15Jul2021","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"15Jul2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY15JUL21FUT","QuotationLot":40.0,"Description":"","TokenNumber":"43055","LowPriceRange":15163.75,"HighPriceRange":18533.5},
{"Identifier":"FUTIDX_FINNIFTY_22JUL2021_XX_0","Name":"FUTIDX","Expiry":"22Jul2021","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"22Jul2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY22JUL21FUT","QuotationLot":40.0,"Description":"","TokenNumber":"46491","LowPriceRange":15180.65,"HighPriceRange":18554.1},
{"Identifier":"FUTIDX_BANKNIFTY_29JUL2021_XX_0","Name":"FUTIDX","Expiry":"29Jul2021","StrikePrice":0.0,"Product":"BANKNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"29Jul2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"BANKNIFTY29JUL21FUT","QuotationLot":25.0,"Description":"","TokenNumber":"53179","LowPriceRange":32185.5,"HighPriceRange":39337.85},
{"Identifier":"FUTIDX_FINNIFTY_29JUL2021_XX_0","Name":"FUTIDX","Expiry":"29Jul2021","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"29Jul2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY29JUL21FUT","QuotationLot":40.0,"Description":"","TokenNumber":"53180","LowPriceRange":15187.65,"HighPriceRange":18562.7},
{"Identifier":"FUTIDX_NIFTY_29JUL2021_XX_0","Name":"FUTIDX","Expiry":"29Jul2021","StrikePrice":0.0,"Product":"NIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"29Jul2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTY29JUL21FUT","QuotationLot":50.0,"Description":"","TokenNumber":"53181","LowPriceRange":14250.45,"HighPriceRange":17417.2},
{"Identifier":"FUTIDX_FINNIFTY_05AUG2021_XX_0","Name":"FUTIDX","Expiry":"05Aug2021","StrikePrice":0.0,"Product":"FINNIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"05Aug2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"FINNIFTY05AUG21FUT","QuotationLot":40.0,"Description":"","TokenNumber":"38408","LowPriceRange":15201.9,"HighPriceRange":18580.05},
{"Identifier":"FUTIDX_NIFTY_26AUG2021_XX_0","Name":"FUTIDX","Expiry":"26Aug2021","StrikePrice":0.0,"Product":"NIFTY","PriceQuotationUnit":"","OptionType":"XX","ProductMonth":"26Aug2021","UnderlyingAsset":"","UnderlyingAssetExpiry":"","IndexName":"","TradeSymbol":"NIFTY26AUG21FUT","QuotationLot":50.0,"Description":"","TokenNumber":"49939","LowPriceRange":14282.8,"HighPriceRange":17456.75}
],"MessageType":"InstrumentsResult"}
Back to Top

Was this helpful?

Previous Article

GetInstrumentsOnSearch

Next Article

GetInstrumentTypes