ferr 0.1.11

Crypto CEX connector framework
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

# ferr

> **Work in Progress** -- Currently in early development. Not ready for use.

[![docs.rs](https://img.shields.io/docsrs/ferr)](https://docs.rs/ferr)
[![Crates.io](https://img.shields.io/crates/v/ferr)](https://crates.io/crates/ferr)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE)

A Rust library for market data and order management on crypto CEXs.

## Supported Exchanges

| Exchange | WebSocket | REST |
|----------|-----------|------|
| Bybit    | Implemented | Implemented |
| Binance  | Not yet implemented  | Not yet implemented |
| OKX  | Not yet implemented  | Not yet implemented |
| Bitget  | Not yet implemented  | Not yet implemented |

## Features

### WebSocket Market Data
- Real-time trades, tickers, and orderbook (top of book)
- Funding rates and open interest
- Mark price and index price
- Automatic reconnection with exponential backoff
- Automatic subscription resumption after reconnect
- Broadcast channels for multi-consumer support

### REST API
- **Trading**: Place, modify, and cancel orders
- **Account**: Balance, positions, and trade history
- **Market Data**: Historical klines/OHLCV

### General
- Unified error types across all exchanges
- Rate limit tracking per exchange
- Testnet support
- Perpetual and spot markets (USDT pairs only)

## Example usage

```toml
[dependencies]
ferr = "0.1.11"
tokio = { version = "1.50.0", features = ["full"] }
```

### WebSocket: Stream Ticker Data

```rust
use ferr::{
    exchanges::bybit::ws::client::BybitWsClient,
    traits::ws::WsMarketData,
    types::common::MarketType,
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = BybitWsClient::new();
    let mut rx = client.subscribe_ticker("BTCUSDT", MarketType::Perp).await?;

    while let Ok(ticker) = rx.recv().await {
        println!(
            "{} | last: {} | bid: {} | ask: {}",
            ticker.symbol, ticker.last, ticker.bid, ticker.ask
        );
    }

    Ok(())
}
```