oxarchive 1.4.0

Rust client library for the 0xArchive API — historical and real-time crypto market data across Hyperliquid, Lighter.xyz, and HIP-3
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

use crate::error::Result;
use crate::http::HttpClient;
use crate::types::{CursorResponse, OiFundingInterval, OpenInterest, Timestamp};

/// Parameters for paginated open interest history.
#[derive(Debug)]
pub struct OpenInterestHistoryParams {
    pub start: Timestamp,
    pub end: Timestamp,
    pub cursor: Option<String>,
    pub limit: Option<i64>,
    pub interval: Option<OiFundingInterval>,
}

/// Access to open interest endpoints for a specific exchange.
#[derive(Debug, Clone)]
pub struct OpenInterestResource {
    http: HttpClient,
    prefix: String,
}

impl OpenInterestResource {
    pub(crate) fn new(http: HttpClient, prefix: &str) -> Self {
        Self {
            http,
            prefix: prefix.to_string(),
        }
    }

    /// Get paginated historical open interest snapshots.
    pub async fn history(
        &self,
        symbol: &str,
        params: OpenInterestHistoryParams,
    ) -> Result<CursorResponse<Vec<OpenInterest>>> {
        let mut qp = vec![
            ("start", params.start.to_millis().to_string()),
            ("end", params.end.to_millis().to_string()),
        ];
        if let Some(c) = &params.cursor {
            qp.push(("cursor", c.clone()));
        }
        if let Some(l) = params.limit {
            qp.push(("limit", l.to_string()));
        }
        if let Some(i) = params.interval {
            qp.push(("interval", i.as_str().to_string()));
        }
        let (data, next_cursor) = self
            .http
            .get_with_cursor(&format!("{}/openinterest/{}", self.prefix, symbol), &qp)
            .await?;
        Ok(CursorResponse { data, next_cursor })
    }

    /// Get the current open interest.
    pub async fn current(&self, symbol: &str) -> Result<OpenInterest> {
        self.http
            .get(
                &format!("{}/openinterest/{}/current", self.prefix, symbol),
                &[],
            )
            .await
    }
}