API Reference

---

API Reference / PlaceForeverOrderRequest

Interface: PlaceForeverOrderRequest

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

Plain string-literal request shapes for ForeverOrders — the generated GTTOrderModel/GttModifyRequest types use TS enums for these fields, so transactionType: "BUY" doesn't type-check against them directly ("BUY" isn't assignable to GTTOrderModel.transactionType, only GTTOrderModel.transactionType.BUY is). Deriving the literal unions from the enums via ${Enum} keeps them in sync with npm run generate without hand-transcribing every member.

Properties

dhanClientId?

optional dhanClientId?: string

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

---

correlationId?

optional correlationId?: string

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

---

orderFlag?

optional orderFlag?: "SINGLE" | "OCO"

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

---

transactionType

transactionType: "BUY" | "SELL"

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

---

exchangeSegment?

optional exchangeSegment?: "NSE_EQ" | "NSE_FNO" | "BSE_EQ" | "BSE_FNO"

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

---

productType?

optional productType?: "CNC" | "MARGIN" | "MTF"

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

---

orderType?

optional orderType?: "LIMIT" | "MARKET"

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

---

validity?

optional validity?: string

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

Valid for 1Year/Expiry

---

securityId?

optional securityId?: string

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

---

quantity?

optional quantity?: number

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

---

disclosedQuantity?

optional disclosedQuantity?: number

Defined in: src/resources/ForeverOrders.ts:31

---

price?

optional price?: number

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

---

triggerPrice?

optional triggerPrice?: number

Defined in: src/resources/ForeverOrders.ts:33

---

price1?

optional price1?: number

Defined in: src/resources/ForeverOrders.ts:35

Target price for OCO order

---

triggerPrice1?

optional triggerPrice1?: number

Defined in: src/resources/ForeverOrders.ts:37

Target trigger price for OCO order

---

quantity1?

optional quantity1?: number

Defined in: src/resources/ForeverOrders.ts:39

Target quantity for OCO order