okx 0.2.2

OKX交易所API SDK
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
126
127

use std::borrow::Cow;
use std::collections::HashMap;

/// WebSocket通道类型
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ChannelType {
    /// 产品行情频道
    Tickers,
    /// 产品K线频道
    Candle(String),
    /// 产品深度频道
    Books,
    /// 产品成交频道
    Trades,
    /// 账户频道
    Account,
    /// 持仓频道
    Positions,
    /// 订单频道
    Orders,
    /// 算法订单频道
    AlgoOrders,
    /// 高级算法订单频道
    AdvancedAlgoOrders,
    /// 用户交易频道
    OrdersAlgo,
    /// 资金频道
    Balance,
    /// 持仓风险频道
    PositionRisk,
    /// 账户余额和持仓频道
    BalanceAndPosition,
    /// 希腊字母频道
    Greeks,
    /// 存款账户信息频道
    DepositInfo,
    /// 系统状态频道
    Status,
    /// 平台公共资金费率频道
    FundingRate,
    /// 指数K线频道
    IndexCandle(String),
    /// 指数行情频道
    IndexTickers,
    /// 标记价格K线频道
    MarkPriceCandle(String),
    /// 标记价格频道
    MarkPrice,
    /// 限价频道
    PriceLimit,
    /// 估算交割/行权价格频道
    EstimatedPrice,
    /// 平台公共5档深度频道
    BooksLite,
    /// 平台公共200档深度频道
    Books50L,
    /// 大宗交易行情频道
    BlockTickers,
    /// 自定义频道
    Custom(String),
}

/// 通道参数
#[derive(Debug, Clone, Default)]
pub struct Args {
    /// 产品ID
    pub inst_id: Option<String>,
    /// 通道参数
    pub params: HashMap<String, String>,
}

impl Args {
    /// 创建新的参数
    pub fn new() -> Self {
        Self {
            inst_id: None,
            params: HashMap::new(),
        }
    }

    /// 设置产品ID
    pub fn with_inst_id(mut self, inst_id: impl Into<String>) -> Self {
        self.inst_id = Some(inst_id.into());
        self
    }

    /// 添加参数
    pub fn with_param(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.params.insert(key.into(), value.into());
        self
    }
}

impl ChannelType {
    /// 获取通道名称
    pub fn as_str(&self) -> Cow<'_, str> {
        match self {
            Self::Tickers => Cow::Borrowed("tickers"),
            Self::Candle(interval) => Cow::Owned(format!("candle{}", interval)),
            Self::Books => Cow::Borrowed("books"),
            Self::Books50L => Cow::Borrowed("books-l2-tbt"),
            Self::BooksLite => Cow::Borrowed("books5"),
            Self::Trades => Cow::Borrowed("trades"),
            Self::Account => Cow::Borrowed("account"),
            Self::Positions => Cow::Borrowed("positions"),
            Self::Orders => Cow::Borrowed("orders"),
            Self::AlgoOrders => Cow::Borrowed("orders-algo"),
            Self::AdvancedAlgoOrders => Cow::Borrowed("algo-advance"),
            Self::OrdersAlgo => Cow::Borrowed("trades"),
            Self::Balance => Cow::Borrowed("balance_and_position"),
            Self::PositionRisk => Cow::Borrowed("positions-risk"),
            Self::BalanceAndPosition => Cow::Borrowed("balance_and_position"),
            Self::Greeks => Cow::Borrowed("greeks"),
            Self::DepositInfo => Cow::Borrowed("deposit-info"),
            Self::Status => Cow::Borrowed("status"),
            Self::FundingRate => Cow::Borrowed("funding-rate"),
            Self::IndexCandle(interval) => Cow::Borrowed(interval),
            Self::IndexTickers => Cow::Borrowed("index-tickers"),
            Self::MarkPriceCandle(interval) => Cow::Borrowed(interval),
            Self::MarkPrice => Cow::Borrowed("mark-price"),
            Self::PriceLimit => Cow::Borrowed("price-limit"),
            Self::EstimatedPrice => Cow::Borrowed("estimated-price"),
            Self::BlockTickers => Cow::Borrowed("block-tickers"),
            Self::Custom(name) => Cow::Borrowed(name),
        }
    }
}