Getting Started

Installation

npm install @nemesis-oss/dhanhq-sdk

Requires Node.js 18 or newer. Ships both ESM and CommonJS builds with TypeScript declarations.

Quick Start

import { DhanClient } from "@nemesis-oss/dhanhq-sdk";

const client = new DhanClient({
  token: process.env.DHAN_TOKEN!,
  clientId: process.env.DHAN_CLIENT_ID!,
});

const orderDetail = await client.orders.getById("12345");
console.log(orderDetail);

Authentication

Five ways to supply a token:

1. Static Token

new DhanClient({ clientId, token });

2. Provider Callback

Re-resolved on every request:

new DhanClient({
  clientId,
  tokenProvider: () => vault.read("dhan/token"),
});

3. Auto-Renewal (PIN + TOTP)

Generate from PIN + TOTP secret, renew before expiry:

client.auth.enableAutoTokenManagement({
  clientId: "YOUR_CLIENT_ID",
  pin: "YOUR_PIN",
  totpSecret: "YOUR_TOTP_SECRET",
});

4. Environment Variables

const client = DhanClient.fromEnv();
// reads DHAN_CLIENT_ID and DHAN_ACCESS_TOKEN

5. Custom Token Endpoint

const client = await DhanClient.fromTokenEndpoint({
  endpointBaseUrl: "https://your-auth-service.com",
  bearerToken: process.env.DHAN_TOKEN_ACCESS_TOKEN!,
});

See the full authentication guide for details on TOTP generation, SELF vs PARTNER auth, and token lifecycle.