API Reference

---

API Reference / DhanWS

Class: DhanWS

Defined in: src/ws/DhanWS.ts:10

Constructors

Constructor

new DhanWS(options): DhanWS

Defined in: src/ws/DhanWS.ts:18

Parameters

options

DhanWSOptions

Returns

DhanWS

Properties

ltpStore

readonly ltpStore: LTPStore

Defined in: src/ws/DhanWS.ts:11

---

orderStore

readonly orderStore: OrderStore

Defined in: src/ws/DhanWS.ts:12

---

market

readonly market: MarketFeedWS

Defined in: src/ws/DhanWS.ts:13

---

orders

readonly orders: OrderUpdateWS

Defined in: src/ws/DhanWS.ts:14

---

depth?

optional depth?: MarketDepthWS

Defined in: src/ws/DhanWS.ts:15

Methods

enableDepth()

enableDepth(mode?): MarketDepthWS

Defined in: src/ws/DhanWS.ts:56

Initializes market depth streaming (20-level or 200-level).

Parameters

mode?

MarketDepthMode = "twenty"

Returns

MarketDepthWS

---

connect()

connect(): Promise<void>

Defined in: src/ws/DhanWS.ts:71

Returns

Promise<void>

---

disconnect()

disconnect(): void

Defined in: src/ws/DhanWS.ts:82

Returns

void

---

subscribe()

subscribe(instruments): void

Defined in: src/ws/DhanWS.ts:88

Parameters

instruments

InstrumentSubscription[]

Returns

void