Modify Price Alert

This API allows you to modify an existing price alert.

USE CASE

Move the target price or change the compared price of an alert without deleting and re-creating it.

Details

Allows you to modify alerts.
Only active alerts can be modified.
Expired or triggered alerts cannot be modified.
The symbol associated with an alert cannot be changed; all other fields can be updated.
Send the whole alert definition, not only the changed field: alertId, alert-type, name, symbol, comparisonType and value are mandatory.
name can be at most 50 characters and value can have up to 6 decimal places.
Send symbol exactly as the alert was created. It cannot be changed, so to watch another instrument create a new alert.
A successful call returns code 123 and a message saying the alert for that symbol at the new value is updated.
Check the alert status in Get Price Alerts first: 1 is enabled, 0 is triggered and 2 is disabled.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

Attribute	Data Type	Description
`alertId`*	string	Mandatory. Unique alert ID
`agent`	string	Identifier of client (e.g., "fyers-api")
`alert-type`	int	Mandatory. 1 → Price alert (LTP)
`name`	string	Mandatory. Max 50 characters
`symbol`	string	Mandatory. Trading symbol (e.g., NSE:GOLDBEES-EQ)
`comparisonType`	string	Mandatory. comparision type Allowed: "OPEN", "HIGH", "LOW", "CLOSE", "LTP"
`condition`	string	comparison operator. Allowed: "GT" (greater), "GTE" (greater or equal), "LT" (lesser), "LTE" (lesser or equal), "==" (equal)
`value`	float	Mandatory. Up to 6 decimal places

Response Attributes

Attribute	Data Type	Description
`s`	string	Request status. Possible values: `"ok"` or `"error"`
`code`	int	Response status code
`message`	string	Message describing the result of the price alert modification

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"

fyers = fyersModel.FyersModel(client_id=client_id, token=access_token, is_async=False, log_path="")

data = {
    "alertId": "3870995",
    "agent": "fyers-api",
    "alert-type": 1,
    "name": "Updated Alert",
    "symbol": "NSE:SILVERMIC25DECFUT",
    "comparisonType": "CLOSE",
    "condition": "LT",
    "value": 50
}

response = fyers.update_alert(data=data)
print(response)

{
  "code": 123,
  "message": "A price alert for NSE:SILVERMIC25DECFUT at â¹50 is updated.",
  "s": "ok"
}