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

use crate::error::Result;
use crate::http::HttpClient;
use crate::types::{Hip3Instrument, Instrument, LighterInstrument};

/// Hyperliquid instruments resource.
#[derive(Debug, Clone)]
pub struct InstrumentsResource {
    http: HttpClient,
    prefix: String,
}

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

    /// List all instruments on this exchange.
    pub async fn list(&self) -> Result<Vec<Instrument>> {
        self.http
            .get(&format!("{}/instruments", self.prefix), &[])
            .await
    }

    /// Get a single instrument by coin symbol.
    pub async fn get(&self, coin: &str) -> Result<Instrument> {
        self.http
            .get(&format!("{}/instruments/{}", self.prefix, coin), &[])
            .await
    }
}

/// Lighter.xyz instruments resource (extended metadata).
#[derive(Debug, Clone)]
pub struct LighterInstrumentsResource {
    http: HttpClient,
    prefix: String,
}

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

    /// List all Lighter instruments.
    pub async fn list(&self) -> Result<Vec<LighterInstrument>> {
        self.http
            .get(&format!("{}/instruments", self.prefix), &[])
            .await
    }

    /// Get a single Lighter instrument by symbol.
    pub async fn get(&self, coin: &str) -> Result<LighterInstrument> {
        self.http
            .get(&format!("{}/instruments/{}", self.prefix, coin), &[])
            .await
    }
}

/// HIP-3 instruments resource (case-sensitive symbols like `km:US500`).
#[derive(Debug, Clone)]
pub struct Hip3InstrumentsResource {
    http: HttpClient,
    prefix: String,
}

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

    /// List all HIP-3 instruments.
    pub async fn list(&self) -> Result<Vec<Hip3Instrument>> {
        self.http
            .get(&format!("{}/instruments", self.prefix), &[])
            .await
    }

    /// Get a single HIP-3 instrument by coin (case-sensitive).
    pub async fn get(&self, coin: &str) -> Result<Hip3Instrument> {
        self.http
            .get(&format!("{}/instruments/{}", self.prefix, coin), &[])
            .await
    }
}