rust-okx 0.5.0

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
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

//! Login, subscription, notice, and connection-count responses.

use serde::Deserialize;

use crate::model::NumberString;
use crate::ws::Arg;

use super::ResponseExtraFields;

/// Subscribe/unsubscribe acknowledgement body.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#overview-websocket-subscribe>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ChannelAcknowledgement {
    /// `subscribe`, `unsubscribe`, or `error`.
    #[serde(default)]
    pub event: String,
    /// Client message ID when one was included in the request.
    #[serde(default)]
    pub id: String,
    /// Acknowledged channel argument.
    #[serde(default)]
    pub arg: Option<Arg>,
    /// OKX response/error code when supplied.
    #[serde(default)]
    pub code: String,
    /// OKX response/error message when supplied.
    #[serde(default)]
    pub msg: String,
    /// WebSocket connection ID.
    #[serde(default)]
    pub conn_id: String,
    /// Fields introduced by OKX after this crate version.
    #[serde(flatten, default)]
    pub extra: ResponseExtraFields,
}

/// Login acknowledgement or login error body.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#overview-websocket-login>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct LoginAcknowledgement {
    /// `login` on success or `error` on failure.
    #[serde(default)]
    pub event: String,
    /// OKX response/error code.
    #[serde(default)]
    pub code: String,
    /// OKX response/error message.
    #[serde(default)]
    pub msg: String,
    /// WebSocket connection ID.
    #[serde(default)]
    pub conn_id: String,
    /// Fields introduced by OKX after this crate version.
    #[serde(flatten, default)]
    pub extra: ResponseExtraFields,
}

/// Service notice body.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#overview-websocket-notice>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct NoticeResponse {
    /// Always `notice`.
    #[serde(default)]
    pub event: String,
    /// OKX notice code.
    #[serde(default)]
    pub code: String,
    /// Notice message.
    #[serde(default)]
    pub msg: String,
    /// WebSocket connection ID when supplied.
    #[serde(default)]
    pub conn_id: String,
    /// Fields introduced by OKX after this crate version.
    #[serde(flatten, default)]
    pub extra: ResponseExtraFields,
}

/// Channel connection-count event body.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#overview-websocket-connection-count-limit>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ChannelConnectionCountResponse {
    /// `channel-conn-count` or `channel-conn-count-error`.
    #[serde(default)]
    pub event: String,
    /// Channel name.
    #[serde(default)]
    pub channel: String,
    /// Current connection count.
    #[serde(default)]
    pub conn_count: NumberString,
    /// WebSocket connection ID.
    #[serde(default)]
    pub conn_id: String,
    /// Fields introduced by OKX after this crate version.
    #[serde(flatten, default)]
    pub extra: ResponseExtraFields,
}