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
pub mod inverse;
pub mod linear;
pub mod option;
pub mod spot;
use self::{
inverse::InverseTickersResult,
linear::LinearTickersResult,
spot::SpotTickersResult,
option::OptionTickersResult,
};
use crate::{
v5::api::{
BybitApi,
get::Get,
},
constants::{
CATEGORY_INVERSE,
CATEGORY_OPTION,
CATEGORY_LINEAR,
CATEGORY_SPOT,
}
};
use anyhow::Result;
use serde::{
Deserialize,
Serialize,
};
use serde_json::Value;
const PATH: &'static str = "/v5/market/tickers";
impl BybitApi {
/// Retrieves tickers from the market.
///
/// # Arguments
///
/// * `params` - The parameters for the tickers request.
///
/// # Examples
///
/// ```rust
/// use rsbit::v5::api::{
/// get::market::get_tickers::{
/// GetTickersParameters,
/// GetTickersCategory,
/// TickersResult,
/// },
/// BybitApi,
/// };
/// #[tokio::main]
/// async fn main() {
/// let api = BybitApi::new();
/// let params = GetTickersParameters::new(GetTickersCategory::Linear);
/// let response = api.get_tickers(params).await;
/// match response {
/// Ok(result) => {
/// match result.result() {
/// TickersResult::Linear(tickers) => {} // Handle linear tickers,
/// _ => {} // Handle something else,
/// }
/// },
/// Err(err) => {
/// // Handle the error
/// }
/// }
/// }
/// ```
pub async fn get_tickers(&self, params: GetTickersParameters) -> Result<GetTickersResponse> {
self.get(PATH, Some(params), false).await
}
}
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum GetTickersCategory {
Linear,
Option,
Spot,
Inverse,
}
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GetTickersParameters {
category: GetTickersCategory,
symbol: Option<String>,
base_coin: Option<String>,
exp_date: Option<String>,
}
impl GetTickersParameters {
/// Creates a new instance of `GetTickersParameters` with the specified category.
///
/// # Arguments
///
/// * `category` - The category of the tickers.
///
/// # Returns
///
/// A new instance of `GetTickersParameters`.
pub fn new(category: GetTickersCategory) -> Self {
Self {
category,
symbol: None,
base_coin: None,
exp_date: None
}
}
/// Sets the symbol for the `GetTickersParameters`.
///
/// # Arguments
///
/// * `symbol` - The symbol to set.
///
/// # Returns
///
/// The modified `GetTickersParameters` instance.
pub fn with_symbol(mut self, symbol: String) -> Self {
self.symbol = Some(symbol);
self
}
/// Sets the base coin for the `GetTickersParameters`.
///
/// # Arguments
///
/// * `base_coin` - The base coin to set.
///
/// # Returns
///
/// The modified `GetTickersParameters` instance.
pub fn with_base_coin(mut self, base_coin: String) -> Self {
self.base_coin = Some(base_coin);
self
}
/// Sets the expiration date for the `GetTickersParameters`.
///
/// # Arguments
///
/// * `exp_date` - The expiration date to set.
///
/// # Returns
///
/// The modified `GetTickersParameters` instance.
pub fn with_exp_date(mut self, exp_date: String) -> Self {
self.exp_date = Some(exp_date);
self
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GetTickersResponse {
ret_code: i32,
ret_msg: String,
result: TickersResult,
ret_ext_info: Value,
time: u64,
}
impl GetTickersResponse {
pub fn ret_code(&self) -> i32 {
self.ret_code
}
pub fn set_ret_code(&mut self, ret_code: i32) {
self.ret_code = ret_code;
}
pub fn ret_msg(&self) -> &str {
&self.ret_msg
}
pub fn set_ret_msg(&mut self, ret_msg: String) {
self.ret_msg = ret_msg;
}
pub fn result(&self) -> &TickersResult {
&self.result
}
pub fn set_result(&mut self, result: TickersResult) {
self.result = result;
}
pub fn ret_ext_info(&self) -> &Value {
&self.ret_ext_info
}
pub fn set_ret_ext_info(&mut self, ret_ext_info: Value) {
self.ret_ext_info = ret_ext_info;
}
pub fn time(&self) -> u64 {
self.time
}
pub fn set_time(&mut self, time: u64) {
self.time = time;
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(tag = "category", rename_all = "camelCase")]
pub enum TickersResult {
Linear(LinearTickersResult),
Option(OptionTickersResult),
Spot(SpotTickersResult),
Inverse(InverseTickersResult),
}
impl TickersResult {
pub fn linear(&self) -> Option<&LinearTickersResult> {
match self {
TickersResult::Linear(data) => Some(data),
_ => None,
}
}
pub fn option(&self) -> Option<&OptionTickersResult> {
match self {
TickersResult::Option(data) => Some(data),
_ => None,
}
}
pub fn inverse(&self) -> Option<&InverseTickersResult> {
match self {
TickersResult::Inverse(data) => Some(data),
_ => None,
}
}
pub fn spot(&self) -> Option<&SpotTickersResult> {
match self {
TickersResult::Spot(data) => Some(data),
_ => None,
}
}
pub fn category(&self) -> &str {
match self {
TickersResult::Linear(_) => CATEGORY_LINEAR,
TickersResult::Option(_) => CATEGORY_OPTION,
TickersResult::Inverse(_) => CATEGORY_INVERSE,
TickersResult::Spot(_) => CATEGORY_SPOT,
}
}
}