alpaca_api_client 0.8.0

Unofficial Alpaca API Client
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

use crate::request;
use serde::Deserialize;

#[derive(Deserialize, Debug)]
pub struct ActiveStock {
    pub symbol: String,
    pub volume: u64,
    pub trade_count: u64,
}

#[derive(Deserialize, Debug)]
pub struct ActiveStocksResponse {
    pub most_actives: Vec<ActiveStock>,
    pub last_updated: String,
}

pub struct ActiveStocksQuery<'a> {
    pub url: &'a str,
    by: Option<&'a str>,
    top: Option<i32>,
}

impl<'a> ActiveStocksQuery<'a> {
    pub fn new() -> Self {
        Self {
            url: "https://data.alpaca.markets/v1beta1/screener/stocks/most-actives",
            by: None,
            top: None,
        }
    }

    pub fn by(mut self, by: &'a str) -> Self {
        self.by = Some(by);
        self
    }

    pub fn top(mut self, top: i32) -> Self {
        self.top = Some(top);
        self
    }

    fn build(self) -> String {
        let mut query = String::new();

        if let Some(by) = self.by {
            query.push_str(&format!("&by={by}"));
        }
        if let Some(top) = self.top {
            query.push_str(&format!("&top={top}"));
        }
        format!("{}?{}", self.url, query)
    }

    pub fn send(self) -> Result<Vec<ActiveStock>, ureq::Error> {
        let route = self.build();
        let response = request("GET", &route).call()?;
        let stocks: ActiveStocksResponse = response.into_body().read_json()?;
        Ok(stocks.most_actives)
    }
}

#[derive(Deserialize, Debug)]
pub struct TopMover {
    pub symbol: String,
    pub percent_change: f64,
    pub change: f64,
    pub price: f64,
}

#[derive(Deserialize, Debug)]
pub struct TopMoverResponse {
    pub gainers: Vec<TopMover>,
    pub losers: Vec<TopMover>,
    pub market_type: String,
    pub last_updated: String,
}

pub struct TopMoversQuery {
    url: String,
    top: Option<i32>,
}

pub enum MarketType {
    Stocks,
    Crypto,
}

impl ToString for MarketType {
    fn to_string(&self) -> String {
        match self {
            MarketType::Stocks => "stocks".to_string(),
            MarketType::Crypto => "crypto".to_string(),
        }
    }
}

impl TopMoversQuery {
    pub fn new(market_type: MarketType) -> Self {
        Self {
            url: format!(
                "https://data.alpaca.markets/v1beta1/screener/{}/movers",
                market_type.to_string()
            ),
            top: None,
        }
    }

    pub fn top(mut self, top: i32) -> Self {
        self.top = Some(top);
        self
    }

    fn build(self) -> String {
        let mut query = String::new();
        if let Some(top) = self.top {
            query.push_str(&format!("&top={top}"));
        }
        format!("{}?{}", self.url, query)
    }

    pub fn send(self) -> Result<TopMoverResponse, ureq::Error> {
        let route = self.build();
        let response = request("GET", &route).call()?;
        let movers: TopMoverResponse = response.into_body().read_json()?;
        Ok(movers)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_active_stocks_query() {
        let query = ActiveStocksQuery::new().by("volume").top(5).send().unwrap();

        dbg!(&query);
        assert!(query.len() > 0);
    }

    #[test]
    fn test_top_movers_query() {
        let query = TopMoversQuery::new(MarketType::Stocks)
            .top(5)
            .send()
            .unwrap();
        dbg!(&query);
        assert!(query.gainers.len() > 0);
    }
}