okx 0.2.1

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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// WebSocket消息操作类型
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum WebSocketOperation {
    /// 订阅频道
    Subscribe,
    /// 取消订阅
    Unsubscribe,
    /// 登录
    Login,
}

/// WebSocket认证信息
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketAuth {
    /// API密钥
    #[serde(rename = "apiKey")]
    pub api_key: String,
    /// 签名
    pub sign: String,
    /// 时间戳
    pub timestamp: String,
    /// 密码
    pub passphrase: String,
}

/// WebSocket通道
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketChannel {
    /// 通道名称
    pub channel: String,
    /// 产品ID
    #[serde(rename = "instId", skip_serializing_if = "Option::is_none")]
    pub instrument_id: Option<String>,
    /// 额外参数
    #[serde(flatten, skip_serializing_if = "HashMap::is_empty")]
    pub args: HashMap<String, String>,
}

/// WebSocket订阅请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketSubscription {
    /// 通道名称
    pub channel: String,
    /// 产品ID
    #[serde(rename = "instId", skip_serializing_if = "Option::is_none")]
    pub instrument_id: Option<String>,
    /// 额外参数
    #[serde(flatten, skip_serializing_if = "HashMap::is_empty")]
    pub args: HashMap<String, String>,
}

/// WebSocket请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketRequest {
    /// 操作类型
    pub op: WebSocketOperation,
    /// 参数
    pub args: Vec<WebSocketSubscription>,
}

/// WebSocket登录请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketLoginRequest {
    /// 操作类型 (login)
    pub op: String,
    /// 认证参数
    pub args: Vec<WebSocketAuth>,
}

/// WebSocket响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebSocketResponse<T> {
    /// 事件
    pub event: Option<String>,
    /// 操作成功或失败
    #[serde(skip_serializing_if = "Option::is_none")]
    pub code: Option<String>,
    /// 错误消息
    #[serde(skip_serializing_if = "Option::is_none")]
    pub msg: Option<String>,
    /// 通道名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub channel: Option<String>,
    /// 产品ID
    #[serde(rename = "instId", skip_serializing_if = "Option::is_none")]
    pub instrument_id: Option<String>,
    /// 数据
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<T>,
}

/// WebSocket消息
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum WebSocketMessage<T> {
    /// 响应
    Response(WebSocketResponse<T>),
    /// 原始数据
    Data {
        /// 通道名称
        channel: String,
        /// 产品ID
        #[serde(rename = "instId")]
        instrument_id: String,
        /// 数据
        data: T,
    },
}