rust-okx 0.5.1

Async Rust client for the OKX v5 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

//! `account` WebSocket channel helpers.

use crate::ws::Arg;

/// Subscribe to `account` filtered by currency.
///
/// `update_interval` controls push frequency via OKX's `extraParams` field:
/// - `None`: OKX default (events + ~5-second periodic push)
/// - `Some("0")`: event-driven only
/// - `Some("2000")` / `Some("3000")` / `Some("4000")`: events + periodic at that interval (ms)
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#trading-account-websocket-account-channel>
pub fn account_by_currency(ccy: impl Into<String>, update_interval: Option<&str>) -> Arg {
    let mut arg = Arg::new("account").ccy(ccy);
    if let Some(interval) = update_interval {
        arg = arg.param(
            "extraParams",
            format!(r#"{{"updateInterval":"{interval}"}}"#),
        );
    }
    arg
}

/// Subscribe to `positions` for one instrument type.
///
/// `update_interval` controls push frequency via OKX's `extraParams` field:
/// - `None`: OKX default (events + ~5-second periodic push)
/// - `Some("0")`: event-driven only
/// - `Some("2000")` / `Some("3000")` / `Some("4000")`: events + periodic at that interval (ms)
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#trading-account-websocket-positions-channel>
pub fn positions(inst_type: impl Into<String>, update_interval: Option<&str>) -> Arg {
    let mut arg = Arg::new("positions").inst_type(inst_type);
    if let Some(interval) = update_interval {
        arg = arg.param(
            "extraParams",
            format!(r#"{{"updateInterval":"{interval}"}}"#),
        );
    }
    arg
}

/// Subscribe to `balance_and_position`.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#trading-account-websocket-balance-and-position-channel>
pub fn balance_and_position() -> Arg {
    Arg::new("balance_and_position")
}

/// Subscribe to `liquidation-warning` for one instrument type.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#trading-account-websocket-liquidation-warning-channel>
pub fn liquidation_warning(inst_type: impl Into<String>) -> Arg {
    Arg::new("liquidation-warning").inst_type(inst_type)
}

/// Subscribe to `account-greeks` for one currency.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#trading-account-websocket-account-greeks-channel>
pub fn account_greeks(ccy: impl Into<String>) -> Arg {
    Arg::new("account-greeks").ccy(ccy)
}