chapaty 1.3.0

An event-driven Rust engine for building and evaluating quantitative trading agents. Features a Gym-style API for algorithmic backtesting and reinforcement learning.
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
use std::{fmt::Debug, hash::Hash};

use serde::{Deserialize, Serialize};

use crate::{
    data::{
        common::ProfileAggregation,
        domain::{
            CountryCode, DataBroker, EconomicCategory, EconomicDataSource, EconomicEventImpact,
            Exchange, Period, Symbol,
        },
        event::{EconomicCalendarId, OhlcvId, TpoId, TradesId, VolumeProfileId},
    },
    error::ChapatyResult,
    indicator::batch::{
        WithBatchIndicators, ohlcv::BatchOhlcvIndicator, trades::BatchTradesIndicator,
    },
};

// ================================================================================================
// OHLCV Configurations
// ================================================================================================

/// Configuration for retrieving OHLCV (Open, High, Low, Close, Volume) data
/// from spot markets.
///
/// OHLCV data represents aggregated price and volume information over specified
/// time periods, commonly used for candlestick charts and technical analysis.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct OhlcvSpotQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// The timeframe for each OHLCV candle (e.g., "1m", "5m", "1h", "1d").
    pub period: Period,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,

    /// Data configurations that support derived technical analysis.
    pub indicators: Vec<BatchOhlcvIndicator>,
}

/// Configuration for retrieving OHLCV (Open, High, Low, Close, Volume) data
/// from futures markets.
///
/// Similar to spot OHLCV data, but specifically for futures contracts which
/// include additional fields like open interest and funding rates.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct OhlcvFutureQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The futures contract symbol. Must be a valid futures symbol format.
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// The timeframe for each OHLCV candle (e.g., "1m", "5m", "1h", "1d").
    pub period: Period,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,

    /// Data configurations that support derived technical analysis.
    pub indicators: Vec<BatchOhlcvIndicator>,
}

// ================================================================================================
// Trade Data Configuration
// ================================================================================================

/// Configuration for retrieving trade-level spot market data.
///
/// Trade data represents individual trades or price updates at the finest
/// granularity, capturing every market transaction with microsecond precision.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TradesSpotQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    /// Consider larger batch sizes for trade data to optimize throughput.
    pub batch_size: i32,

    /// Data configurations that support derived technical analysis.
    pub indicators: Vec<BatchTradesIndicator>,
}

// ================================================================================================
// TPO Configurations
// ================================================================================================

/// Configuration for retrieving Time Price Opportunity (TPO) data from spot
/// markets.
///
/// TPO, also known as Market Profile, displays market activity organized by
/// price level and time, showing where trading activity has occurred and
/// helping identify key support/resistance levels.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TpoSpotQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price
    /// granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

/// Configuration for retrieving Time Price Opportunity (TPO) data from futures
/// markets.
///
/// TPO data for futures markets, providing Market Profile insights for futures
/// contracts.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TpoFutureQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The futures contract symbol.
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price
    /// granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Volume Profile Configuration
// ================================================================================================

/// Configuration for retrieving Volume Profile data from spot markets.
///
/// Volume Profile shows the distribution of trading volume across different
/// price levels, helping identify high-volume nodes (HVN) and low-volume nodes
/// (LVN) that often act as support or resistance.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct VolumeProfileSpotQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary
    /// exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price
    /// granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Economic Calendar Configuration
// ================================================================================================

/// Configuration for retrieving economic calendar events.
///
/// Economic calendar data provides scheduled releases of economic indicators,
/// central bank announcements, and other market-moving events.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct EconomicCalendarQuery {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// Optional filter by specific data source (e.g., "investingcom", "fred").
    ///
    /// If `None`, retrieves data from all available sources for the broker.
    pub data_source: Option<EconomicDataSource>,

    /// Optional filter by country using ISO 3166-1 alpha-2 code (e.g., "US",
    /// "GB", "JP").
    ///
    /// Special code "EZ" represents the Euro Zone. Country codes must be
    /// uppercase. If `None`, retrieves data for all countries.
    pub country_code: Option<CountryCode>,

    /// Optional filter by economic category.
    ///
    /// If `None`, retrieves events across all categories.
    pub category: Option<EconomicCategory>,

    /// Optional filter by economic importance.
    ///
    /// If `None`, retrieves any importance.
    pub importance: Option<EconomicEventImpact>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Traits
// ================================================================================================

impl WithBatchIndicators for OhlcvSpotQuery {
    type BatchIndicator = BatchOhlcvIndicator;

    fn with_indicator(mut self, kind: Self::BatchIndicator) -> Self {
        self.indicators.push(kind);
        self
    }
}

impl WithBatchIndicators for OhlcvFutureQuery {
    type BatchIndicator = BatchOhlcvIndicator;

    fn with_indicator(mut self, kind: Self::BatchIndicator) -> Self {
        self.indicators.push(kind);
        self
    }
}

impl WithBatchIndicators for TradesSpotQuery {
    type BatchIndicator = BatchTradesIndicator;

    fn with_indicator(mut self, kind: Self::BatchIndicator) -> Self {
        self.indicators.push(kind);
        self
    }
}

/// Maps a configuration type to its corresponding stream identifier.
///
/// This trait enables type-safe conversion from user-facing configuration
/// (which includes wire protocol details like `batch_size`) to internal
/// domain identifiers used for stream management.
pub trait QueryId {
    /// The unique identifier type for this configuration's data stream.
    type Id: Copy + PartialEq + Eq + Hash + PartialOrd + Ord + Debug + Send + Sync;

    /// Converts this configuration into its corresponding stream identifier.
    ///
    /// This method extracts only the fields that uniquely identify a data
    /// stream, omitting operational parameters like `batch_size` or
    /// indicators.
    ///
    /// # Errors
    ///
    /// Returns an error if the configuration contains invalid broker/exchange
    /// combinations or if required conversions fail.
    fn to_id(&self) -> ChapatyResult<Self::Id>;
}
impl QueryId for OhlcvSpotQuery {
    type Id = OhlcvId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(OhlcvId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            period: self.period,
        })
    }
}

impl QueryId for OhlcvFutureQuery {
    type Id = OhlcvId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(OhlcvId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            period: self.period,
        })
    }
}

impl QueryId for TradesSpotQuery {
    type Id = TradesId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TradesId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
        })
    }
}

impl QueryId for TpoSpotQuery {
    type Id = TpoId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TpoId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl QueryId for TpoFutureQuery {
    type Id = TpoId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TpoId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl QueryId for VolumeProfileSpotQuery {
    type Id = VolumeProfileId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(VolumeProfileId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl QueryId for EconomicCalendarQuery {
    type Id = EconomicCalendarId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        Ok(EconomicCalendarId {
            broker: self.broker,
            data_source: self.data_source,
            country_code: self.country_code,
            category: self.category,
            importance: self.importance,
        })
    }
}