alpacars 0.1.2

Async Rust SDK for Alpaca Markets 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
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

use crate::common::client::{base_url, RestClient};
use crate::data::models::CorporateActionsSet;
use crate::error::AlpacaError;
use chrono::NaiveDate;
use serde::Serialize;

#[derive(Debug, Clone, Serialize, Default)]
pub struct CorporateActionsRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub symbols: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub types: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start: Option<NaiveDate>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end: Option<NaiveDate>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
}

/// Async client for the Alpaca Corporate Actions API.
#[derive(Clone)]
pub struct CorporateActionsClient {
    client: RestClient,
}

impl CorporateActionsClient {
    pub fn new(api_key: Option<&str>, secret_key: Option<&str>) -> Result<Self, AlpacaError> {
        Ok(Self {
            client: RestClient::new(
                api_key.map(str::to_string),
                secret_key.map(str::to_string),
                None,
                base_url::DATA.to_string(),
                "v1beta1".to_string(),
                false,
            )?,
        })
    }

    /// Fetch corporate actions (auto-paginated).
    pub async fn get_corporate_actions(
        &self,
        req: &CorporateActionsRequest,
    ) -> Result<CorporateActionsSet, AlpacaError> {
        let mut params = req.clone();
        let mut result = CorporateActionsSet {
            reverse_splits: None,
            forward_splits: None,
            unit_splits: None,
            cash_dividends: None,
            stock_dividends: None,
            spin_offs: None,
            cash_mergers: None,
            stock_mergers: None,
            stock_and_cash_mergers: None,
            redemptions: None,
            name_changes: None,
            worthless_removals: None,
            rights_distributions: None,
            next_page_token: None,
        };

        #[derive(serde::Deserialize)]
        struct Wrapper {
            corporate_actions: Option<CorporateActionsSet>,
            next_page_token: Option<String>,
        }

        loop {
            let resp: Wrapper =
                self.client.get("/corporate-actions", Some(&params)).await?;

            if let Some(data) = resp.corporate_actions {
                macro_rules! merge_vec {
                    ($field:ident) => {
                        if let Some(items) = data.$field {
                            result.$field.get_or_insert_with(Vec::new).extend(items);
                        }
                    };
                }

                merge_vec!(reverse_splits);
                merge_vec!(forward_splits);
                merge_vec!(unit_splits);
                merge_vec!(cash_dividends);
                merge_vec!(stock_dividends);
                merge_vec!(spin_offs);
                merge_vec!(cash_mergers);
                merge_vec!(stock_mergers);
                merge_vec!(stock_and_cash_mergers);
                merge_vec!(redemptions);
                merge_vec!(name_changes);
                merge_vec!(worthless_removals);
                merge_vec!(rights_distributions);
            }

            match resp.next_page_token {
                Some(t) if !t.is_empty() => params.page_token = Some(t),
                _ => break,
            }
        }

        Ok(result)
    }
}