kraky 0.1.2

Lightweight, production-ready Rust SDK for Kraken Exchange WebSocket API v2 with unique orderbook imbalance detection and WebSocket trading
Documentation
//! OHLC (candlestick) data types

use serde::{Deserialize, Serialize};

/// OHLC time interval
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub enum Interval {
    /// 1 minute
    #[serde(rename = "1")]
    Min1 = 1,
    /// 5 minutes
    #[serde(rename = "5")]
    Min5 = 5,
    /// 15 minutes
    #[serde(rename = "15")]
    Min15 = 15,
    /// 30 minutes
    #[serde(rename = "30")]
    Min30 = 30,
    /// 1 hour
    #[serde(rename = "60")]
    Hour1 = 60,
    /// 4 hours
    #[serde(rename = "240")]
    Hour4 = 240,
    /// 1 day
    #[serde(rename = "1440")]
    Day1 = 1440,
    /// 1 week
    #[serde(rename = "10080")]
    Week1 = 10080,
    /// 15 days
    #[serde(rename = "21600")]
    Day15 = 21600,
}

impl Interval {
    /// Get the interval value in minutes
    pub fn minutes(&self) -> u32 {
        *self as u32
    }

    /// Convert to Kraken API string representation
    pub fn to_api_string(&self) -> String {
        self.minutes().to_string()
    }
}

impl std::fmt::Display for Interval {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Interval::Min1 => write!(f, "1m"),
            Interval::Min5 => write!(f, "5m"),
            Interval::Min15 => write!(f, "15m"),
            Interval::Min30 => write!(f, "30m"),
            Interval::Hour1 => write!(f, "1h"),
            Interval::Hour4 => write!(f, "4h"),
            Interval::Day1 => write!(f, "1d"),
            Interval::Week1 => write!(f, "1w"),
            Interval::Day15 => write!(f, "15d"),
        }
    }
}

/// OHLC candlestick data
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OHLC {
    /// Trading pair symbol
    pub symbol: String,
    /// Open price
    pub open: f64,
    /// High price
    pub high: f64,
    /// Low price
    pub low: f64,
    /// Close price
    pub close: f64,
    /// Volume weighted average price
    pub vwap: f64,
    /// Volume
    pub volume: f64,
    /// Number of trades
    pub count: i64,
    /// Interval in minutes
    pub interval: u32,
    /// Candle start timestamp
    pub timestamp: String,
    /// Interval begin timestamp
    pub interval_begin: String,
}

/// Deserialize a value that could be either a number or a string representation of a number
fn deserialize_number<'de, D>(deserializer: D) -> Result<f64, D::Error>
where
    D: serde::Deserializer<'de>,
{
    use serde::de::{self, Visitor};

    struct NumberVisitor;

    impl<'de> Visitor<'de> for NumberVisitor {
        type Value = f64;

        fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
            formatter.write_str("a number or string representation of a number")
        }

        fn visit_f64<E>(self, value: f64) -> Result<f64, E> {
            Ok(value)
        }

        fn visit_i64<E>(self, value: i64) -> Result<f64, E> {
            Ok(value as f64)
        }

        fn visit_u64<E>(self, value: u64) -> Result<f64, E> {
            Ok(value as f64)
        }

        fn visit_str<E>(self, value: &str) -> Result<f64, E>
        where
            E: de::Error,
        {
            value.parse::<f64>().map_err(de::Error::custom)
        }
    }

    deserializer.deserialize_any(NumberVisitor)
}

/// Raw OHLC data from Kraken API
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OHLCDataRaw {
    /// Trading pair symbol
    pub symbol: String,
    /// Open price (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub open: f64,
    /// High price (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub high: f64,
    /// Low price (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub low: f64,
    /// Close price (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub close: f64,
    /// Volume weighted average price (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub vwap: f64,
    /// Volume (can be number or string from API)
    #[serde(deserialize_with = "deserialize_number")]
    pub volume: f64,
    /// Number of trades (Kraken sends this as "trades")
    #[serde(rename = "trades")]
    pub count: i64,
    /// Interval in minutes
    pub interval: u32,
    /// Timestamp
    pub timestamp: String,
    /// Interval begin timestamp
    #[serde(default)]
    pub interval_begin: String,
}

impl OHLCDataRaw {
    /// Convert to typed OHLC
    pub fn to_ohlc(&self) -> OHLC {
        OHLC {
            symbol: self.symbol.clone(),
            open: self.open,
            high: self.high,
            low: self.low,
            close: self.close,
            vwap: self.vwap,
            volume: self.volume,
            count: self.count,
            interval: self.interval,
            timestamp: self.timestamp.clone(),
            interval_begin: self.interval_begin.clone(),
        }
    }
}

/// OHLC update message from Kraken
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OHLCUpdate {
    /// Channel name
    #[serde(default)]
    pub channel: String,
    /// Update type
    #[serde(rename = "type")]
    pub update_type: String,
    /// OHLC data
    pub data: Vec<OHLCDataRaw>,
}