dhan-rs 0.1.7

Unofficial Rust client library for the DhanHQ Broker API v2 — orders, market data, WebSocket feeds, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! Order management endpoints.

use crate::client::{DhanClient, required_path_segment};
use crate::error::Result;
use crate::types::orders::*;

impl DhanClient {
    /// Place a new order.
    ///
    /// **Endpoint:** `POST /v2/orders`
    pub async fn place_order(&self, req: &PlaceOrderRequest) -> Result<OrderResponse> {
        self.post("/v2/orders", req).await
    }

    /// Modify a pending order.
    ///
    /// **Endpoint:** `PUT /v2/orders/{order-id}`
    pub async fn modify_order(
        &self,
        order_id: &str,
        req: &ModifyOrderRequest,
    ) -> Result<OrderResponse> {
        let order_id = required_path_segment("order_id", order_id)?;
        self.put(&format!("/v2/orders/{order_id}"), req).await
    }

    /// Cancel a pending order.
    ///
    /// **Endpoint:** `DELETE /v2/orders/{order-id}`
    pub async fn cancel_order(&self, order_id: &str) -> Result<OrderResponse> {
        let order_id = required_path_segment("order_id", order_id)?;
        self.delete(&format!("/v2/orders/{order_id}")).await
    }

    /// Slice an order into multiple legs (for quantities over freeze limit).
    ///
    /// **Endpoint:** `POST /v2/orders/slicing`
    pub async fn slice_order(&self, req: &PlaceOrderRequest) -> Result<Vec<OrderResponse>> {
        self.post("/v2/orders/slicing", req).await
    }

    /// Retrieve all orders for the day.
    ///
    /// **Endpoint:** `GET /v2/orders`
    pub async fn get_orders(&self) -> Result<Vec<OrderDetail>> {
        self.get("/v2/orders").await
    }

    /// Retrieve a specific order by its ID.
    ///
    /// **Endpoint:** `GET /v2/orders/{order-id}`
    pub async fn get_order(&self, order_id: &str) -> Result<OrderDetail> {
        let order_id = required_path_segment("order_id", order_id)?;
        self.get(&format!("/v2/orders/{order_id}")).await
    }

    /// Retrieve an order by its correlation ID.
    ///
    /// **Endpoint:** `GET /v2/orders/external/{correlation-id}`
    pub async fn get_order_by_correlation_id(&self, correlation_id: &str) -> Result<OrderDetail> {
        let correlation_id = required_path_segment("correlation_id", correlation_id)?;
        self.get(&format!("/v2/orders/external/{correlation_id}"))
            .await
    }

    /// Retrieve all trades for the day.
    ///
    /// **Endpoint:** `GET /v2/trades`
    pub async fn get_trades(&self) -> Result<Vec<TradeDetail>> {
        self.get("/v2/trades").await
    }

    /// Retrieve trades for a specific order.
    ///
    /// **Endpoint:** `GET /v2/trades/{order-id}`
    pub async fn get_trades_for_order(&self, order_id: &str) -> Result<Vec<TradeDetail>> {
        let order_id = required_path_segment("order_id", order_id)?;
        self.get(&format!("/v2/trades/{order_id}")).await
    }
}