revolutx 0.5.1

Unofficial Rust SDK for the Revolut X Crypto Exchange REST 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
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
254
255
256
257
258
259
260
261
262
263

//! Market data models: order books, candles, tickers, and public trades.

use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};

use super::common::{Timestamp, string_u64};

/// Which side of the order book a price level belongs to.
///
/// Note the exchange spells the buy side `BUYI` on the wire (not `BUY`); the
/// SDK maps it to [`BookSide::Buy`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum BookSide {
    /// A resting sell order (ask).
    #[serde(rename = "SELL")]
    Sell,
    /// A resting buy order (bid).
    #[serde(rename = "BUYI")]
    Buy,
    /// A side this SDK version does not recognize (forward compatibility) — so a
    /// new wire value does not fail deserialization of a whole order book.
    #[serde(other)]
    Unknown,
}

/// A single aggregated price level in an order book.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct OrderBookLevel {
    /// Crypto-asset ID code (`aid`), e.g. `ETH`.
    #[serde(rename = "aid")]
    pub asset_id: String,
    /// Crypto-asset full name (`anm`), e.g. `Ethereum`.
    #[serde(rename = "anm")]
    pub asset_name: String,
    /// Which side of the book this level is on (`s`).
    #[serde(rename = "s")]
    pub side: BookSide,
    /// Price in major currency units (`p`).
    #[serde(rename = "p", with = "rust_decimal::serde::str")]
    pub price: Decimal,
    /// Price currency (`pc`), e.g. `USD`.
    #[serde(rename = "pc")]
    pub price_currency: String,
    /// Price notation (`pn`), e.g. `MONE`.
    #[serde(rename = "pn")]
    pub price_notation: String,
    /// Aggregated quantity at this price level (`q`).
    #[serde(rename = "q", with = "rust_decimal::serde::str")]
    pub quantity: Decimal,
    /// Quantity currency (`qc`).
    #[serde(rename = "qc")]
    pub quantity_currency: String,
    /// Quantity notation (`qn`), e.g. `UNIT`.
    #[serde(rename = "qn")]
    pub quantity_notation: String,
    /// Venue of execution (`ve`), always `REVX`.
    #[serde(rename = "ve")]
    pub venue_of_execution: String,
    /// Number of orders aggregated at this level (`no`).
    #[serde(rename = "no", with = "string_u64")]
    pub number_of_orders: u64,
    /// Trading system (`ts`), always `CLOB`.
    #[serde(rename = "ts")]
    pub trading_system: String,
    /// Publication time of this level (`pdt`).
    #[serde(rename = "pdt")]
    pub published_at: Timestamp,
}

/// An order book snapshot.
///
/// Used by both the authenticated and public order-book endpoints; the only
/// wire difference (millisecond vs ISO-8601 timestamps) is absorbed by
/// [`Timestamp`].
///
/// Both sides are **best-first** regardless of wire order: `bids[0]` is the
/// highest bid and `asks[0]` the lowest ask.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(from = "RawOrderBook")]
pub struct OrderBook {
    /// Ask (sell) levels, best (lowest price) first.
    pub asks: Vec<OrderBookLevel>,
    /// Bid (buy) levels, best (highest price) first.
    pub bids: Vec<OrderBookLevel>,
    /// When the snapshot was generated.
    pub timestamp: Timestamp,
}

#[derive(Deserialize)]
struct RawOrderBook {
    data: RawOrderBookData,
    metadata: RawTimestampMeta,
}

#[derive(Deserialize)]
struct RawOrderBookData {
    asks: Vec<OrderBookLevel>,
    bids: Vec<OrderBookLevel>,
}

#[derive(Deserialize)]
struct RawTimestampMeta {
    timestamp: Timestamp,
}

impl From<RawOrderBook> for OrderBook {
    fn from(raw: RawOrderBook) -> Self {
        let mut asks = raw.data.asks;
        let mut bids = raw.data.bids;
        // The exchange sends BOTH sides price-descending (measured in
        // production, 2026-07-02): best-first for bids but WORST-first for
        // asks. Impose best-first on both sides instead of exposing wire
        // order — a consumer walking `asks` from index 0 must start at the
        // touch. Stable sorts: equal-price levels keep their wire order.
        asks.sort_by_key(|level| level.price);
        bids.sort_by_key(|level| std::cmp::Reverse(level.price));
        Self {
            asks,
            bids,
            timestamp: raw.metadata.timestamp,
        }
    }
}

/// A single OHLCV candle.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Candle {
    /// Start time of the candle.
    pub start: Timestamp,
    /// Opening price.
    #[serde(with = "rust_decimal::serde::str")]
    pub open: Decimal,
    /// Highest price during the interval.
    #[serde(with = "rust_decimal::serde::str")]
    pub high: Decimal,
    /// Lowest price during the interval.
    #[serde(with = "rust_decimal::serde::str")]
    pub low: Decimal,
    /// Closing price.
    #[serde(with = "rust_decimal::serde::str")]
    pub close: Decimal,
    /// Total trading volume during the interval.
    #[serde(with = "rust_decimal::serde::str")]
    pub volume: Decimal,
}

/// A real-time best bid/ask and last-trade snapshot for a trading pair.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Ticker {
    /// The trading pair, e.g. `BTC/USD`.
    pub symbol: String,
    /// Best bid price.
    #[serde(with = "rust_decimal::serde::str")]
    pub bid: Decimal,
    /// Best ask price.
    #[serde(with = "rust_decimal::serde::str")]
    pub ask: Decimal,
    /// Midpoint between best bid and best ask.
    #[serde(with = "rust_decimal::serde::str")]
    pub mid: Decimal,
    /// Price of the most recent trade.
    #[serde(with = "rust_decimal::serde::str")]
    pub last_price: Decimal,
}

/// A set of tickers and the time they were captured.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(from = "RawTickers")]
pub struct Tickers {
    /// The per-pair tickers.
    pub tickers: Vec<Ticker>,
    /// When the data was captured.
    pub timestamp: Timestamp,
}

#[derive(Deserialize)]
struct RawTickers {
    data: Vec<Ticker>,
    metadata: RawTimestampMeta,
}

impl From<RawTickers> for Tickers {
    fn from(raw: RawTickers) -> Self {
        Self {
            tickers: raw.data,
            timestamp: raw.metadata.timestamp,
        }
    }
}

/// A single public market trade.
///
/// Returned by both `GET /trades/all/{symbol}` (millisecond timestamps) and
/// `GET /public/last-trades` (ISO-8601 timestamps); [`Timestamp`] absorbs the
/// difference. The exchange uses short JSON keys, which the SDK renames to
/// readable fields.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Trade {
    /// Trade date and time (`tdt`).
    #[serde(rename = "tdt")]
    pub traded_at: Timestamp,
    /// Crypto-asset ID code (`aid`).
    #[serde(rename = "aid")]
    pub asset_id: String,
    /// Crypto-asset full name (`anm`).
    #[serde(rename = "anm")]
    pub asset_name: String,
    /// Trade price (`p`).
    #[serde(rename = "p", with = "rust_decimal::serde::str")]
    pub price: Decimal,
    /// Price currency (`pc`).
    #[serde(rename = "pc")]
    pub price_currency: String,
    /// Price notation (`pn`).
    #[serde(rename = "pn")]
    pub price_notation: String,
    /// Traded quantity (`q`).
    #[serde(rename = "q", with = "rust_decimal::serde::str")]
    pub quantity: Decimal,
    /// Quantity currency (`qc`).
    #[serde(rename = "qc")]
    pub quantity_currency: String,
    /// Quantity notation (`qn`).
    #[serde(rename = "qn")]
    pub quantity_notation: String,
    /// Venue of execution (`ve`), always `REVX`.
    #[serde(rename = "ve")]
    pub venue_of_execution: String,
    /// Publication date and time (`pdt`).
    #[serde(rename = "pdt")]
    pub published_at: Timestamp,
    /// Venue of publication (`vp`), always `REVX`.
    #[serde(rename = "vp")]
    pub venue_of_publication: String,
    /// Transaction identification code (`tid`).
    #[serde(rename = "tid")]
    pub trade_id: String,
}

/// The latest public trades and the time they were captured.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(from = "RawLastTrades")]
pub struct LastTrades {
    /// The most recent trades.
    pub trades: Vec<Trade>,
    /// When the data was generated.
    pub timestamp: Timestamp,
}

#[derive(Deserialize)]
struct RawLastTrades {
    data: Vec<Trade>,
    metadata: RawTimestampMeta,
}

impl From<RawLastTrades> for LastTrades {
    fn from(raw: RawLastTrades) -> Self {
        Self {
            trades: raw.data,
            timestamp: raw.metadata.timestamp,
        }
    }
}