fugle-marketdata-core 0.7.1

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

//! Stock snapshot endpoints
//!
//! Provides access to market-wide snapshot data:
//! - quotes: Market-wide quotes snapshot
//! - movers: Top gainers and losers
//! - actives: Most active stocks by volume/value

mod actives;
mod movers;
mod quotes;

pub use actives::ActivesRequestBuilder;
pub use movers::MoversRequestBuilder;
pub use quotes::SnapshotQuotesRequestBuilder;

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

/// Snapshot endpoints client for market-wide data
pub struct SnapshotClient<'a> {
    pub(crate) client: &'a RestClient,
}

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

    /// Get market-wide quotes snapshot
    ///
    /// # Example
    /// ```no_run
    /// use marketdata_core::{RestClient, Auth};
    ///
    /// let client = RestClient::new(Auth::SdkToken("my-token".to_string()));
    /// let quotes = client.stock().snapshot().quotes().market("TSE").send()?;
    /// # Ok::<(), marketdata_core::MarketDataError>(())
    /// ```
    pub fn quotes(&self) -> SnapshotQuotesRequestBuilder<'_> {
        SnapshotQuotesRequestBuilder::new(self.client)
    }

    /// Get top movers (gainers/losers) in a market
    ///
    /// # Example
    /// ```no_run
    /// use marketdata_core::{RestClient, Auth};
    ///
    /// let client = RestClient::new(Auth::SdkToken("my-token".to_string()));
    /// let movers = client.stock().snapshot().movers().market("TSE").direction("up").send()?;
    /// # Ok::<(), marketdata_core::MarketDataError>(())
    /// ```
    pub fn movers(&self) -> MoversRequestBuilder<'_> {
        MoversRequestBuilder::new(self.client)
    }

    /// Get most active stocks by volume or value
    ///
    /// # Example
    /// ```no_run
    /// use marketdata_core::{RestClient, Auth};
    ///
    /// let client = RestClient::new(Auth::SdkToken("my-token".to_string()));
    /// let actives = client.stock().snapshot().actives().market("TSE").trade("volume").send()?;
    /// # Ok::<(), marketdata_core::MarketDataError>(())
    /// ```
    pub fn actives(&self) -> ActivesRequestBuilder<'_> {
        ActivesRequestBuilder::new(self.client)
    }
}