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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

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

// line 12: compile-only (no_run)
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_12() {
    use finance_query::{Interval, Providers, TimeRange};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder().build().await?;
        let gold = providers.commodity("GC=F");
        let quote = gold.quote().await?;
        let chart = gold.chart(Interval::OneDay, TimeRange::OneMonth).await?;
        let history = gold.history(TimeRange::OneMonth).await?;
        println!("{}: {:?} ({} candles)", quote.symbol, quote.price, chart.candles.len() + history.candles.len());
        Ok(())
    }
}

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

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder()
            .route(Capability::COMMODITIES, [Provider::Fmp, Provider::Yahoo])
            .build()
            .await?;
        let gold = providers.commodity("GCUSD");
        let quote = gold.quote().await?;
        println!("Symbol: {}", quote.symbol);
        if let Some(price) = quote.price {
            println!("Price: {:.2}", price);
        }
        Ok(())
    }
}

// line 71: compile-only (no_run)
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_71() {
    use finance_query::Providers;

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder().build().await?;
        let gold = providers.commodity("GC=F");
        let quote = gold.quote().await?;

        println!("Symbol: {}", quote.symbol);
        if let Some(name) = &quote.name {
            println!("Name: {}", name);
        }
        if let Some(price) = quote.price {
            println!("Price: {:.2}", price);
        }
        if let (Some(change), Some(pct)) = (quote.change, quote.change_percent) {
            println!("Change: {:+.2} ({:+.2}%)", change, pct);
        }
        Ok(())
    }
}

// line 98: compile-only (no_run)
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_98() {
    use finance_query::{Interval, Providers, TimeRange};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder().build().await?;
        let crude = providers.commodity("CL=F");
        let chart = crude.chart(Interval::OneDay, TimeRange::ThreeMonths).await?;

        println!("Symbol: {}", chart.symbol);
        println!("Candles: {}", chart.candles.len());
        for candle in chart.candles.iter().take(3) {
            println!("  t={} o={:.2} h={:.2} l={:.2} c={:.2}",
                candle.timestamp, candle.open, candle.high, candle.low, candle.close);
        }
        Ok(())
    }
}

// line 122: compile-only (no_run)
#[rustfmt::skip]
#[allow(dead_code)]
fn doc_block_line_122() {
    use finance_query::{Providers, TimeRange};

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder().build().await?;
        let silver = providers.commodity("SI=F");
        let history = silver.history(TimeRange::SixMonths).await?;

        println!("Symbol: {}", history.symbol);
        println!("Candles: {}", history.candles.len());
        Ok(())
    }
}

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

    #[tokio::main]
    async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let providers = Providers::builder().build().await?;
        let gold = providers.commodity("GC=F");

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

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

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