Get Analytics Data

This API returns the analytics data for the Wave Screener based on the selected parameters. It accepts the Index/Sector selection, instrument type, and expiry selection to fetch the relevant analytics results.

The parameter values required for this API are obtained from two preceding APIs in the Screener flow — Get Index Sector List and Scanner Details

API Flow

This is Step 3 (the final step) of the Wave Screener API sequence. Ensure you have called Get Index Sector List and Scanner Details first to obtain the required parameter values.

Parameter	Source
mktSegId	Response of Get Index Sector List API (nMktSegId field)
indexSector	Response of Get Index Sector List API (Name field)
redisKey	Response of Scanner Details API (ScannerKey_1 or ScannerKey_2 field)
futureOption	User selection on the UI
nearFar	User selection on the UI

🔗 Endpoint

Method	URL
GET	{{hosturl}}/nontransactional/:comid/:versionid/getAnalyticsData/:screenerType/:mktSegId/:indexSector/:redisKey/:futureOption/:nearFar

🛣️ Path Parameters

Parameter	Type	Required	Description	Example	Allowed Values
comid	string	Yes	Tenant ID	1404	—
versionid	string	Yes	API version identifier	v1	—
screenerType	string	Yes	Type of screener. Currently fixed for the Screener flow.	"WaveScreener"	"WaveScreener"
mktSegId	integer	Yes	Market Segment ID obtained from the Get Index Sector List API response.	1, 8	Any valid nMktSegId from Get Index Sector List
indexSector	string	Yes	The Index or Sector name selected by the user, obtained from the Get Index Sector List API response.	"All", "Nifty 50"	Any valid Name from Get Index Sector List
redisKey	string	Yes	The System generated key for the selected scanner, obtained from the Scanner Details API response.	"PriceGainers_", "52WeekHigh_"	Any valid ScannerKey_1 or ScannerKey_2 from Scanner Details
futureOption	string	Yes	Instrument type selected by the user.	"FUT"	"FUT", "OPT", "CE", "PE", "All"
nearFar	string	Yes	Expiry selection made by the user.	"NEAR"	"NEAR", "NEXT", "FAR"

📖 Parameter Value Reference

futureOption — Instrument Type

Value	Description
FUT	Futures
OPT	Options
CE	Call
PE	Put
All	All instruments

nearFar — Expiry Selection

Value	Description
NEAR	Near month expiry
NEXT	Next month expiry
FAR	Far month expiry

🔑 Header Parameters

Parameter	Type	Description	Example
Content-Type	string	Content type for request	application/json
Authorization	string	Bearer token for authentication	{{access_token}}

🟢 Success Response - 200 OK

Field	Type	Description	Example
status	boolean	Indicates whether the request was successful	true
result	array	Array of analytics data objects matching the selected parameters	See below

📘 Result Object Fields

Field	Type	Description	Example
nMarketSegmentId	string	Market Segment ID of the instrument	"2"
nToken	string	Unique token identifying the instrument	"67595"
sSymbol	string	Symbol name of the instrument	"BANKNIFTY"
sSeries	string	Series of the instrument	"XX"
sSectorName	string	Sector name, if applicable	""
nExpiryDate	string	Expiry date as Unix timestamp	"1464273000"
nExpiryMonth	integer	Expiry month number	3
nOpen	string	Opening price	"1842.40"
nClose	string	Previous closing price	"438.45"
nHigh	string	Day's high price	"1871.55"
nLow	string	Day's low price	"1842.40"
nVolume	integer	Volume traded	180
nPrevVolumeChange	string	Percentage change in volume compared to previous day	"-15.6"
nPrevTotalQtyTraded	integer	Total quantity traded in the previous session	0
nOpenInterestChange	number	Change in Open Interest	0
nOpenInterest	integer	Current Open Interest	30
nStrikePrice	string	Strike price (applicable for Options)	"57700.00"
sInstrumentName	string	Instrument type name	"OPTIDX"
sOptionType	string	Option type — CE for Call, PE for Put	"PE"
nPercChange	string	Percentage price change	"321.93"
nLTP	string	Last Traded Price	"1849.95"
nData	number	Numeric data value used for sorting/ranking within the scanner	321.92952446117005
sData	string	String representation of nData	"321.93"
nAssetToken	integer	Token of the underlying asset	26009
sISINCode	string	ISIN code of the instrument, if available	""

📋 Sample Request URL

GET {{hosturl}}/nontransactional/1404/v1/getAnalyticsData/WaveScreener/2/All/PriceGainers_/PE/Far

📋 Sample Response

{
    "status": true,
    "result": [
        {
            "nMarketSegmentId": "2",
            "nToken": "67595",
            "sSymbol": "BANKNIFTY",
            "sSeries": "XX",
            "sSectorName": "",
            "nExpiryDate": "1464273000",
            "nExpiryMonth": 3,
            "nOpen": "1842.40",
            "nClose": "438.45",
            "nHigh": "1871.55",
            "nLow": "1842.40",
            "nVolume": 180,
            "nPrevVolumeChange": "-15.6",
            "nPrevTotalQtyTraded": 0,
            "nOpenInterestChange": 0,
            "nOpenInterest": 30,
            "nStrikePrice": "57700.00",
            "sInstrumentName": "OPTIDX",
            "sOptionType": "PE",
            "nPercChange": "321.93",
            "nLTP": "1849.95",
            "nData": 321.92952446117005,
            "sData": "321.93",
            "nAssetToken": 26009,
            "sISINCode": ""
        }
    ]
}