API Reference

---

API Reference / AlertConditionInput

Interface: AlertConditionInput

Defined in: src/resources/ConditionalTriggers.ts:18

Plain string-literal request shapes for ConditionalTriggers — the generated AlertCondition/AlertOrder/AlertOrderRequest types use TS enums for these fields, so comparisonType: "PRICE_WITH_VALUE" doesn't type-check against them directly. Deriving the literal unions from the enums via ${Enum} keeps them in sync with npm run generate without hand-transcribing every member (indicatorName alone has 20+).

Properties

comparisonType?

optional comparisonType?: "TECHNICAL_WITH_VALUE" | "TECHNICAL_WITH_INDICATOR" | "TECHNICAL_WITH_CLOSE" | "PRICE_WITH_VALUE"

Defined in: src/resources/ConditionalTriggers.ts:19

---

exchangeSegment?

optional exchangeSegment?: "IDX_I" | "NSE_EQ" | "BSE_EQ"

Defined in: src/resources/ConditionalTriggers.ts:20

---

securityId

securityId: string

Defined in: src/resources/ConditionalTriggers.ts:21

---

indicatorName?

optional indicatorName?: "SMA_5" | "SMA_10" | "SMA_20" | "SMA_50" | "SMA_100" | "SMA_200" | "EMA_5" | "EMA_10" | "EMA_20" | "EMA_50" | "EMA_100" | "EMA_200" | "BB_UPPER" | "BB_LOWER" | "RSI_14" | "ATR_14" | "STOCHASTIC" | "STOCHRSI_14" | "MACD_26" | "MACD_12" | "MACD_HIST"

Defined in: src/resources/ConditionalTriggers.ts:22

---

timeFrame?

optional timeFrame?: "DAY" | "ONE_MIN" | "FIVE_MIN" | "FIFTEEN_MIN"

Defined in: src/resources/ConditionalTriggers.ts:23

---

operator?

optional operator?: "CROSSING_UP" | "CROSSING_DOWN" | "CROSSING_ANY_SIDE" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_EQUAL" | "LESS_THAN_EQUAL" | "EQUAL" | "NOT_EQUAL"

Defined in: src/resources/ConditionalTriggers.ts:24

---

comparingValue?

optional comparingValue?: number

Defined in: src/resources/ConditionalTriggers.ts:25

---

comparingIndicatorName?

optional comparingIndicatorName?: "SMA_5" | "SMA_10" | "SMA_20" | "SMA_50" | "SMA_100" | "SMA_200" | "EMA_5" | "EMA_10" | "EMA_20" | "EMA_50" | "EMA_100" | "EMA_200" | "BB_UPPER" | "BB_LOWER" | "RSI_14" | "ATR_14" | "STOCHASTIC" | "STOCHRSI_14" | "MACD_26" | "MACD_12" | "MACD_HIST"

Defined in: src/resources/ConditionalTriggers.ts:26

---

expDate?

optional expDate?: string

Defined in: src/resources/ConditionalTriggers.ts:28

Expiry date of alert

---

frequency?

optional frequency?: "ONCE"

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

---

userNote?

optional userNote?: string

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