Watchlist By ID

This API fetches a specific Watchlist using its unique Watchlist ID.

🛣️Path Parameters

Parameter	Type	Required	Description	Example/ENUM
watchlistId	string	Yes	Unique ID of the Watchlist (from id field in the list response)	eb4198ce-3964-4413-87ec-6581d5716f56

🔑Header Parameters

Header	Type	Required	Description	Example/ENUM
Authorization	string	Yes	Bearer token for user authentication	Bearer{{access_token}}
x-api-key	string	Yes	API key for access control	{{x-api-key}}

🟢Success Response - 200 Ok

Field	Type	Description	Example/ENUM
status	string	Status of the API call	"success"
code	string	Response code	"s-101"
message	string	Descriptive success message	"Watchlist Fetched successfully"
data	array of object	List of Watchlist objects	See details below

🧭 Watchlist Object Structure

Field	Type	Description	Example/ENUM
id	string	Unique Watchlist ID	"32b95c61-370-b215-bb8857f9c949"
sWatchListName	string	Name of the Watchlist	"My Watchlist"
bIsPrivate	boolean	If true, watchlist is private	true
bIsDefault	boolean	If true, this is the default watchlist	false
sUserId	string	User ID of the watchlist creator	"user123"
sTenantId	string	Tenant/Broker ID	"1256878"
sSettings	string	Reserved for future (must be valid JSON string)	"{\"subCount\":13}"
scrips	array	List of scrips within the watchlist	See details below
_version	number	Version number of the watchlist	1
_deleted	boolean	Flag to indicate if deleted	false
_lastChangedAt	number	Epoch timestamp of last change	1718008123
createdAt	string	ISO date-time of watchlist creation	"2025-06-01T12:00:00Z"
updatedAt	string	ISO date-time of last update	"2025-06-10T09:45:00Z"

📑 Scrip Object Strucutre

Field	Type	Description	Example/ENUM
nMarketSegmentId	number	Exchange segment ID	1
nToken	number	Unique token/ID of the instrument	123456
nSequenceNo	number	Position/ordering of the scrip in the Watchlist	2
sSettings	string	Reserved field (JSON string, optional use)	""

get/nontransactional/v1/watchListByUser/{watchlistId}