gurufocus_api 0.9.0

A rust adapter to the GuruFocus API, a provider of financial data.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use serde::Deserialize;
use serde_json::Value;

pub use crate::strnum::FloatOrString;

/// Structure holding all key ratios for a single stock.
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct KeyRatios {
    #[serde(rename = "Basic")]
    pub basic: Basic,
    #[serde(rename = "Fundamental")]
    pub fundamental: Value,
    #[serde(rename = "Valuation Ratio")]
    pub valuation_ratio: Value,
    #[serde(rename = "Profitability")]
    pub profitability: Value,
    #[serde(rename = "Growth")]
    pub growth: Value,
    #[serde(rename = "Price")]
    pub price: Value,
    #[serde(rename = "Dividends")]
    pub dividends: Value,
    #[serde(rename = "Income Statement")]
    pub income_statement: Option<IncomeStatement>,
    #[serde(rename = "Valuation")]
    pub valuation: Option<Valuation>,
    #[serde(rename = "Quality")]
    pub quality: Option<Quality>,
}

#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct IncomeStatement {
    #[serde(rename = "Selling, General, & Admin. Expense")]
    pub selling_general_and_admin_expense: FloatOrString,
}

#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct Basic {
    #[serde(rename = "Price Updated Time")]
    pub price_updated_time: String,
    #[serde(rename = "Company")]
    pub company: String,
}

#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct Valuation {
    #[serde(rename = "Earnings Power Value (EPV)")]
    pub epv: FloatOrString,
}

#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct Quality {
    #[serde(rename = "Predictability Rank")]
    pub predictability_rank: FloatOrString,
}

/// Container for analyst estimates for all periods
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct AnalystEstimates {
    pub annual: PeriodAnalystEstimate,
    pub quarterly: PeriodAnalystEstimate,
}

/// Container for analyst estimates for annual periods
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct PeriodAnalystEstimate {
    pub long_term_growth_rate_mean: FloatOrString,
    pub long_term_revenue_growth_rate_mean: FloatOrString,
    pub date: Vec<String>,
    pub revenue_estimate: Vec<FloatOrString>,
    pub eps_nri_estimate: Vec<FloatOrString>,
    pub per_share_eps_estimate: Vec<FloatOrString>,
    pub ebit_estimate: Vec<FloatOrString>,
    pub ebitda_estimate: Vec<FloatOrString>,
    pub dividend_estimate: Vec<FloatOrString>,
    pub gross_margin_estimate: Vec<FloatOrString>,
    pub net_income_estimate: Vec<FloatOrString>,
    pub pettm_estimate: Vec<FloatOrString>,
    pub pretax_income_estimate: Vec<FloatOrString>,
    pub roa_estimate: Vec<FloatOrString>,
    pub roe_estimate: Vec<FloatOrString>,
    pub operating_cash_flow_per_share_estimate: Vec<FloatOrString>,
    pub book_value_per_share_estimate: Option<Vec<FloatOrString>>,
    pub future_per_share_eps_estimate_growth: Option<FloatOrString>,
    pub future_eps_nri_estimate_growth: Option<FloatOrString>,
    pub future_revenue_estimate_growth: Option<FloatOrString>,
    pub future_ebit_estimate_growth: Option<FloatOrString>,
    pub future_ebitda_estimate_growth: Option<FloatOrString>,
    pub future_dividend_estimate_growth: Option<FloatOrString>,
    pub future_net_income_estimate_growth: Option<FloatOrString>,
    pub future_pretax_income_estimate_growth: Option<FloatOrString>,
    pub future_book_value_per_share_estimate_growth: Option<FloatOrString>,
    pub future_roa_estimate_growth: Option<FloatOrString>,
    pub future_roe_estimate_growth: Option<FloatOrString>,
    pub future_gross_margin_estimate_growth: Option<FloatOrString>,
    pub future_operating_cash_flow_per_share_estimate_growth: Option<FloatOrString>,
}

#[cfg(test)]
mod tests {
    use super::super::*;
    use super::*;
    use std::env;

    #[tokio::test]
    async fn test_key_ratios() {
        if let Ok(token) = env::var("GURUFOCUS_TOKEN") {
            if !token.is_empty() {
                let gf_connect = GuruFocusConnector::new(token);

                // Get key ratios of Berkshire Hathaway
                let stock = "NYSE:BRK.A";
                let key_ratios_json = gf_connect.get_key_ratios(stock).await;
                assert!(key_ratios_json.is_ok());

                let key_ratios = serde_json::from_value::<KeyRatios>(key_ratios_json.unwrap());
                assert!(key_ratios.is_ok());
            }
        }
    }

    #[tokio::test]
    async fn test_analyst_estimates() {
        if let Ok(token) = env::var("GURUFOCUS_TOKEN") {
            if !token.is_empty() {
                let gf_connect = GuruFocusConnector::new(token);

                let stock = "NAS:CSCO";
                let estimates_json = gf_connect.get_analyst_estimate(stock).await;
                assert!(estimates_json.is_ok());

                let estimates = serde_json::from_value::<AnalystEstimates>(estimates_json.unwrap());
                assert!(estimates.is_ok());
            }
        }
    }
}