Skip to content

Alerts

Set Alert

Request Details :

Parameter Name Possiblevalue Description
jData* Should send json object with fields in below list
jKey* Key Obtained on login success.
Json Fields Possiblevalue Description
uid* User id of the logged in user.
tsym* Trading symbol
exch* Exchange Segment
ai_t* Alert Type
validity* DAY or GTT Validity
d* Data to be compared with LTP
remarks Any message Entered during order entry.
sms_flag true or false SMS flag
email_flag true or false Email flag
push_flag true or false Push flag

Response Details :

Response data will have below fields.

Json Fields Possiblevalue Description
stat alert success or failure indication.
request_time This will be present only in a successful response.
al_id Alert Id
emsg This will be present only in case of errors. That is : 1) Invalid Input2) Session Expired
    {
    "request_time":"11:22:26 08-04-2021",
    "stat":"Oi created",
    al_id:21040800000004
    }
    {
    "stat":"Not_Ok",
    "emsg":"Session Expired : Invalid Session Key"
    }

Cancel Alert

Request Details :

Parameter Name Possiblevalue Description
jData* Should send json object with fields in below list
jKey* Key Obtained on login success.
Json Fields Possiblevalue Description
uid User id of the logged in user.
al_id* Alert Id

Response Details :

Response data will have below fields.

Json Fields Possiblevalue Description
stat alert success or failure indication.
request_time This will be present only in a successful response.
al_id Alert Id
emsg This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired
    {
    "request_time":"15:03:33 08-04-2021",
    "stat":"Oi delete success",
    al_id:21040800000008
    }
   {
    "stat":"Not_Ok",
    "emsg":"Session Expired : Invalid Session Key"
    }

Modify Alert

Request Details :

Parameter Name Possiblevalue Description
jData* Should send json object with fields in below list
jKey* Key Obtained on login success.
Json Fields Possiblevalue Description
uid* User id of the logged in user.
tsym* Trading symbol
exch* Exchange Segment
ai_t* Alert Type, should be original alert type, can’t be modified.
al_id* Alert Id
validity* DAY or GTT Validity
d Data to be compared with LTP
remarks Any message Entered during order entry.
sms_flag true or false SMS flag
email_flag true or false Email flag
push_flag true or false Push flag

Response Details :

Response data will have below fields.

Json Fields Possiblevalue Description
stat alert success or failure indication.
request_time This will be present only in a successful response.
al_id Alert Id
emsg This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired
    {
    "request_time":"16:36:42 08-04-2021",
    "stat":"Oi Replaced",
    al_id:21040800000013
    }
    {
    "stat":"Not_Ok",
    "emsg":"Session Expired : Invalid Session Key"
    }

Get Pending Alert

Request Details :

Parameter Name Possiblevalue Description
jData* Should send json object with fields in below list
jKey* Key Obtained on login success.
Json Fields Possiblevalue Description
uid* User id of the logged in user.

Response Details :

Response data will have below fields.

Json Fields Possiblevalue Description
stat alert success or failure indication.
ai_t Alert type
al_id Alert Id
tsym Trading symbol
exch Exchange Segment
token Contract token
remarks Any message Entered during order entry.
validity DAY or GTT Validity
d Data to be compared with LTP
sms_flag true or false SMS flag
email_flag true or false Email flag
push_flag true or false Push flag
emsg This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired
    [
    {
        "Stat":"ok",
        ai_t:LTP_A,
        al_id:21040800000008,
        tsym:ACC-EQ,
        exch:NSE
        token:22,
        remarks:test,
        validity:DAY,
        d:95000.00
    }
    ]
    {
    "stat":"Not_Ok",
    "emsg":"Session Expired : Invalid Session Key"
    }

Get Enabled Alert Types

Request Details :

Parameter Name Possiblevalue Description
jData* Should send json object with fields in below list
jKey* Key Obtained on login success.
Json Fields Possiblevalue Description
uid* User id of the logged in user.

Response Details :

Response data will have below fields.

Json Fields Possiblevalue Description
stat Alert order success or failure indication.
request_time This will be present only in a successful response.
ai_ts Array of alert types
    {
    "stat":"Ok",
    "request_time":"04062021121503",
    "ai_ts":
    [
        {"ai_t":"ATP"},
        {"ai_t":"LTP"},
        {"ai_t":"Perc. Change"}
    ]
    }
    {
    "stat":"Not_Ok",
    "emsg":"Session Expired : Invalid Session Key"
    }