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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
//! Forex (foreign exchange) endpoints
use crate::{
client::FmpClient,
error::Result,
models::crypto::{ForexHistorical, ForexIntraday, ForexPair, ForexQuote},
};
use serde::{Deserialize, Serialize};
/// Forex API endpoints
pub struct Forex {
client: FmpClient,
}
impl Forex {
pub(crate) fn new(client: FmpClient) -> Self {
Self { client }
}
/// Get list of available forex pairs
///
/// Returns all available forex currency pairs.
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let pairs = client.forex().get_forex_list().await?;
/// for pair in pairs.iter().take(10) {
/// println!("{}: {}", pair.symbol, pair.name.as_deref().unwrap_or("N/A"));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_forex_list(&self) -> Result<Vec<ForexPair>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self
.client
.build_url("/symbol/available-forex-currency-pairs");
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
/// Get real-time forex quote
///
/// Returns current exchange rate for a forex pair.
///
/// # Arguments
/// * `pair` - Forex pair (e.g., "EURUSD", "GBPUSD")
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let quote = client.forex().get_forex_quote("EURUSD").await?;
/// if let Some(q) = quote.first() {
/// println!("EUR/USD: {:.5}", q.price.unwrap_or(0.0));
/// println!("Change: {:+.2}%", q.changes_percentage.unwrap_or(0.0));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_forex_quote(&self, pair: &str) -> Result<Vec<ForexQuote>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self.client.build_url(&format!("/quote/{}", pair));
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
/// Get historical forex rates
///
/// Returns daily historical exchange rates for a forex pair.
///
/// # Arguments
/// * `pair` - Forex pair (e.g., "EURUSD")
/// * `from` - Start date (optional, format: YYYY-MM-DD)
/// * `to` - End date (optional, format: YYYY-MM-DD)
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let history = client.forex().get_forex_historical("EURUSD", None, None).await?;
/// for day in history.iter().take(5) {
/// println!("{}: {:.5}", day.date, day.close);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_forex_historical(
&self,
pair: &str,
from: Option<&str>,
to: Option<&str>,
) -> Result<Vec<ForexHistorical>> {
#[derive(Serialize)]
struct Query<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
from: Option<&'a str>,
#[serde(skip_serializing_if = "Option::is_none")]
to: Option<&'a str>,
apikey: &'a str,
}
let url = self
.client
.build_url(&format!("/historical-price-full/{}", pair));
#[derive(serde::Deserialize)]
struct Response {
historical: Vec<ForexHistorical>,
}
let response: Response = self
.client
.get_with_query(
&url,
&Query {
from,
to,
apikey: self.client.api_key(),
},
)
.await?;
Ok(response.historical)
}
/// Get intraday forex rates
///
/// Returns intraday exchange rate data at various intervals.
///
/// # Arguments
/// * `pair` - Forex pair (e.g., "EURUSD")
/// * `interval` - Time interval ("1min", "5min", "15min", "30min", "1hour", "4hour")
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let intraday = client.forex().get_forex_intraday("EURUSD", "5min").await?;
/// for tick in intraday.iter().take(10) {
/// println!("{}: {:.5}", tick.date, tick.close);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_forex_intraday(
&self,
pair: &str,
interval: &str,
) -> Result<Vec<ForexIntraday>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self
.client
.build_url(&format!("/historical-chart/{}/{}", interval, pair));
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
}
#[cfg(test)]
mod tests {
use super::*;
// Golden path tests
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_forex_list() {
let client = FmpClient::new().unwrap();
let result = client.forex().get_forex_list().await;
assert!(result.is_ok());
let pairs = result.unwrap();
assert!(!pairs.is_empty());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_forex_quote() {
let client = FmpClient::new().unwrap();
let result = client.forex().get_forex_quote("EURUSD").await;
assert!(result.is_ok());
let quotes = result.unwrap();
assert!(!quotes.is_empty());
assert!(quotes[0].price.is_some());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_forex_historical() {
let client = FmpClient::new().unwrap();
let result = client
.forex()
.get_forex_historical("EURUSD", None, None)
.await;
assert!(result.is_ok());
let history = result.unwrap();
assert!(!history.is_empty());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_forex_intraday() {
let client = FmpClient::new().unwrap();
let result = client.forex().get_forex_intraday("EURUSD", "5min").await;
assert!(result.is_ok());
let intraday = result.unwrap();
assert!(!intraday.is_empty());
}
// Edge case tests
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_forex_historical_with_dates() {
let client = FmpClient::new().unwrap();
let result = client
.forex()
.get_forex_historical("EURUSD", Some("2024-01-01"), Some("2024-01-31"))
.await;
assert!(result.is_ok());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_various_forex_pairs() {
let client = FmpClient::new().unwrap();
for pair in &["EURUSD", "GBPUSD", "USDJPY"] {
let result = client.forex().get_forex_quote(pair).await;
assert!(result.is_ok());
}
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_various_forex_intervals() {
let client = FmpClient::new().unwrap();
for interval in &["1min", "5min", "15min", "1hour"] {
let result = client.forex().get_forex_intraday("EURUSD", interval).await;
assert!(result.is_ok());
}
}
// Error handling tests
#[tokio::test]
async fn test_invalid_api_key() {
let client = FmpClient::builder()
.api_key("invalid_key_12345")
.build()
.unwrap();
let result = client.forex().get_forex_list().await;
assert!(result.is_err());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_invalid_pair() {
let client = FmpClient::new().unwrap();
let result = client.forex().get_forex_quote("INVALIDPAIR123").await;
// Should return empty or error
match result {
Ok(data) => assert!(data.is_empty()),
Err(_) => {} // Error is acceptable for invalid pair
}
}
}