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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Financial data models.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fmt;

/// Financial statements response.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FinancialStatements {
    /// Symbol.
    pub symbol: String,
    /// Financial data.
    pub financials: Vec<HashMap<String, serde_json::Value>>,
}

/// Basic financials data.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BasicFinancials {
    /// Symbol.
    pub symbol: String,
    /// Metric data.
    pub metric: HashMap<String, serde_json::Value>,
    /// Metric type.
    #[serde(rename = "metricType")]
    pub metric_type: String,
    /// Series data.
    pub series: Option<serde_json::Value>,
}

/// Financial report data.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FinancialReport {
    /// Access number.
    #[serde(rename = "accessNumber")]
    pub access_number: Option<String>,
    /// Symbol.
    pub symbol: Option<String>,
    /// CIK.
    pub cik: Option<String>,
    /// Year.
    pub year: Option<i64>,
    /// Quarter.
    pub quarter: Option<i64>,
    /// Form type.
    pub form: Option<String>,
    /// Period start date.
    #[serde(rename = "startDate")]
    pub start_date: Option<String>,
    /// Period end date.
    #[serde(rename = "endDate")]
    pub end_date: Option<String>,
    /// Filed date.
    #[serde(rename = "filedDate")]
    pub filed_date: Option<String>,
    /// Accepted date.
    #[serde(rename = "acceptedDate")]
    pub accepted_date: Option<String>,
    /// Report data as JSON object.
    pub report: Option<serde_json::Value>,
}

/// Financials as reported.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FinancialsAsReported {
    /// Symbol.
    pub symbol: Option<String>,
    /// CIK.
    pub cik: Option<String>,
    /// Array of financial reports.
    pub data: Vec<FinancialReport>,
}

/// Earnings data.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Earnings {
    /// Actual earnings.
    pub actual: Option<f64>,
    /// Estimated earnings.
    pub estimate: Option<f64>,
    /// Earnings period.
    pub period: String,
    /// Earnings surprise.
    pub surprise: Option<f64>,
    /// Earnings surprise percentage.
    #[serde(rename = "surprisePercent")]
    pub surprise_percent: Option<f64>,
    /// Symbol.
    pub symbol: String,
}

/// Financial statement type.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub enum StatementType {
    /// Balance sheet
    #[serde(rename = "bs")]
    BalanceSheet,
    /// Income statement
    #[serde(rename = "ic")]
    IncomeStatement,
    /// Cash flow statement
    #[serde(rename = "cf")]
    CashFlow,
}

impl fmt::Display for StatementType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StatementType::BalanceSheet => write!(f, "bs"),
            StatementType::IncomeStatement => write!(f, "ic"),
            StatementType::CashFlow => write!(f, "cf"),
        }
    }
}

/// Financial statement frequency.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub enum StatementFrequency {
    /// Annual
    #[serde(rename = "annual")]
    Annual,
    /// Quarterly
    #[serde(rename = "quarterly")]
    Quarterly,
    /// TTM (Trailing Twelve Months)
    #[serde(rename = "ttm")]
    TTM,
}

impl fmt::Display for StatementFrequency {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StatementFrequency::Annual => write!(f, "annual"),
            StatementFrequency::Quarterly => write!(f, "quarterly"),
            StatementFrequency::TTM => write!(f, "ttm"),
        }
    }
}