# dhan-rs
[](https://crates.io/crates/dhan-rs)
[](https://docs.rs/dhan-rs)
[](https://github.com/SPRAGE/dhan-rs/actions/workflows/ci.yml)
[](LICENSE)
An **unofficial** Rust client library for the [DhanHQ Broker API v2](https://dhanhq.co/docs/v2/).
> [!CAUTION]
> **⚠️ AI-GENERATED CODE — USE AT YOUR OWN RISK**
>
> This entire crate was generated by AI (GitHub Copilot / Claude). While it
> compiles and follows the DhanHQ API v2 specification, **it has not been
> extensively tested against the live API**. Before using this in production
> or with real money:
>
> - Review the source code thoroughly
> - Write your own integration tests against DhanHQ's sandbox/live API
> - Validate all order placement, modification, and cancellation flows
> - Verify WebSocket market feed parsing against real data
> - This is **not** an official DhanHQ product and is not endorsed by DhanHQ
>
> **The authors accept no responsibility for financial losses incurred through
> the use of this library.**
---
## Features
- **Complete API coverage** — All 55+ endpoints from the DhanHQ v2 REST API
- **WebSocket streaming** — Live market feed (binary) and order updates (JSON)
- **Strongly typed** — Full Rust type system coverage with serde serialization
- **Async/await** — Built on `tokio` and `reqwest` for async-first design
- **Zero-copy binary parsing** — Market feed packets parsed with native `from_le_bytes()` (no external parsing crate)
- **Ergonomic error handling** — Rich `DhanError` enum with API error codes, HTTP errors, JSON errors, and WebSocket errors
## Supported API Modules
| **Authentication** | Access token generation, renewal, consent flows (individual & partner) |
| **Orders** | Place, modify, cancel, slice orders; order book & trade book |
| **Super Orders** | Multi-leg bracket/cover orders with stop-loss and target |
| **Forever Orders** | GTT (Good Till Triggered) and OCO (One Cancels Other) orders |
| **Conditional Triggers** | Alert-based conditional order placement |
| **Portfolio** | Holdings, positions, position conversion, exit all |
| **eDIS** | T-PIN generation, eDIS form, delivery inquiry |
| **Trader's Control** | Kill switch, P&L-based auto-exit |
| **Funds** | Margin calculator (single & multi), fund limits |
| **Statements** | Ledger reports, trade history |
| **Market Quotes** | LTP, OHLC, full market depth snapshots (REST) |
| **Historical Data** | Daily and intraday OHLCV candles |
| **Option Chain** | Option chain data with Greeks, expiry lists |
| **Postback** | Webhook payload deserialization types |
| **WebSocket: Market Feed** | Real-time ticker, quote, full depth (binary protocol) |
| **WebSocket: Order Updates** | Real-time order status changes (JSON protocol) |
## Installation
Add to your `Cargo.toml`:
```toml
[dependencies]
dhan-rs = "0.1"
tokio = { version = "1", features = ["full"] }
```
## Quick Start
### REST API — Place an Order
```rust,no_run
use dhan_rs::DhanClient;
use dhan_rs::types::orders::PlaceOrderRequest;
use dhan_rs::types::enums::*;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let client = DhanClient::new("your-client-id", "your-access-token");
let req = PlaceOrderRequest {
dhan_client_id: Some("your-client-id".into()),
transaction_type: TransactionType::BUY,
exchange_segment: ExchangeSegment::NSE_EQ,
product_type: ProductType::INTRADAY,
order_type: OrderType::LIMIT,
validity: Validity::DAY,
security_id: "1333".into(), // HDFC Bank
quantity: 1,
price: Some(1500.0),
..Default::default()
};
let response = client.place_order(&req).await?;
println!("Order placed: {:?}", response);
Ok(())
}
```
### REST API — Get Holdings
```rust,no_run
use dhan_rs::DhanClient;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let client = DhanClient::new("your-client-id", "your-access-token");
let holdings = client.get_holdings().await?;
for h in &holdings {
println!("{}: {} shares @ ₹{:.2}",
h.trading_symbol.as_deref().unwrap_or("?"),
h.total_qty.unwrap_or(0),
h.avg_cost_price.unwrap_or(0.0),
);
}
Ok(())
}
```
### REST API — Market Quotes
```rust,no_run
use dhan_rs::DhanClient;
use dhan_rs::types::market_quote::MarketQuoteRequest;
use std::collections::HashMap;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let client = DhanClient::new("your-client-id", "your-access-token");
let mut instruments = HashMap::new();
instruments.insert("NSE_EQ".into(), vec!["1333".into(), "11536".into()]);
let req = MarketQuoteRequest { data: instruments };
let ltp = client.get_ltp(&req).await?;
println!("LTP data: {:?}", ltp);
Ok(())
}
```
### WebSocket — Live Market Feed
```rust,no_run
use dhan_rs::ws::market_feed::{MarketFeedStream, Instrument};
use dhan_rs::types::enums::FeedRequestCode;
use futures_util::StreamExt;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let mut stream = MarketFeedStream::connect("your-client-id", "your-access-token").await?;
let instruments = vec![
Instrument::new("NSE_EQ", "1333"), // HDFC Bank
Instrument::new("NSE_EQ", "11536"), // TCS
];
stream.subscribe(FeedRequestCode::SubscribeTicker, &instruments).await?;
while let Some(event) = stream.next().await {
match event {
Ok(e) => println!("{e:?}"),
Err(e) => eprintln!("Error: {e}"),
}
}
Ok(())
}
```
### WebSocket — Live Order Updates
```rust,no_run
use dhan_rs::ws::order_update::OrderUpdateStream;
use futures_util::StreamExt;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let mut stream = OrderUpdateStream::connect(
"your-client-id",
"your-access-token",
).await?;
while let Some(msg) = stream.next().await {
match msg {
Ok(update) => println!(
"Order {} → {}",
update.Data.OrderNo.as_deref().unwrap_or("?"),
update.Data.Status.as_deref().unwrap_or("?"),
),
Err(e) => eprintln!("Error: {e}"),
}
}
Ok(())
}
```
### Option Chain with Greeks
```rust,no_run
use dhan_rs::DhanClient;
use dhan_rs::types::option_chain::OptionChainRequest;
#[tokio::main]
async fn main() -> dhan_rs::Result<()> {
let client = DhanClient::new("your-client-id", "your-access-token");
let req = OptionChainRequest {
underlying_scrip: 13.to_string(),
underlying_seg: "IDX_I".into(),
expiry: "2026-02-26".into(),
};
let chain = client.get_option_chain(&req).await?;
println!("NIFTY spot: {:?}", chain.last_price);
for (strike, data) in &chain.oc {
if let Some(ce) = &data.ce {
println!("Strike {strike} CE — LTP: {:?}, IV: {:?}, Delta: {:?}",
ce.last_price, ce.implied_volatility,
ce.greeks.as_ref().map(|g| g.delta));
}
}
Ok(())
}
```
## Architecture
```
dhan-rs/
├── src/
│ ├── lib.rs # Crate root, re-exports
│ ├── client.rs # DhanClient — HTTP client with auth
│ ├── error.rs # DhanError enum, Result alias
│ ├── constants.rs # Base URLs, WebSocket URLs, rate limits
│ ├── types/ # Request/response structs
│ │ ├── enums.rs # 22+ shared enums (ExchangeSegment, OrderType, etc.)
│ │ ├── orders.rs # Order types
│ │ ├── super_order.rs # Super Order types
│ │ ├── forever_order.rs # Forever/GTT Order types
│ │ ├── conditional.rs # Conditional trigger types
│ │ ├── portfolio.rs # Holdings, Positions
│ │ ├── funds.rs # Margin calculator, fund limits
│ │ ├── historical.rs # OHLCV candle types
│ │ ├── option_chain.rs # Option chain + Greeks
│ │ ├── market_quote.rs # LTP, OHLC, depth quotes
│ │ ├── postback.rs # Webhook payload type
│ │ └── ... # auth, edis, profile, statements, etc.
│ ├── api/ # Endpoint implementations (impl DhanClient)
│ │ ├── orders.rs # 10 order endpoints
│ │ ├── portfolio.rs # Holdings, positions, convert, exit
│ │ ├── auth.rs # Token generation, consent flows
│ │ └── ... # 15 modules total
│ └── ws/ # WebSocket streaming
│ ├── market_feed.rs # Binary market feed parser + Stream impl
│ └── order_update.rs # JSON order update Stream impl
```
All 55+ API methods are implemented as `async fn` on `DhanClient`, grouped into
extension trait blocks across the `api/` modules. WebSocket streams implement
`futures_util::Stream` for seamless integration with async combinators.
## API Reference
Full documentation is available on [docs.rs](https://docs.rs/dhan-rs).
### DhanClient Methods
<details>
<summary><strong>Orders</strong> (10 methods)</summary>
| `place_order(req)` | Place a new order |
| `modify_order(order_id, req)` | Modify a pending order |
| `cancel_order(order_id)` | Cancel an open order |
| `slice_order(req)` | Slice a large order into smaller ones |
| `get_orders()` | Get all orders for the day |
| `get_order(order_id)` | Get a specific order by ID |
| `get_order_by_correlation_id(id)` | Get order by external correlation ID |
| `get_trades()` | Get all trades for the day |
| `get_trades_for_order(order_id)` | Get trades for a specific order |
</details>
<details>
<summary><strong>Super Orders</strong> (4 methods)</summary>
| `place_super_order(req)` | Place a bracket/cover order |
| `modify_super_order(order_id, req)` | Modify a super order |
| `cancel_super_order(order_id, leg)` | Cancel a super order leg |
| `get_super_orders()` | Get all super orders |
</details>
<details>
<summary><strong>Forever Orders</strong> (4 methods)</summary>
| `create_forever_order(req)` | Create a GTT/OCO order |
| `modify_forever_order(order_id, req)` | Modify a forever order |
| `delete_forever_order(order_id)` | Delete a forever order |
| `get_all_forever_orders()` | Get all forever orders |
</details>
<details>
<summary><strong>Conditional Triggers</strong> (5 methods)</summary>
| `place_conditional_trigger(req)` | Create a conditional trigger |
| `modify_conditional_trigger(id, req)` | Modify a trigger |
| `delete_conditional_trigger(id)` | Delete a trigger |
| `get_conditional_trigger(id)` | Get a specific trigger |
| `get_all_conditional_triggers()` | Get all triggers |
</details>
<details>
<summary><strong>Portfolio</strong> (4 methods)</summary>
| `get_holdings()` | Get demat holdings |
| `get_positions()` | Get open positions |
| `convert_position(req)` | Convert position product type |
| `exit_all_positions()` | Exit all open positions |
</details>
<details>
<summary><strong>Funds & Margin</strong> (3 methods)</summary>
| `calculate_margin(req)` | Calculate margin for a single order |
| `calculate_multi_margin(req)` | Calculate margin for multiple orders |
| `get_fund_limit()` | Get available fund limits |
</details>
<details>
<summary><strong>Market Data</strong> (7 methods)</summary>
| `get_ltp(req)` | Get last traded price |
| `get_ohlc(req)` | Get OHLC data |
| `get_quote(req)` | Get full market depth quote |
| `get_daily_historical(req)` | Get daily OHLCV candles |
| `get_intraday_historical(req)` | Get intraday candles |
| `get_option_chain(req)` | Get option chain with Greeks |
| `get_expiry_list(req)` | Get expiry dates |
</details>
<details>
<summary><strong>Other</strong> (16 methods)</summary>
| `generate_access_token(...)` | Generate JWT access token |
| `renew_token()` | Renew expiring token |
| `generate_consent(...)` / `consume_consent(...)` | API key consent flow |
| `partner_generate_consent(...)` / `partner_consume_consent(...)` | Partner consent flow |
| `get_profile()` | Get user profile |
| `set_ip(req)` / `modify_ip(req)` / `get_ip()` | Static IP management |
| `generate_tpin()` / `generate_edis_form(req)` / `inquire_edis(isin)` | eDIS |
| `manage_kill_switch(status)` / `get_kill_switch_status()` | Kill switch |
| `set_pnl_exit(req)` / `stop_pnl_exit()` / `get_pnl_exit()` | P&L-based exit |
| `get_ledger(from, to)` / `get_trade_history(from, to, page)` | Statements |
</details>
## Rate Limits
DhanHQ enforces the following rate limits:
| Orders | 10 | 250 | 1,000 | 7,000 |
| Data (REST) | 5 | — | — | 100,000 |
| Historical | 1 | — | — | — |
| Instruments | 20 | — | — | — |
- Max 25 modifications per order
- Option Chain: 1 request per 3 seconds
- Market Quote: up to 1,000 instruments per request
- WebSocket: 5 connections per user, 5,000 instruments each
> **Note:** This library does **not** enforce rate limits automatically. You are
> responsible for staying within the limits.
## Dependencies
| `reqwest` | Async HTTP client (rustls-tls) |
| `serde` / `serde_json` | JSON serialization |
| `tokio` | Async runtime |
| `tokio-tungstenite` | WebSocket client (rustls-tls) |
| `thiserror` | Error type derivation |
| `chrono` | Date/time handling |
| `tracing` | Structured logging |
| `url` | URL construction |
| `futures-util` | Stream/Sink traits for WebSocket |
## Requirements
- Rust 2024 edition (1.85+)
- A DhanHQ trading account with API access
- Access token from [DhanHQ Developer Portal](https://dhanhq.co/docs/v2/)
## License
This project is licensed under the [MIT License](LICENSE).
## Disclaimer
This is an **unofficial**, **AI-generated** client library. It is **not**
affiliated with, endorsed by, or supported by DhanHQ or Dhan. Use at your own
risk. See [DISCLAIMER.md](DISCLAIMER.md) for full details.
Trading in financial markets involves substantial risk of loss. This software
is provided "as is" without warranty of any kind. The authors are not
responsible for any financial losses incurred through the use of this library.