finnhub 0.2.2

A comprehensive Rust client for the Finnhub.io financial data API with 96% endpoint coverage, flexible rate limiting, and WebSocket support
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
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Ownership data endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::stock::{FundOwnership, OwnershipData},
};

/// Ownership data endpoints.
pub struct OwnershipEndpoints<'a> {
    client: &'a FinnhubClient,
}

impl<'a> OwnershipEndpoints<'a> {
    /// Create a new ownership endpoints instance.
    pub fn new(client: &'a FinnhubClient) -> Self {
        Self { client }
    }

    /// Get company ownership data.
    ///
    /// Returns a list of company shareholders/owners.
    pub async fn institutional(&self, symbol: &str, limit: Option<i64>) -> Result<OwnershipData> {
        let url = if let Some(limit) = limit {
            format!("/stock/ownership?symbol={}&limit={}", symbol, limit)
        } else {
            format!("/stock/ownership?symbol={}", symbol)
        };
        self.client.get(&url).await
    }

    /// Get fund ownership.
    ///
    /// Get a list of funds that hold shares of a company.
    ///
    /// # Arguments
    /// * `symbol` - Stock symbol
    /// * `limit` - Limit number of results (optional)
    pub async fn fund(&self, symbol: &str, limit: Option<i64>) -> Result<FundOwnership> {
        let url = if let Some(limit) = limit {
            format!("/stock/fund-ownership?symbol={}&limit={}", symbol, limit)
        } else {
            format!("/stock/fund-ownership?symbol={}", symbol)
        };
        self.client.get(&url).await
    }
}

#[cfg(test)]
mod tests {
    use crate::{ClientConfig, FinnhubClient, RateLimitStrategy};

    async fn test_client() -> FinnhubClient {
        dotenv::dotenv().ok();
        let api_key = std::env::var("FINNHUB_API_KEY").unwrap_or_else(|_| "test_key".to_string());

        let mut config = ClientConfig::default();
        config.rate_limit_strategy = RateLimitStrategy::FifteenSecondWindow;
        FinnhubClient::with_config(api_key, config)
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_institutional_ownership() {
        let client = test_client().await;
        let result = client.stock().ownership("AAPL", None).await;

        assert!(
            result.is_ok(),
            "Failed to get institutional ownership: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_institutional_ownership_with_limit() {
        let client = test_client().await;
        let limit = 10;
        let result = client.stock().ownership("MSFT", Some(limit)).await;

        assert!(
            result.is_ok(),
            "Failed to get institutional ownership with limit: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_fund_ownership() {
        let client = test_client().await;
        let result = client.stock().fund_ownership("AAPL", None).await;

        assert!(
            result.is_ok(),
            "Failed to get fund ownership: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_fund_ownership_with_limit() {
        let client = test_client().await;
        let limit = 5;
        let result = client.stock().fund_ownership("GOOGL", Some(limit)).await;

        assert!(
            result.is_ok(),
            "Failed to get fund ownership with limit: {:?}",
            result.err()
        );
    }
}