coinbase_pro 0.1.1

A Rust API for retriving data and placing trades on Coinbase Pro
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
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

use chrono::NaiveDateTime;
use serde::{
    Deserialize,
    Serialize,
};

use crate::deserialization::{
    option_iso_date_time,
    option_string_as_float,
    string_as_float,
};

/// # Product Data
/// A strongly typed representation of product data returned by [/products](https://api.exchange.coinbase.com/products).
///
/// CBPro API reference: [Products](https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproducts).
///
///
/// # JSON Input Example
///
/// ```ignore
///{
///     id: "ETH-USD",
///     base_currency: "ETH",
///     quote_currency: "USD",
///     base_min_size: "0.00022",
///     base_max_size: "12000.0",
///     quote_increment: "0.01",
///     base_increment: "0.000000001",
///     display_name: "ETH/USD",
///     min_market_funds: "1.0",
///     max_market_funds: "20000000.0",
///     margin_enabled: false,
///     post_only: false,
///     limit_only: false,
///     cancel_only: false,
///     status: "online",
///     status_message: "",
///     trading_disabled: false,
///     fx_stablecoin: false,
///     max_slippage_percentage: "0.02",
///     auction_mode: false
/// }
/// ```
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct Product {
    pub id: String,
    pub base_currency: String,
    pub quote_currency: String,
    #[serde(with = "string_as_float")]
    pub base_min_size: f64,
    #[serde(with = "string_as_float")]
    pub base_max_size: f64,
    #[serde(with = "string_as_float")]
    pub quote_increment: f64,
    #[serde(with = "string_as_float")]
    pub base_increment: f64,
    pub display_name: String,
    #[serde(with = "string_as_float")]
    pub min_market_funds: f64,
    #[serde(with = "string_as_float")]
    pub max_market_funds: f64,
    pub margin_enabled: bool,
    pub post_only: bool,
    pub limit_only: bool,
    pub cancel_only: bool,
    pub status: String,
    pub status_message: String,
    pub trading_disabled: Option<bool>,
    pub fx_stablecoin: Option<bool>,
    #[serde(with = "option_string_as_float")]
    pub max_slippage_percentage: Option<f64>,
    pub auction_mode: bool,
}

/// # Product Book Data
/// A strongly typed representation of product book data returned by [/products/{product_id}/book](https://api.exchange.coinbase.com/products/{product_id}/book).
///
/// CBPro API reference: [Product Book](https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproductbook).
///
///
/// # JSON Input Example
///
/// ```ignore
///
/// ```
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct ProductBook {
    pub bids: Vec<Orders>,
    pub asks: Vec<Orders>,
    pub sequence: f64,
    pub auction_mode: Option<bool>,
    pub auction: Option<Auction>,
}

/// # Currency Data
/// A strongly typed representation of currency data returned by [/currencies](https://api.exchange.coinbase.com/currencies) and [/currencies/{currency_id}](https://api.exchange.coinbase.com/currencies/{currency_id}).
///
/// CBPro API reference:
/// - [Currencies](https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getcurrencies).
/// - [Currency](https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getcurrency).
///
///
/// # JSON Input Example
///
/// ```ignore
///{
///     "id": "BTC",
///     "name": "Bitcoin",
///     "min_size": "0.00000001",
///     "status": "online",
///     "message": "",
///     "max_precision": "0.00000001",
///     "convertible_to": [],
///     "details":
///     {
///         "type_string": "crypto",
///         "symbol": "₿",
///         "network_confirmations": 3,
///         "sort_order": 20,
///         "crypto_address_link": "https://live.blockcypher.com/btc/address/{{address}}",
///         "crypto_transaction_link": "https://live.blockcypher.com/btc/tx/{{txId}}",
///         "push_payment_methods": ["crypto"],
///         "group_types": ["btc", "crypto"],
///         "display_name": None,
///         "processing_time_seconds": None,
///         "min_withdrawal_amount": 0.0001,
///         "max_withdrawal_amount": 2400.0
///     }
/// }
/// ```
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Currency {
    pub id: String,
    pub name: String,
    pub min_size: String,
    pub status: String,
    pub message: String,
    pub max_precision: String,
    pub convertible_to: Vec<String>,
    pub details: CurrencyDetails,
}

/// # Strongly Typed xxx
/// A strongly typed representation of xxx [xxx](xxx).
///
/// CBPro API reference: [xxx](xxx).
///
///
/// # JSON Input Example
///
/// ```ignore
///
/// ```
///id: string required
///name: string required
///min_size: string required
///status: string required
///message: string
///max_precision: string required
///convertible_to: array of strings
///details: object required
///     type: string
///     symbol: string
///     network_confirmations: int32
///     sort_order: int32
///     crypto_address_link: string
///     crypto_transaction_link: string
///     push_payment_methods: array of strings
///     group_types: array of strings
///     display_name: string
///     processing_time_seconds: float
///     min_withdrawal_amount: double
///     max_withdrawal_amount: double
///
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct CurrencyDetails {
    #[serde(rename = "type")]
    pub type_string: Option<String>,
    pub symbol: Option<String>,
    pub network_confirmations: Option<i32>,
    pub sort_order: Option<i32>,
    pub crypto_address_link: Option<String>,
    pub crypto_transaction_link: Option<String>,
    pub push_payment_methods: Vec<String>,
    pub group_types: Vec<String>,
    pub display_name: Option<String>,
    pub processing_time_seconds: Option<f64>,
    pub min_withdrawal_amount: Option<f64>,
    pub max_withdrawal_amount: Option<f64>,
}

/// # Strongly Typed xxx
/// A strongly typed representation of xxx [xxx](xxx).
///
/// CBPro API reference: [xxx](xxx).
///
///
/// # JSON Input Example
///
/// ```ignore
///
/// ```
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Orders {
    #[serde(with = "string_as_float")]
    pub price: f64,
    #[serde(with = "string_as_float")]
    pub size: f64,
    pub num_orders: i64,
}

/// # Strongly Typed xxx
/// A strongly typed representation of xxx [xxx](xxx).
///
/// CBPro API reference: [xxx](xxx).
///
///
/// # JSON Input Example
///
/// ```ignore
///
/// ```
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct Auction {
    #[serde(with = "string_as_float")]
    pub open_price: f64,
    #[serde(with = "string_as_float")]
    pub open_size: f64,
    #[serde(with = "string_as_float")]
    pub best_bid_price: f64,
    #[serde(with = "string_as_float")]
    pub best_bid_size: f64,
    #[serde(with = "string_as_float")]
    pub best_ask_price: f64,
    #[serde(with = "string_as_float")]
    pub best_ask_size: f64,
    #[serde(with = "string_as_float")]
    pub auction_state: f64,
    pub can_open: Option<String>,
    #[serde(with = "option_iso_date_time")]
    pub time: Option<NaiveDateTime>,
}