birdie 0.1.0

Birdie is a third party Binance API client, allowing you to easily interact with the Binance API using Rust.
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

use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{enums::TickerType, rest_api::endpoint, web_socket_api::web_socket};

use super::{TickerFull, TickerMini};

endpoint!(
    "/api/v3/ticker",
    Method::GET,
    RollingWindowPriceChangeEndpoint,
    RollingWindowPriceChangeParams,
    RollingWindowPriceChangeResponse
);

/// **Note**: This endpoint is different from the GET /api/v3/ticker/24hr
/// endpoint.
///
/// The window used to compute statistics will be no more than 59999ms from the
/// requested windowSize.
///
/// The `openTime` always starts on a minute, while the `closeTime` is the
/// current time of the request. As such, the effective window will be up to
/// 59999ms wider than `windowSize`.
///
/// E.g. If the `closeTime` is 1641287867099 (January 04, 2022 09:17:47:099
/// UTC), and the `windowSize` is 1d. the openTime will be: 1641201420000
/// (January 3, 2022, 09:17:00).
///
/// - Weight:
/// - Data Source: Memory
pub struct RollingWindowPriceChangeEndpoint<'r> {
    client: &'r crate::rest_api::RestApiClient,
}

impl<'r> RollingWindowPriceChangeEndpoint<'r> {
    pub fn new(client: &'r crate::rest_api::RestApiClient) -> Self {
        Self { client }
    }
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RollingWindowPriceChangeParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    symbol: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    symbols: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    window_size: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    r#type: Option<TickerType>,
}

impl Default for RollingWindowPriceChangeParams {
    fn default() -> Self {
        Self::new()
    }
}

impl RollingWindowPriceChangeParams {
    pub fn new() -> Self {
        Self {
            symbol: None,
            symbols: None,
            window_size: None,
            r#type: None,
        }
    }

    pub fn symbol(mut self, symbol: &str) -> Self {
        self.symbol = Some(symbol.to_owned());
        self
    }

    pub fn symbols(mut self, symbols: &[&str]) -> Self {
        self.symbols = Some(symbols.iter().map(|s| s.to_string()).collect());
        self
    }

    /// Defaults to 1d if no parameter provided.
    ///
    /// Supported windowSize values:
    ///
    /// - 1m,2m....59m for minutes
    /// - 1h, 2h....23h - for hours
    /// - 1d...7d - for days
    ///
    /// Units cannot be combined (e.g. 1d2h is not allowed).
    pub fn window_size(mut self, window_size: &str) -> Self {
        self.window_size = Some(window_size.to_owned());
        self
    }

    /// If none provided, the default is FULL.
    pub fn r#type(mut self, r#type: TickerType) -> Self {
        self.r#type = Some(r#type);
        self
    }
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum RollingWindowPriceChangeResponse {
    Full(Box<TickerFull>),
    FullVec(Box<Vec<TickerFull>>),
    Mini(Box<TickerMini>),
    MiniVec(Box<Vec<TickerMini>>),
}

web_socket!(
    "ticker",
    RollingWindowPriceChangeWebSocket,
    RollingWindowPriceChangeParams,
    RollingWindowPriceChangeResponse
);

pub struct RollingWindowPriceChangeWebSocket<'w> {
    client: &'w crate::web_socket_api::WebSocketApiClient,
}

impl<'w> RollingWindowPriceChangeWebSocket<'w> {
    pub fn new(client: &'w crate::web_socket_api::WebSocketApiClient) -> Self {
        Self { client }
    }
}