Scanner Details

This provides the list of available scanners and their corresponding configuration details for the Screeners. The response contains information such as Scanner Group Name, Scanner Names, Category and Description.

The key value to extract from this response is the ScannerKey_1 or ScannerKey_2 field (for example: PriceGainers_ or 52WeekHigh_).

API Flow

This is Step 2 of the Screener API sequence. Call this API after Get Index Sector List to obtain the system generated key value required for the final Get Analytics Data call.

🔗 Endpoint

Method	URL
GET	{{hosturl}}/nontransactional/:versionid/scannerDetails

🛣️ Path Parameters

Parameter	Type	Required	Description	Example
versionid	string	Yes	API version identifier	v1

🔑 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	string	Status of the API call	"success"
code	string	Response code	"s-101"
message	string	Success message	"Scanner details fetched successfully."
data	array	Array of scanner group configuration objects	See below

📘 Data Object Fields

Each object in the data array represents a scanner group and contains the following fields:

Field	Type	Description	Example
GroupId	integer	Unique identifier for the scanner group	1
GroupName	string	Display name of the scanner group	"Top Gainers/Losers"
Category	string	Category the scanner group belongs to	"Price Based", "Volume Based", "OI Based"
Description	string	Short description of what the scanner group identifies	"Scrips in Top Most Price Gainers/Scrip in Top Most Price Losers"
ScannerId_1	string	ID of the first scanner in the group	"1"
ScannerId_2	string	ID of the second scanner in the group (empty string if not applicable)	"2"
ScannerName_1	string	Display name of the first scanner	"Top Gainers"
ScannerName_2	string	Display name of the second scanner (empty string if not applicable)	"Top Losers"
ScannerKey_1	string	System generated key for the first scanner.	"PriceGainers_"
ScannerKey_2	string	System generated key for the second scanner (empty string if not applicable)	"PriceLoosers_"
IsEnabled	integer	Indicates if the scanner group is active. 1 = Enabled, 0 = Disabled	1
EqAllowed	boolean	Whether the scanner supports Equity segment	true
DervAllowed	boolean	Whether the scanner supports Derivatives segment	true
CommAllowed	boolean	Whether the scanner supports Commodity segment	false
CurrAllowed	boolean	Whether the scanner supports Currency segment	false
FundamentalTechnical	string	Indicates whether the scanner is Technical ("T") or Fundamental ("F") in nature	"T"
IsFut	boolean	Whether Futures instrument type is applicable for this scanner	true
IsOpt	boolean	Whether Options instrument type is applicable for this scanner	true
sScannerType	string	Scanner type classification, if applicable	"strategy", "scanners", null
sDisplayName	string	Display name used for grouping on the UI, if applicable	"Bullish", "Price", null
nSequenceNo	integer	Sequence/order number for display on the UI, if applicable	16, null

📋 Sample Request URL

GET {{hosturl}}/nontransactional/v1/scannerDetails

📋 Sample Response

{
    "status": "success",
    "code": "s-101",
    "message": "Scanner details fetched successfully.",
    "data": [
        {
            "GroupId": 1,
            "GroupName": "Top Gainers/Losers",
            "Category": "Price Based",
            "Description": "Scrips in Top Most Price Gainers/Scrip in Top Most Price Losers",
            "ScannerId_1": "1",
            "ScannerId_2": "2",
            "ScannerName_1": "Top Gainers",
            "ScannerName_2": "Top Losers",
            "IsEnabled": 1,
            "EqAllowed": true,
            "DervAllowed": true,
            "CommAllowed": true,
            "CurrAllowed": true,
            "FundamentalTechnical": "T",
            "IsFut": true,
            "IsOpt": true,
            "sScannerType": null,
            "sDisplayName": null,
            "nSequenceNo": null,
            "ScannerKey_1": "PriceGainers_",
            "ScannerKey_2": "PriceLoosers_"
        },
        {
            "GroupId": 2,
            "GroupName": "52 Week High/Low",
            "Category": "Price Based",
            "Description": "@ 52 week High/@ 52 week low",
            "ScannerId_1": "3",
            "ScannerId_2": "4",
            "ScannerName_1": "52 Week High",
            "ScannerName_2": "52 Week Low",
            "IsEnabled": 1,
            "EqAllowed": true,
            "DervAllowed": false,
            "CommAllowed": false,
            "CurrAllowed": false,
            "FundamentalTechnical": "T",
            "IsFut": true,
            "IsOpt": true,
            "sScannerType": null,
            "sDisplayName": null,
            "nSequenceNo": null,
            "ScannerKey_1": "52WeekHigh_",
            "ScannerKey_2": "52WeekLow_"
        }
    ]
}