rust-okx 0.5.2

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
63

//! `market` WebSocket channel helpers.

use crate::ws::Arg;

/// Subscribe to `tickers` for one instrument.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel>
pub fn tickers(inst_id: impl Into<String>) -> Arg {
    Arg::new("tickers").inst_id(inst_id)
}

/// Subscribe to a `candle*` channel such as `candle1m`.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-candlesticks-channel>
pub fn candlesticks(channel: impl Into<String>, inst_id: impl Into<String>) -> Arg {
    Arg::new(channel).inst_id(inst_id)
}

/// Subscribe to aggregated `trades`.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-trades-channel>
pub fn trades(inst_id: impl Into<String>) -> Arg {
    Arg::new("trades").inst_id(inst_id)
}

/// Subscribe to `trades-all`.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-all-trades-channel>
pub fn all_trades(inst_id: impl Into<String>) -> Arg {
    Arg::new("trades-all").inst_id(inst_id)
}

/// Subscribe to an order-book channel such as `books`, `books5`, `bbo-tbt`, `books50-l2-tbt`, `books-l2-tbt`
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel>
pub fn order_book(channel: impl Into<String>, inst_id: impl Into<String>) -> Arg {
    Arg::new(channel).inst_id(inst_id)
}

/// Subscribe to `option-trades` for one instrument family.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-option-trades-channel>
pub fn option_trades(
    inst_type: impl Into<String>,
    inst_id: Option<impl Into<String>>,
    inst_family: Option<impl Into<String>>,
) -> Arg {
    let mut arg = Arg::new("option-trades").inst_type(inst_type);
    if let Some(inst_id) = inst_id {
        arg = arg.inst_id(inst_id);
    }
    if let Some(inst_family) = inst_family {
        arg = arg.inst_family(inst_family)
    }
    arg
}

/// Subscribe to `call-auction-details` for one instrument.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-call-auction-details-channel>
pub fn call_auction_details(inst_id: impl Into<String>) -> Arg {
    Arg::new("call-auction-details").inst_id(inst_id)
}