Skip to content

Alerts

Type API Details
Get alerts-rest/alert Get pending alerts
POST alerts/update Modify alerts
Delete alert/delete/8574 Delete alerts
POST /alert/create Create alerts

Get Alerts

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "id": 8574,
            "createdOn": "2023-10-11 08:10:56",
            "alertName": "dwedrtwe",
            "scripName": "ABB-EQ",
            "exch": "NSE",
            "token": "13",
            "alertType": "LTP",
            "operator": "greater",
            "value": 4192.7,
            "triggerStatus": "1",
            "expiry": null,
            "triggeredTime": "2023-11-08 13:15:23.736",
            "exchSeg": null
        }
    ]
}
Parameters

Field Type Description
id String
createdOn String
alertName String
scripName String
exch String
token String
alertType String
operator String
value String
triggerStatus String
expiry String
triggeredTime String
exchSeg String

Update alerts

Request Structure

{
    "id": 8574,
    "alertName": "dwedrtwes",
    "alertType": "LTP",
    "exch": "NSE",
    "operator": "greater",
    "scripName": "ABB-EQ",
    "token": "13",
    "value": 4192.7
}
Input parameters

Field Type Description
id String
alertName String
alertType String
exch String
operator String
scripName String
token String
value String

Response Structure

{
    "status": "Ok",
    "message": " Success",
    "result": null
}
Parameters

Field Type Description
status String
message String
result String

Delete Alerts

|

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": []
}
Parameters

Field Type Description
status String
message String
result String

Create Alert

Request Structure

{
    "alertName": "er",
    "alertType": "LTP",
    "exch": "NSE",
    "operator": "greater",
    "scripName": "SILVERTUC-EQ",
    "token": "9422",
    "value": 1
}
Input parameters

Field Type Description
alertName String
alertType String
exch String
operator String
scripName String
token String
value String

Response Structure

{
    "status": "Ok",
    "message": " Success",
    "result": null
}
Parameters

Field Type Description
status String
message String
result String