Get Price Alerts

This API allows you to fetch your price alerts by alert name or alert ID, with their current status.

USE CASE

Check which alerts are enabled, triggered or disabled, and get the alert IDs that Modify, Delete and Enable / Disable need.

Details

You can retrieve alerts using:
Alert Name
Alert Id
This returns both active and triggered alerts.
The data object in the response is keyed by alert ID. Each entry holds fyToken, alert and symbol.
Read status before changing an alert: 1 is enabled, 0 is triggered and 2 is disabled. Triggered alerts cannot be modified or switched.
Times come both as text, for example 04-Dec-2025 12:20:03, and as epoch seconds in createdEpoch, triggeredEpoch and modifiedEpoch.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`fyToken`	string	Fytoken is a unique identifier for every symbol.
`alert`	object	Detailed alert configuration.
`symbol`	string	Trading symbol for the alert.

alert Object Fields

Attribute	Data Type	Description
`comparisonType`	string	metric compared (e.g., "OPEN", "CLOSE").
`condition`	string	Comparison operator (GT, LT, EQ).
`name`	string	user label.
`type`	string	Alert type.(e.g,"V"= LTP)
`value`	float/int	Target value.
`triggeredAt`	string	Time of trigger (if any).
`createdAt`	string	creation timestamp.
`modifiedAt`	string	Last updated timestamp.
`notes`	string	Additional notes or description.
`status`	int	Alert status: 1 = Enabled, 0 = triggered, 2 = Disabled
`triggeredEpoch`	int	Trigger time (epoch) (0 = not triggered).
`createdEpoch`	int	Created timestamp (epoch format) .
`modifiedEpoch`	int	Last modified timestamp in epoch format (0 = never modified).

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="")

response = fyers.get_alert()
print(response)

{
  "code": 200,
  "message": "",
  "data": {
    "5682484": {
      "fyToken": "10100000008080",
      "alert": {
        "comparisonType": "LTP",
        "condition": "LT",
        "name": "Silver alert ",
        "type": "V",
        "value": 130,
        "triggeredAt": "",
        "createdAt": "09-Dec-2025 11:49:06",
        "modifiedAt": "",
        "notes": "",
        "status": 2,
        "triggeredEpoch": 0,
        "createdEpoch": 1765280946,
        "modifiedEpoch": 0
      },
      "symbol": "NSE:SILVERBEES-EQ"
    }
  },
  "s": "ok"
}