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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Common data types used across the API.

use chrono::{DateTime, NaiveDate, Utc};
use serde::{Deserialize, Serialize};

/// Represents a timestamp in the API responses.
pub type Timestamp = DateTime<Utc>;

/// Represents a date without time information.
pub type Date = NaiveDate;

/// Common response wrapper for paginated results.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PaginatedResponse<T> {
    /// The data items.
    pub data: Vec<T>,
    /// Total number of items available.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total: Option<i64>,
    /// Number of items per page.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub count: Option<i64>,
}

/// Market status.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum MarketStatus {
    /// Market is open.
    Open,
    /// Market is closed.
    Closed,
    /// Pre-market hours.
    #[serde(rename = "pre-market")]
    PreMarket,
    /// After-hours trading.
    #[serde(rename = "after-hours")]
    AfterHours,
}

/// Time resolution for candle data.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum Resolution {
    /// 1 minute
    #[serde(rename = "1")]
    OneMinute,
    /// 5 minutes
    #[serde(rename = "5")]
    FiveMinutes,
    /// 15 minutes
    #[serde(rename = "15")]
    FifteenMinutes,
    /// 30 minutes
    #[serde(rename = "30")]
    ThirtyMinutes,
    /// 60 minutes
    #[serde(rename = "60")]
    SixtyMinutes,
    /// Daily
    #[serde(rename = "D")]
    Daily,
    /// Weekly
    #[serde(rename = "W")]
    Weekly,
    /// Monthly
    #[serde(rename = "M")]
    Monthly,
}

impl Resolution {
    /// Convert to API string representation.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::OneMinute => "1",
            Self::FiveMinutes => "5",
            Self::FifteenMinutes => "15",
            Self::ThirtyMinutes => "30",
            Self::SixtyMinutes => "60",
            Self::Daily => "D",
            Self::Weekly => "W",
            Self::Monthly => "M",
        }
    }
}

/// Exchange codes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Exchange(pub String);

impl Exchange {
    /// US exchanges.
    pub const US: &'static str = "US";
    /// NYSE.
    pub const NYSE: &'static str = "NYSE";
    /// NASDAQ.
    pub const NASDAQ: &'static str = "NASDAQ";
    /// London Stock Exchange.
    pub const LSE: &'static str = "LSE";
    /// Tokyo Stock Exchange.
    pub const TSE: &'static str = "TSE";
}

/// Currency codes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Currency(pub String);

impl Currency {
    /// US Dollar.
    pub const USD: &'static str = "USD";
    /// Euro.
    pub const EUR: &'static str = "EUR";
    /// British Pound.
    pub const GBP: &'static str = "GBP";
    /// Japanese Yen.
    pub const JPY: &'static str = "JPY";
    /// Canadian Dollar.
    pub const CAD: &'static str = "CAD";
    /// Australian Dollar.
    pub const AUD: &'static str = "AUD";
}

/// Represents a price/volume bar.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Candle {
    /// Open price.
    #[serde(rename = "o")]
    pub open: f64,
    /// High price.
    #[serde(rename = "h")]
    pub high: f64,
    /// Low price.
    #[serde(rename = "l")]
    pub low: f64,
    /// Close price.
    #[serde(rename = "c")]
    pub close: f64,
    /// Volume.
    #[serde(rename = "v")]
    pub volume: f64,
    /// Timestamp.
    #[serde(rename = "t")]
    pub timestamp: i64,
    /// Status (optional).
    #[serde(rename = "s", skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
}

/// Generic key-value metric.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Metric {
    /// Metric name/key.
    pub key: String,
    /// Metric value.
    pub value: serde_json::Value,
}