ccxt-rust 0.1.3

Cryptocurrency exchange trading library in Rust
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

# <center> CCXT-Rust </center>
___

[![Rust](https://img.shields.io/badge/rust-1.91%2B-orange.svg)](https://www.rust-lang.org/)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Rust CI](https://github.com/Praying/ccxt-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/Praying/ccxt-rust/actions/workflows/rust.yml)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/ccxt-rust)

A professional-grade, type-safe Rust implementation of the CCXT library for cryptocurrency trading, providing unified
access to major exchanges.

[English](README.md) | [įŽ€äŊ“中文](README_CN.md)

## đŸŽ¯ Supported Exchanges

| Exchange        | Market Data | Trading | WebSocket |
|-----------------|-------------|---------|-----------|
| **Binance**     | ✅           | ✅       | ✅         |
| **Bitget**      | ✅           | ✅       | ✅         |
| **Hyperliquid** | ✅           | ✅       | ✅         |
| **OKX**         | ✅           | ✅       | ✅         |
| **Bybit**       | ✅           | ✅       | ✅         |

> **Legend**: ✅ Supported, 🚧 In Progress

## 🌟 Key Features

- **🛡ī¸ Type-Safe & Async**: Built on `Tokio` and `rust_decimal` for safe, high-performance financial operations.
- **🔄 Unified Interface**: Consistent `Exchange` trait across all supported exchanges.
- **⚡ Real-Time**: Robust WebSocket support with automatic reconnection.
- **đŸ“Ļ Comprehensive Capability**:
  - **Market Data**: Tickers, Order Books, OHLCV, Trades.
  - **Trading**: Spot, Margin, Futures, Batched Orders, OCO.
  - **Account**: Balances, Transactions, Leverage management.

## 🚀 Quick Start

### Installation

```bash
cargo add ccxt-rust
```

### Basic Usage

```rust
use ccxt_exchanges::binance::Binance;
use ccxt_core::exchange::Exchange;
use rust_decimal_macros::dec;
use ccxt_core::types::{OrderType, OrderSide};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  // 1. Initialize (using env vars recommended)
    let exchange = Binance::builder()
            .api_key(std::env::var("BINANCE_API_KEY").ok())
            .secret(std::env::var("BINANCE_SECRET").ok())
        .build()?;

  // 2. Fetch Market Data
    let ticker = exchange.fetch_ticker("BTC/USDT").await?;
    println!("BTC/USDT Price: {:?}", ticker.last);

  // 3. Place Order (if credentials provided)
  if exchange.has_private_api() {
    let order = exchange.create_order(
      "BTC/USDT",
      OrderType::Limit,
      OrderSide::Buy,
      dec!(0.001),
      Some(dec!(50000)),
    ).await?;
    println!("Order placed: {}", order.id);
    }

    Ok(())
}
```

For WebSocket examples and advanced usage (polymorphism), see the [`examples/`](examples/) directory.

## 🏗ī¸ Architecture

The project is structured as a workspace:

- **`ccxt-core`**: Defines the unified `Exchange` and `WsExchange` traits, standard types, and error handling logic.
- **`ccxt-exchanges`**: Contains specific implementations (Binance, OKX, etc.).

## 🚩 Feature Flags

| Flag         | Description              | Default |
|--------------|--------------------------|---------|
| `rest`       | REST API support         | ✅       |
| `websocket`  | WebSocket support        | ✅       |
| `rustls-tls` | Use RustLS (recommended) | ✅       |
| `native-tls` | Use OpenSSL/Native TLS   | ❌       |

## 🛠ī¸ Development

```bash
# Run tests
cargo test

# Check code quality
cargo clippy --all-targets -- -D warnings

# Build documentation
cargo doc --open
```

## 📝 License & Support

MIT License. See [LICENSE](LICENSE).

- **Issues**: [GitHub Issues](https://github.com/Praying/ccxt-rust/issues)
- **Docs**: [docs.rs](https://docs.rs/ccxt-rust)

## ⚠ī¸ Disclaimer

This project is for educational and research purposes only. The authors and contributors are not responsible for any
financial losses or damages arising from the use of this software. Cryptocurrency trading involves high risk; please
trade responsibly.

---
**Status**: 🚧 Active Development (v0.1.3) | **Donations (BSC)**: `0x8e5d858f92938b028065d39450421d0e080d15f7`