yfinance-rs 0.1.1

Ergonomic Rust client for Yahoo Finance, supporting historical prices, real-time streaming, options, fundamentals, and more.
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

use serde::Serialize;

/// A common numeric type for financial values, normalized to `f64`.
pub type Num = f64;

/// A row from an income statement (annual or quarterly).
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct IncomeStatementRow {
    /// The Unix timestamp (in seconds) marking the end of the financial period.
    pub period_end: i64,
    /// The total revenue for the period.
    pub total_revenue: Option<Num>,
    /// The gross profit for the period.
    pub gross_profit: Option<Num>,
    /// The operating income for the period.
    pub operating_income: Option<Num>,
    /// The net income for the period.
    pub net_income: Option<Num>,
}

/// A row from a balance sheet (annual or quarterly).
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct BalanceSheetRow {
    /// The Unix timestamp (in seconds) marking the end of the financial period.
    pub period_end: i64,
    /// The total assets of the company.
    pub total_assets: Option<Num>,
    /// The total liabilities of the company.
    pub total_liabilities: Option<Num>,
    /// The total stockholder equity.
    pub total_equity: Option<Num>,
    /// The amount of cash and cash equivalents.
    pub cash: Option<Num>,
    /// The total long-term debt.
    pub long_term_debt: Option<Num>,
    /// The number of shares outstanding.
    pub shares_outstanding: Option<u64>,
}

/// A row from a cash flow statement (annual or quarterly).
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct CashflowRow {
    /// The Unix timestamp (in seconds) marking the end of the financial period.
    pub period_end: i64,
    /// The total cash flow from operating activities.
    pub operating_cashflow: Option<Num>,
    /// Capital expenditures for the period.
    pub capital_expenditures: Option<Num>,
    /// Free cash flow for the period.
    ///
    /// If Yahoo doesn't provide this, it's calculated as `operating_cashflow - capital_expenditures`.
    pub free_cash_flow: Option<Num>,
    /// The net income for the period.
    pub net_income: Option<Num>,
}

/// A summary of historical and estimated earnings data.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct Earnings {
    /// A history of annual revenue and earnings.
    pub yearly: Vec<EarningsYear>,
    /// A history of quarterly revenue and earnings.
    pub quarterly: Vec<EarningsQuarter>,
    /// A history of quarterly EPS (Earnings Per Share), including actual and estimated values.
    pub quarterly_eps: Vec<EarningsQuarterEps>,
}

/// Annual revenue and earnings data for a single year.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct EarningsYear {
    /// The calendar year.
    pub year: i32,
    /// The total revenue for the year.
    pub revenue: Option<Num>,
    /// The net earnings for the year.
    pub earnings: Option<Num>,
}

/// Quarterly revenue and earnings data for a single quarter.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct EarningsQuarter {
    /// The quarter identifier (e.g., "2Q2024").
    pub period: String,
    /// The total revenue for the quarter.
    pub revenue: Option<Num>,
    /// The net earnings for the quarter.
    pub earnings: Option<Num>,
}

/// Quarterly EPS (Earnings Per Share) data, including actual and estimated values.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct EarningsQuarterEps {
    /// The quarter identifier (e.g., "2Q2024").
    pub period: String,
    /// The actual reported EPS for the quarter.
    pub actual: Option<Num>,
    /// The consensus analyst estimate for EPS for the quarter.
    pub estimate: Option<Num>,
}

/// Corporate calendar events, like earnings and dividend dates.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct Calendar {
    /// A list of upcoming earnings announcement dates as Unix timestamps.
    pub earnings_dates: Vec<i64>,
    /// The ex-dividend date as a Unix timestamp.
    pub ex_dividend_date: Option<i64>,
    /// The dividend payment date as a Unix timestamp.
    pub dividend_date: Option<i64>,
}

/// Represents a single data point in a time series of shares outstanding.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct ShareCount {
    /// The timestamp for the data point.
    pub date: i64,
    /// The number of shares outstanding.
    pub shares: u64,
}