bts-rs 1.0.11

Backtest your trading strategy.
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

<p align="center">
  <img src="logo.png" alt="BTS-RS Logo" width="200"/>
</p>

# BTS: BackTest Strategy

[![Crates.io](https://img.shields.io/crates/v/bts-rs.svg)](https://crates.io/crates/bts-rs)
[![Documentation](https://img.shields.io/docsrs/bts-rs)](https://docs.rs/bts-rs)
[![CI Status](https://github.com/raonagos/bts-rs/actions/workflows/rust.yml/badge.svg?style=flat-square)](https://github.com/raonagos/bts-rs/actions)
[![License](https://img.shields.io/crates/l/bts-rs?style=flat-square)](https://opensource.org/licenses/MIT)
[![Downloads](https://img.shields.io/crates/d/bts-rs?style=flat-square&logo=rust)](https://crates.io/crates/bts-rs)

**BTS** is a Rust library designed for backtesting trading strategies on candlestick data.
It enables testing technical indicators, custom strategies, and simulating trading performance
on historical or generated data.

## **🔑 Key Features**

- **📊 Technical Indicators**: Uses with popular indicators (Impulse MACD, Parabolic SAR, VWAP, etc.) and allows easy addition of new ones.
- **📈 Backtesting**: Simulates trading strategies on historical or generated data.
- **🏗️ Market Engine**: Processes candles one by one to test strategies under realistic conditions.
- **📉 Performance Metrics**: Calculates P&L (Profit & Loss), drawdown, Sharpe ratio, and more.
- **🔧 Flexibility**: Compatible with indicators crates for seamless integration.
- **📝 Order & Position Management**: Supports market orders, limit orders, take-profit,
  stop-loss, and trailing stops.

## **🚀 Usage Example**
```rust
use std::sync::Arc;

use bts_rs::prelude::*;
use chrono::{DateTime, Duration};

// Candlestick data
let data = vec![
    CandleBuilder::builder().open(100.0).high(110.0).low(95.0).close(105.0).open_time(DateTime::default()).close_time(DateTime::default() + Duration::days(1)).volume(1000.0).build().unwrap(),
    CandleBuilder::builder().open(105.0).high(115.0).low(100.0).close(110.0).open_time(DateTime::default()).close_time(DateTime::default() + Duration::days(1)).volume(1000.0).build().unwrap(),
];

let candles = Arc::from_iter(data);

// Initialize backtest
let mut bts = Backtest::new(candles, 1000.0, None).unwrap();

// Custom strategy
bts.run(|bt, candle| {
    // Example: Buy if closing price > opening price
    if candle.close() > candle.open() {
        let order = Order::from((OrderType::Market(candle.close()), 1.0, OrderSide::Buy));
        bt.place_order(candle, order)?;
    }
    Ok(())
}).unwrap();

// Results
println!("Final balance: {}", bts.balance());
println!("Number of positions: {}", bts.positions().count());
println!("Number of events: {}", bts.events().count());
```

See more examples in [examples](examples) folder.

## **📊 Performance Metrics**

The backtesting engine automatically calculates the following metrics:
| Metrics                 | Description                            |
|-------------------------|----------------------------------------|
| **Drawdown**            | Maximum capital decline                |
| **Profit Factor**       | Ratio of gross profits to gross losses |
| **Sharpe Ratio**        | Risk-adjusted return measure           |
| **Win Rate**            | Percentage of winning trades           |

## **🔗 Integration with Other Crates**

BTS is compatible with popular indicators crates for technical analysis, allowing you to easily integrate your trading strategy.

## **⚡ Advanced Features**

- **Custom Strategies**: Implement your own trading logic.
- **Event Tracking**: Detailed logging of all trading events.
- **Risk Management**: Built-in support for stop-loss and take-profit rules.
- **Performance Optimization**: Uses efficient data structures for order/position management.
- **Parameters Optimization**: Computes the best parameters *(indicators, RR, etc...)* for your strategy.
- **Draw chart and metrics**: Draws the candlesticks data, balance, positions and metrics.

## **⚠️ Error Handling**

BTS provides comprehensive error handling for:
- Insufficient funds
- Invalid orders/positions
- Market data errors
- Configuration issues and more.

## **📦 Crate Features**

The crate includes three main optional features to extend its functionality:
- `metrics`: Exposes the Metrics struct, enabling calculations of key performance indicators such as max drawdown, Sharpe ratio, profit factor, and win rate.
- `optimizer`: Provides tools for parameter optimization, allowing you to find the best strategy parameters (e.g., indicator periods, risk-reward ratios) by testing combinations across historical data.
- `draws`: Enables integration with the plotters crate to visualize backtest results, including candlestick charts or performance metrics *(requires the `metrics` feature to be enabled)*.

## **🛠️ Getting Started**

Add BTS to your `Cargo.toml`:
```toml
[dependencies]
bts_rs = "1.0.11"
```

Then import and use it in your project:
```rust
use bts_rs::prelude::*;
```

## **🤝 Contributing**

Contributions are welcome! See [Contributing](CONTRIBUTING.md) file to contribute to this project.

## **📄 License**

This project is licensed under the [MIT License](LICENSE).

*Generated by Mistral.ai*