API Reference

---

API Reference / KnowYourMarginInput

Interface: KnowYourMarginInput

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

Plain string-literal request shapes for Funds — the generated KnowYourMarginReq/MultiScripMarginCalcRequest types use TS enums for exchangeSegment/transactionType/productType, so exchangeSegment: "NSE_FNO" doesn't type-check against them directly. Deriving the literal unions from the enums via ${Enum} keeps them in sync with npm run generate.

Properties

dhanClientId?

optional dhanClientId?: string

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

---

exchangeSegment?

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

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

---

transactionType?

optional transactionType?: "BUY" | "SELL"

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

---

quantity?

optional quantity?: number

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

---

productType?

optional productType?: "CNC" | "INTRADAY" | "MARGIN" | "MTF" | "CO" | "BO"

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

---

securityId?

optional securityId?: string

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

---

price?

optional price?: number

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

---

triggerPrice?

optional triggerPrice?: number

Defined in: src/resources/Funds.ts:27