fyers-rs 0.0.1

Idiomatic async Rust client for the Fyers API v3 broker APIs.
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! Positions API service.

use crate::client::FyersClient;
use crate::error::Result;
use crate::models::common::ApiStatus;
use crate::models::portfolio::{
    ConvertPositionRequest, ConvertPositionResponse, ExitAllPositionsRequest,
    ExitPositionsByFilterRequest, ExitPositionsByIdRequest, PendingOrderCancelRequest,
};
use crate::models::transactions::PositionsResponse;
use crate::transport::{
    delete_authenticated_json, get_authenticated_json, post_authenticated_json,
};

/// Accessor for Fyers position APIs.
#[derive(Debug, Clone, Copy)]
pub struct PositionsService<'a> {
    client: &'a FyersClient,
}

impl<'a> PositionsService<'a> {
    /// Create a new positions service accessor.
    pub(crate) const fn new(client: &'a FyersClient) -> Self {
        Self { client }
    }

    /// Access the underlying client.
    pub const fn client(&self) -> &'a FyersClient {
        self.client
    }

    /// Fetch current open and closed positions for the authenticated user.
    pub async fn list(&self) -> Result<PositionsResponse> {
        get_authenticated_json(self.client.http(), self.client.config(), "positions").await
    }

    /// Exit all open positions.
    pub async fn exit_all(&self, request: &ExitAllPositionsRequest) -> Result<ApiStatus> {
        delete_authenticated_json(
            self.client.http(),
            self.client.config(),
            "positions",
            request,
        )
        .await
    }

    /// Exit positions by documented ID selector.
    pub async fn exit_by_id(&self, request: &ExitPositionsByIdRequest) -> Result<ApiStatus> {
        delete_authenticated_json(
            self.client.http(),
            self.client.config(),
            "positions",
            request,
        )
        .await
    }

    /// Exit positions by documented segment/side/product filters.
    pub async fn exit_by_filters(
        &self,
        request: &ExitPositionsByFilterRequest,
    ) -> Result<ApiStatus> {
        delete_authenticated_json(
            self.client.http(),
            self.client.config(),
            "positions",
            request,
        )
        .await
    }

    /// Cancel pending orders while exiting positions.
    pub async fn exit_with_pending_order_cancel(
        &self,
        request: &PendingOrderCancelRequest,
    ) -> Result<ApiStatus> {
        delete_authenticated_json(
            self.client.http(),
            self.client.config(),
            "positions",
            request,
        )
        .await
    }

    /// Convert an open position to a different product type.
    pub async fn convert(
        &self,
        request: &ConvertPositionRequest,
    ) -> Result<ConvertPositionResponse> {
        post_authenticated_json(
            self.client.http(),
            self.client.config(),
            "positions",
            request,
        )
        .await
    }
}