API Reference

---

API Reference / DhanClientConfig

Interface: DhanClientConfig

Defined in: src/types/common.types.ts:3

Properties

token?

optional token?: string

Defined in: src/types/common.types.ts:4

---

clientId

clientId: string

Defined in: src/types/common.types.ts:5

---

tokenProvider?

optional tokenProvider?: () => string | Promise<string>

Defined in: src/types/common.types.ts:6

Returns

string | Promise<string>

---

onTokenExpired?

optional onTokenExpired?: (error) => void | Promise<void>

Defined in: src/types/common.types.ts:7

Parameters

error

unknown

Returns

void | Promise<void>

---

baseURL?

optional baseURL?: string

Defined in: src/types/common.types.ts:8

---

timeoutMs?

optional timeoutMs?: number

Defined in: src/types/common.types.ts:9

---

rateLimitMinTimeMs?

optional rateLimitMinTimeMs?: number

Defined in: src/types/common.types.ts:10

---

circuitBreaker?

optional circuitBreaker?: false | CircuitBreakerOptions

Defined in: src/types/common.types.ts:15

Trips after consecutive network/5xx failures so a struggling backend doesn't get hammered by every in-flight caller. Pass false to disable.

---

wsUrl?

optional wsUrl?: string

Defined in: src/types/common.types.ts:16

---

marketFeedUrl?

optional marketFeedUrl?: string

Defined in: src/types/common.types.ts:17

---

orderUpdateUrl?

optional orderUpdateUrl?: string

Defined in: src/types/common.types.ts:18

---

wsReconnectDelayMs?

optional wsReconnectDelayMs?: number

Defined in: src/types/common.types.ts:19

---

wsOrderUserType?

optional wsOrderUserType?: "SELF" | "PARTNER"

Defined in: src/types/common.types.ts:20

---

partnerId?

optional partnerId?: string

Defined in: src/types/common.types.ts:21

---

partnerSecret?

optional partnerSecret?: string

Defined in: src/types/common.types.ts:22

---

instrumentCacheTtlMs?

optional instrumentCacheTtlMs?: number

Defined in: src/types/common.types.ts:24

How long a parsed scrip-master segment stays cached. Defaults to 1 hour.