API Reference

---

API Reference / RateLimitError

Class: RateLimitError

Defined in: src/errors/RateLimitError.ts:12

Extends

• DhanError

Constructors

Constructor

new RateLimitError(message?, options?): RateLimitError

Defined in: src/errors/RateLimitError.ts:22

Parameters

message?

string = "Request rate limit exhausted"

options?

RateLimitErrorOptions = {}

Returns

RateLimitError

Overrides

DhanError.constructor

Properties

code

readonly code: string

Defined in: src/errors/DhanError.ts:2

Inherited from

DhanError.code

---

status?

readonly optional status?: number

Defined in: src/errors/DhanError.ts:3

Inherited from

DhanError.status

---

details?

readonly optional details?: unknown

Defined in: src/errors/DhanError.ts:4

Inherited from

DhanError.details

---

cause?

readonly optional cause?: unknown

Defined in: src/errors/DhanError.ts:5

Inherited from

DhanError.cause

---

retryAfterMs?

readonly optional retryAfterMs?: number

Defined in: src/errors/RateLimitError.ts:14

Milliseconds to wait before retrying, when the broker's Retry-After header specified one.

---

errorCode?

readonly optional errorCode?: string

Defined in: src/errors/RateLimitError.ts:16

Dhan's own error code from the response body, e.g. "DH-904" — see TradingErrorCode.

---

errorType?

readonly optional errorType?: string

Defined in: src/errors/RateLimitError.ts:18

Dhan's own error category from the response body, e.g. "Rate_Limit".

---

errorMessage?

readonly optional errorMessage?: string

Defined in: src/errors/RateLimitError.ts:20

Dhan's own human-readable message from the response body, when present.