Traders Control API

The Traders Control API provides a kill switch functionality to immediately cancel all active orders and prevent new order placement. This is useful in emergency situations or to quickly exit all positions.

Accessing the Traders Control API

import { DhanHqClient, DhanEnv } from 'dhan-ts';

const client = new DhanHqClient({
  accessToken: process.env.DHAN_ACCESS_TOKEN!,
  clientId: process.env.DHAN_CLIENT_ID!,
  env: DhanEnv.PROD,
});

const tradersControl = client.tradersControl;

Set Kill Switch

Activate or deactivate the kill switch.

async setKillSwitch(
  status: KillSwitchStatus
): Promise<KillSwitchResponse>

Example

import { KillSwitchStatus } from 'dhan-ts';

async function activateKillSwitch() {
  try {
    const response = await client.tradersControl.setKillSwitch(
      KillSwitchStatus.ACTIVATE
    );

    console.log('Kill Switch Status:', response.killSwitchStatus);
    console.log('Client ID:', response.dhanClientId);
  } catch (error) {
    console.error('Error activating kill switch:', error);
  }
}

async function deactivateKillSwitch() {
  try {
    const response = await client.tradersControl.setKillSwitch(
      KillSwitchStatus.DEACTIVATE
    );

    console.log('Kill Switch deactivated');
  } catch (error) {
    console.error('Error deactivating kill switch:', error);
  }
}

TypeScript Types

KillSwitchStatus Enum

enum KillSwitchStatus {
  ACTIVATE = "ACTIVATE",
  DEACTIVATE = "DEACTIVATE",
}

KillSwitchResponse

interface KillSwitchResponse {
  dhanClientId: string;
  killSwitchStatus: string;
}

What Happens When Kill Switch is Activated?

All pending orders are cancelled immediately
No new orders can be placed until deactivated
Existing positions remain open - only new orders are blocked
Market/Limit orders are rejected with kill switch error

The kill switch does NOT close existing positions. It only cancels pending orders and blocks new orders. To close positions, you must manually place exit orders after deactivating the kill switch.

Use Cases

Emergency Stop

async function emergencyStop() {
  console.log('EMERGENCY: Activating kill switch...');

  await client.tradersControl.setKillSwitch(
    KillSwitchStatus.ACTIVATE
  );

  console.log('All orders cancelled. No new orders allowed.');
}

End of Day Cleanup

async function endOfDayCleanup() {
  // Get all pending orders
  const orders = await client.orders.getOrders();

  const pendingOrders = orders.filter(
    o => o.orderStatus === 'PENDING'
  );

  if (pendingOrders.length > 5) {
    console.log('Too many pending orders. Activating kill switch...');

    await client.tradersControl.setKillSwitch(
      KillSwitchStatus.ACTIVATE
    );

    // Wait a moment
    await new Promise(resolve => setTimeout(resolve, 2000));

    // Deactivate
    await client.tradersControl.setKillSwitch(
      KillSwitchStatus.DEACTIVATE
    );

    console.log('Kill switch cycle completed');
  }
}

Loss Limit Protection

async function lossLimitProtection() {
  const positions = await client.portfolio.getPositions();

  const totalUnrealizedPnL = positions.reduce(
    (sum, pos) => sum + pos.unrealizedProfit,
    0
  );

  const LOSS_LIMIT = -10000; // ₹10,000 loss limit

  if (totalUnrealizedPnL < LOSS_LIMIT) {
    console.log('Loss limit breached! Activating kill switch...');

    await client.tradersControl.setKillSwitch(
      KillSwitchStatus.ACTIVATE
    );

    // Alert user
    console.log('ALERT: Kill switch activated due to losses');
    console.log(`Current P&L: ₹${totalUnrealizedPnL}`);
  }
}

Best Practices

Use in genuine emergencies only
Deactivate after emergency is resolved
Implement with caution - can disrupt trading
Add confirmation before activating
Log kill switch events for audit trail
Test in sandbox first
Combine with alerts for better risk management

The kill switch is a powerful tool for risk management. Use it responsibly and always deactivate it once the emergency is resolved.

Orders API - Manage individual orders
Portfolio API - View positions
Funds API - Check available balance

Traders Control API

On this page