okx-client 0.1.2

Async Rust client for the OKX exchange API v5
Documentation
use serde::{Deserialize, Serialize};

/// Result from placing a spread order via WS API.
/// Operation: `sprd-order`
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WsSpreadOrderResult {
    /// Spread ID.
    pub sprd_id: String,
    /// Order ID assigned by OKX.
    pub ord_id: String,
    /// Client Order ID.
    pub cl_ord_id: String,
    /// Order tag.
    pub tag: String,
    /// Timestamp when the request was received, Unix ms.
    pub ts: String,
    /// Per-item result code; "0" means success.
    pub s_code: String,
    #[serde(default)]
    pub sub_code: Option<String>,
    /// Per-item result message.
    pub s_msg: String,
}

/// Result from cancelling a spread order via WS API.
/// Operation: `sprd-cancel-order`
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WsSpreadCancelResult {
    /// Spread ID.
    pub sprd_id: String,
    /// Order ID.
    pub ord_id: String,
    /// Client Order ID.
    pub cl_ord_id: String,
    /// Per-item result code; "0" means success.
    pub s_code: String,
    #[serde(default)]
    pub sub_code: Option<String>,
    /// Per-item result message.
    pub s_msg: String,
}

/// Result from amending a spread order via WS API.
/// Operation: `sprd-amend-order`
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WsSpreadAmendResult {
    /// Spread ID.
    pub sprd_id: String,
    /// Order ID.
    pub ord_id: String,
    /// Client Order ID.
    pub cl_ord_id: String,
    /// Client Request ID provided by the client.
    pub req_id: String,
    /// Per-item result code; "0" means success.
    pub s_code: String,
    #[serde(default)]
    pub sub_code: Option<String>,
    /// Per-item result message.
    pub s_msg: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum WsEstimatedPriceSettleType {
    Settlement,
    Delivery,
    Exercise,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WsEstimatedPriceData {
    pub inst_id: String,
    pub inst_type: String,
    pub settle_px: String,
    pub settle_type: WsEstimatedPriceSettleType,
    pub ts: String,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn current_websocket_response_fields_deserialize() {
        let spread: WsSpreadOrderResult = serde_json::from_value(serde_json::json!({
            "sprdId": "BTC-USDT_BTC-USDC",
            "ordId": "1",
            "clOrdId": "client-1",
            "tag": "tag",
            "ts": "1",
            "sCode": "1",
            "subCode": "51008",
            "sMsg": "failed"
        }))
        .unwrap();
        let estimated: WsEstimatedPriceData = serde_json::from_value(serde_json::json!({
            "instId": "BTC-USD-260925",
            "instType": "FUTURES",
            "settlePx": "100000",
            "settleType": "settlement",
            "ts": "1"
        }))
        .unwrap();

        assert_eq!(spread.sub_code.as_deref(), Some("51008"));
        assert_eq!(
            estimated.settle_type,
            WsEstimatedPriceSettleType::Settlement
        );
    }
}