mrls 0.1.8

Unofficial Rust client for the Moralis Web3 API - tokens, NFTs, wallets, DeFi, and market data
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

//! Volume API client

use super::types::{CategoryVolume, ChainVolume, VolumeTimeseries};
use crate::client::Client;
use crate::error::Result;
use serde::Serialize;

/// Query parameters for volume endpoints
#[derive(Debug, Default, Serialize)]
pub struct VolumeQuery {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub chain: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timeframe: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub to_date: Option<String>,
}

impl VolumeQuery {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn chain(mut self, chain: impl Into<String>) -> Self {
        self.chain = Some(chain.into());
        self
    }

    #[must_use]
    pub fn timeframe(mut self, timeframe: impl Into<String>) -> Self {
        self.timeframe = Some(timeframe.into());
        self
    }

    #[must_use]
    pub fn from_date(mut self, date: impl Into<String>) -> Self {
        self.from_date = Some(date.into());
        self
    }

    #[must_use]
    pub fn to_date(mut self, date: impl Into<String>) -> Self {
        self.to_date = Some(date.into());
        self
    }
}

/// API for volume analytics
pub struct VolumeApi<'a> {
    client: &'a Client,
}

impl<'a> VolumeApi<'a> {
    #[must_use]
    pub fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Get volume by chain
    pub async fn get_chains_volume(&self) -> Result<Vec<ChainVolume>> {
        self.client.get("/volume/chains").await
    }

    /// Get volume by category
    pub async fn get_categories_volume(&self) -> Result<Vec<CategoryVolume>> {
        self.client.get("/volume/categories").await
    }

    /// Get overall volume timeseries
    pub async fn get_timeseries(&self, query: Option<&VolumeQuery>) -> Result<VolumeTimeseries> {
        if let Some(q) = query {
            self.client.get_with_query("/volume/timeseries", q).await
        } else {
            self.client.get("/volume/timeseries").await
        }
    }

    /// Get volume timeseries for a category
    pub async fn get_category_timeseries(
        &self,
        category_id: &str,
        query: Option<&VolumeQuery>,
    ) -> Result<VolumeTimeseries> {
        let path = format!("/volume/timeseries/{category_id}");
        if let Some(q) = query {
            self.client.get_with_query(&path, q).await
        } else {
            self.client.get(&path).await
        }
    }
}