cgko 0.1.3

Unofficial Rust client for the CoinGecko API (cgko)
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

//! Derivatives API endpoints

use super::types::{
    DerivativeExchange, DerivativeExchangeDetail, DerivativeExchangeListItem,
    DerivativeExchangesOptions, DerivativeTicker, DerivativesOptions,
};
use crate::client::Client;
use crate::error::Result;

/// Derivatives API
pub struct DerivativesApi<'a> {
    client: &'a Client,
}

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

    /// List all derivative tickers
    pub async fn list(&self) -> Result<Vec<DerivativeTicker>> {
        self.client.get("/derivatives").await
    }

    /// List derivative tickers with options
    pub async fn list_with_options(
        &self,
        options: &DerivativesOptions,
    ) -> Result<Vec<DerivativeTicker>> {
        let path = format!("/derivatives{}", options.to_query_string());
        self.client.get(&path).await
    }

    /// List derivatives exchanges
    pub async fn exchanges(&self) -> Result<Vec<DerivativeExchange>> {
        self.client.get("/derivatives/exchanges").await
    }

    /// List derivatives exchanges with options
    pub async fn exchanges_with_options(
        &self,
        options: &DerivativeExchangesOptions,
    ) -> Result<Vec<DerivativeExchange>> {
        let path = format!("/derivatives/exchanges{}", options.to_query_string());
        self.client.get(&path).await
    }

    /// Get derivatives exchange by ID
    pub async fn exchange(&self, id: &str) -> Result<DerivativeExchangeDetail> {
        let path = format!("/derivatives/exchanges/{id}");
        self.client.get(&path).await
    }

    /// Get derivatives exchange by ID with tickers
    pub async fn exchange_with_tickers(
        &self,
        id: &str,
        include_tickers: &str,
    ) -> Result<DerivativeExchangeDetail> {
        let path = format!("/derivatives/exchanges/{id}?include_tickers={include_tickers}");
        self.client.get(&path).await
    }

    /// List derivatives exchanges (id and name only)
    pub async fn exchanges_list(&self) -> Result<Vec<DerivativeExchangeListItem>> {
        self.client.get("/derivatives/exchanges/list").await
    }
}