Create Price Alert

This API allows you to create a price alert for an instrument.

USE CASE

Get notified when an instrument, such as NSE:SBIN-EQ, crosses a price you choose.

FYERS watches the price, so your app does not have to poll quotes.

Details

You can create a new price alert using this API. Alerts can be configured based on the following parameters.
Send alert-type as 1 (price-based alert). comparisonType picks the price that is checked: LTP, OPEN, HIGH, LOW or CLOSE.
condition accepts GT, GTE, LT, LTE or equality. The reference lists equality as E in the Condition table and as == in the request attributes.
symbol must be the full trading symbol, for example NSE:SBIN-EQ. name is only your own label for the alert.
A successful call returns code 120 and a confirmation message only. Read the alertId for later calls from Get Price Alerts.
Triggered alerts arrive on the General WebSocket under pricealerts, which also pushes a message when an alert is created.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Comparison Type

Possible Values	Description
`LTP`	LTP
`HIGH`	High Price
`LOW`	Low Price
`OPEN`	Open Price
`CLOSE`	Close Price

Condition

Possible Values	Description
`GT`	Greater than (>)
`GTE`	Greater than equal to (>=)
`LT`	Less than
`LTE`	Less than equal to (<=)
`E`	Equal to

Alert Type

Possible Values	Description
`1`	v / LTP

Request Attributes

Attribute	Data Type	Description
`agent`	string	Source of alert creation. Eg: "fyers-api"
`alert-type`	int	Type of alert. 1 price-based alert.
`name`	string	User-provided label for alert.
`symbol`	string	Full trading symbol (e.g., "NSE:SBIN-EQ")
`comparisonType`	string	price metric. 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	Target price for comparison.

Response Attributes

Attribute	Data Type	Description
`code`	int	Numeric response/status code returned by the API (e.g. 120 on successful alert creation).
`message`	string	Human-readable message describing the result of the alert creation request.
`s`	string	Status of the response. Possible value: "ok" for a successful request.

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 = {
    "agent": "fyers-api",
    "alert-type": 1,
    "name": "SBIN Alert",
    "symbol": "NSE:SILVERMIC25DECFUT",
    "comparisonType": "CLOSE",
    "condition": "LT",
    "value": 45
}

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

{
  "code": 120,
  "message": "A price alert for NSE:SILVERMIC25DECFUT at â¹45 is created.",
  "s": "ok"
}