fugle-marketdata-core 0.1.0

Internal kernel for the Fugle market data SDK. End users should depend on `fugle-marketdata` instead.
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
101
102

//! Stock technical indicator endpoints
//!
//! Provides access to technical analysis indicators:
//! - SMA (Simple Moving Average)
//! - RSI (Relative Strength Index)
//! - KDJ (Stochastic Oscillator)
//! - MACD (Moving Average Convergence Divergence)
//! - BB (Bollinger Bands)

mod bb;
mod kdj;
mod macd;
mod rsi;
mod sma;

pub use bb::BbRequestBuilder;
pub use kdj::KdjRequestBuilder;
pub use macd::MacdRequestBuilder;
pub use rsi::RsiRequestBuilder;
pub use sma::SmaRequestBuilder;

use crate::rest::client::RestClient;

/// Client for accessing stock technical indicator endpoints
pub struct TechnicalClient<'a> {
    client: &'a RestClient,
}

impl<'a> TechnicalClient<'a> {
    /// Create a new technical client
    pub(crate) fn new(client: &'a RestClient) -> Self {
        Self { client }
    }

    /// Create a Simple Moving Average (SMA) request builder
    ///
    /// # Example
    /// ```ignore
    /// let response = client.stock().technical().sma()
    ///     .symbol("2330")
    ///     .period(20)
    ///     .send()?;
    /// ```
    pub fn sma(&self) -> SmaRequestBuilder {
        SmaRequestBuilder::new(self.client)
    }

    /// Create a Relative Strength Index (RSI) request builder
    ///
    /// # Example
    /// ```ignore
    /// let response = client.stock().technical().rsi()
    ///     .symbol("2330")
    ///     .period(14)
    ///     .send()?;
    /// ```
    pub fn rsi(&self) -> RsiRequestBuilder {
        RsiRequestBuilder::new(self.client)
    }

    /// Create a KDJ Stochastic Oscillator request builder
    ///
    /// # Example
    /// ```ignore
    /// let response = client.stock().technical().kdj()
    ///     .symbol("2330")
    ///     .period(9)
    ///     .send()?;
    /// ```
    pub fn kdj(&self) -> KdjRequestBuilder {
        KdjRequestBuilder::new(self.client)
    }

    /// Create a MACD (Moving Average Convergence Divergence) request builder
    ///
    /// # Example
    /// ```ignore
    /// let response = client.stock().technical().macd()
    ///     .symbol("2330")
    ///     .fast(12)
    ///     .slow(26)
    ///     .signal(9)
    ///     .send()?;
    /// ```
    pub fn macd(&self) -> MacdRequestBuilder {
        MacdRequestBuilder::new(self.client)
    }

    /// Create a Bollinger Bands (BB) request builder
    ///
    /// # Example
    /// ```ignore
    /// let response = client.stock().technical().bb()
    ///     .symbol("2330")
    ///     .period(20)
    ///     .stddev(2.0)
    ///     .send()?;
    /// ```
    pub fn bb(&self) -> BbRequestBuilder {
        BbRequestBuilder::new(self.client)
    }
}