rpaca 0.8.1

A rust crate wrapping the Alpaca API
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

use crate::auth::{Alpaca, TradingType};
use crate::request::create_trading_request;
use reqwest::Method;
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;

#[derive(Debug, Deserialize, Serialize, Default, TypedBuilder)]
pub struct CalendarParams {
    #[builder(default, setter(strip_option))]
    pub start: Option<String>,
    #[builder(default, setter(strip_option))]
    pub end: Option<String>,
    #[builder(default, setter(strip_option))]
    pub date_type: Option<String>,
}
#[derive(Debug, Deserialize, Serialize)]
pub struct Calendar {
    pub date: String,
    pub open: String,
    pub close: String,
    pub settlement_date: String,
}

/// Retrieves the trading calendar for market days.
///
/// This function fetches the trading calendar from Alpaca's API, which includes
/// information about market open and close times for trading days. The calendar
/// can be filtered by date range and other parameters.
///
/// # Arguments
/// * `alpaca` - The Alpaca client instance with authentication information
/// * `params` - Parameters to filter the calendar (date range, etc.)
///
/// # Returns
/// * `Result<Vec<Calendar>, Box<dyn std::error::Error>>` - A list of calendar entries or an error
pub async fn get_calendar(
    alpaca: &Alpaca,
    params: CalendarParams,
) -> Result<Vec<Calendar>, Box<dyn std::error::Error>> {
    let base_endpoint = "/v2/calendar";

    // Convert the params struct to a query string
    let query_string = serde_qs::to_string(&params)?;
    let endpoint_with_query = format!("{base_endpoint}?{query_string}");
    let response =
        create_trading_request::<()>(alpaca, Method::GET, &*endpoint_with_query, None).await?;
    if !response.status().is_success() {
        let text = response.text().await.unwrap_or_default();
        return Err(format!("Getting calendar failed: {text}").into());
    }

    Ok(response.json().await?)
}

#[tokio::test]
async fn test_calendar() {
    let alpaca = Alpaca::from_env(TradingType::Paper).unwrap();
    match get_calendar(&alpaca, CalendarParams::builder().build()).await {
        Ok(calendar) => {
            assert_eq!(calendar[0].close, "16:00");
            assert_eq!(calendar[0].date, "1970-01-02");
        }
        Err(e) => panic!("Error: {}", e),
    }
}