Skip to content

API Reference


API Reference / Alerts

Class: Alerts ​

Defined in: src/resources/Alerts.ts:29

Constructors ​

Constructor ​

new Alerts(httpClient): Alerts

Defined in: src/resources/Alerts.ts:30

Parameters ​

httpClient ​

HttpClient

Returns ​

Alerts

Methods ​

list() ​

list(): Promise<GetAlertResponse[]>

Defined in: src/resources/Alerts.ts:32

Returns ​

Promise<GetAlertResponse[]>


getById() ​

getById(alertId): Promise<GetAlertResponse>

Defined in: src/resources/Alerts.ts:40

Parameters ​

alertId ​

string

Returns ​

Promise<GetAlertResponse>


place() ​

place(request): Promise<AlertOrderResponse>

Defined in: src/resources/Alerts.ts:48

Parameters ​

request ​

PlaceAlertRequest

Returns ​

Promise<AlertOrderResponse>


modify() ​

modify(alertId, request): Promise<AlertOrderResponse>

Defined in: src/resources/Alerts.ts:59

Parameters ​

alertId ​

string

request ​

ModifyAlertRequest

Returns ​

Promise<AlertOrderResponse>


delete() ​

delete(alertId): Promise<AlertOrderResponse>

Defined in: src/resources/Alerts.ts:71

Parameters ​

alertId ​

string

Returns ​

Promise<AlertOrderResponse>

Community project — not affiliated with Dhan. MIT License.