finance-query 3.0.0

A Rust library for querying financial 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

// @generated by `cargo soothfast docs gen-tests`
// source: docs/library/crypto.md
#![allow(unused)]

// line 20: compile-only (no_run)
#[cfg(feature = "crypto")]
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_20() {
    use finance_query::crypto;

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let top = crypto::coins("usd", 10).await?;
        assert!(!top.is_empty(), "should return coins");
        assert!(top.len() <= 10);

        for coin in &top {
            let price = coin.current_price.unwrap_or(0.0);
            let change = coin.price_change_percentage_24h.unwrap_or(0.0);
            let rank = coin.market_cap_rank.unwrap_or(0);
            println!(
                "#{} {} ({}): ${:.2} ({:+.2}%)",
                rank, coin.name, coin.symbol, price, change
            );
        }
        Ok(())
    }
}

// line 49: compile-only (no_run)
#[cfg(feature = "crypto")]
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_49() {
    use finance_query::crypto;

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let btc = crypto::coin("bitcoin", "usd").await?;
        assert_eq!(btc.id, "bitcoin");
        assert_eq!(btc.symbol.to_uppercase(), "BTC");
        let price = btc.current_price.unwrap_or(0.0);
        assert!(price > 0.0, "BTC price should be positive");
        println!("Bitcoin: ${:.2}", price);
        Ok(())
    }
}

// line 139: compile-only (no_run)
#[cfg(feature = "crypto")]
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_139() {
    use finance_query::{Capability, Provider, Providers};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder()
            .route(Capability::CRYPTO, [Provider::CoinGecko])
            .build()
            .await?;
        let btc = providers.crypto("bitcoin");
        let quote = btc.quote("usd").await?;
        println!("BTC: {:?}", quote.price);
        Ok(())
    }
}

// line 161: compile-only (no_run)
#[cfg(feature = "crypto")]
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_161() {
    use finance_query::{Capability, Interval, Provider, Providers, TimeRange};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder()
            .route(Capability::CRYPTO, [Provider::CoinGecko])
            .build()
            .await?;
        // Ticker id ("BTC") so the default Yahoo CHART route resolves "BTC-USD".
        let btc = providers.crypto("BTC");
        let chart = btc.chart("usd", Interval::OneDay, TimeRange::OneMonth).await?;
        let history = btc.history("usd", TimeRange::OneMonth).await?;
        println!("{} candles", chart.candles.len() + history.candles.len());
        Ok(())
    }
}

// line 225: compile-only (no_run)
#[cfg(feature = "risk")]
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_225() {
    use finance_query::indicators::Indicator;
    use finance_query::{Capability, Interval, Provider, Providers, TimeRange};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder()
            .route(Capability::CRYPTO, [Provider::CoinGecko])
            .build()
            .await?;
        let btc = providers.crypto("BTC");

        let summary = btc
            .indicators("usd", Interval::OneDay, TimeRange::ThreeMonths)
            .await?;
        if let Some(rsi) = summary.rsi_14 {
            println!("RSI(14): {:.2}", rsi);
        }

        let rsi_21 = btc
            .indicator(Indicator::Rsi(21), "usd", Interval::OneDay, TimeRange::ThreeMonths)
            .await?;

        let risk = btc.risk("usd", Interval::OneDay, TimeRange::OneYear).await?;
        println!("VaR 95%:      {:.2}%", risk.var_95 * 100.0);
        println!("Max Drawdown: {:.2}%", risk.max_drawdown * 100.0);
        Ok(())
    }
}