Delete Price Alert

This API allows you to delete a price alert.

USE CASE

Remove an alert you no longer need, such as after the price level has passed.

Details

Delete a price alert.
alertId is mandatory. Read it from Get Price Alerts, where results are keyed by alert ID.
Send alertId and agent as a JSON body with the DELETE request, not in the URL.
A successful call returns code 121 and a message saying the alert for that symbol at that value is deleted.
To pause an alert and keep its settings, use Enable / Disable Price Alert instead of deleting it.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

Attribute	Data Type	Description
`alertId`	string	Mandatory. Alert ID from creation
`agent`	string	Client calling the API (e.g., "fyers-api")

Response Attributes

Attribute	Data Type	Description
`s`	string	Request status. Value is `ok` on success.
`code`	int	Response code returned by the API (e.g., `121`).
`message`	string	Human-readable message describing the result of the delete operation (e.g., which alert was deleted).

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"
}

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

{
  "code": 121,
  "message": "A price alert for NSE:GOLDBEES-EQ at â¹185 is deleted.",
  "s": "ok"
}