Get Alerts

This API retrieves a list of all alerts set by a particular user in the system. It includes details about the alert conditions, status, and additional metadata like trigger times and user-specific data.

🛣️Path Parameters

Parameter	Type	Required	Description	Example
tenantid	string	Yes	Unique identifier for the tenant	ABC123
user_id	string	Yes	Unique identifier for the user	user_123
version	string	Yes	API version (choose between v1 or v2)	v1

🔑Header Parameters

Header	Type	Description	Example
Authorization	string	Bearer token for API authentication	Bearer{{access_token}}
x-api-key	string	API key required to access the resource	{{x-api-key}}

🟢Success Response - 200 Ok

Field	Type	Description	Example/ENUM
status	string	Status of the API call (usually "success")	success
code	string	Response code for the user request	"s-101"
message	string	Success message, describing the result of the API call	"Alerts fetched successfully"
data	array of object	List of alerts set by the user	See details below

📋Alert Structure Base Fields

Field	Type	Description	Example
condition	Array of object	An array of conditions. Each condition is an object.	See details below
data	object	Contains additional data as key-value pairs	See details below
expiration	integer	The expiration timestamp.	-1
createDate	string	The creation date and time	"2025-07-25T13:00:54.907"
tenantId	string	Unique identifier for the tenant.	1404
workerId	string	Identifier for the worker processing the alert.	"worker_alerts_eq_e88bf5f7-d7e6"
triggered	integer	Whether the alert has been triggered (1 = triggered, 0 = not triggered).	1
entryTime	string	Time the alert was initially set (ISO 8601 format)	2025-06-01T09:00:00Z
UCC	string	UCC (Unique Client Code) associated with the alert	UCC_12345
MessageType	string	Type of message related to the alert	USR_Alert
serverAlertId	string	Server-specific ID for this alert	"c70d7f4c-709d-4ec4-a42"
msgCode	integer	Code representing the message type	1001
UniqueId	integer	Unique identifier for this alert	alert_5678

📝Condition Object (Array Of Objects)

Field	Type	Description	Example
operand1	object	First operand object containing market segment, token, and field	See details below
operand2	object	Second operand object containing market segment, token, field, and value	See details below
operator	string	Operator to compare operand values(e.g., >, <, =)	>
broadcast	array of integers	List of broadcast IDs associated with the alert	[1, 2, 3]
triggered	integer
triggeredTime	integer	The timestamp when the alert condition was triggered	2025-06-03T15:00:00Z

🛈Operand1 Object

Field	Type	Description	Example/ENUM
marketsegment	integer	Market segment identifier	1
token	integer	Token number from the exchange scrip master file	12345
field	string	Field to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc.	"LastTraderPrice"

🛈Operand2 Object

Field	Type	Description	Example
marketsegment	integer	Market segment identifier	1
token	integer	Token number from the exchange scrip master file	12345
field	string	Field to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc.	"USE_VALUE"
value	integer	Value to compare against the field	15000

📘Data Object Fields

Field	Type	Description	Example/ENUM
remarks	string	Additional remarks or comments	"Alert : AXISBANK price exceeds ₹700"
userid	string	User ID for whom the alert is being set	user_123
tenantid	string	Unique id provided for the tenant by SIPL	ABC123
symbol	string	Symbol code for the scrip	"AXISBANK"
alertType	string	Type of alert (e.g., LIFETIMEHIGH, LASTTRADEDPRICE)	LIFETIMEHIGH
category	string	Category of alert	"EQ"