finance-query 3.1.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

// @generated by `cargo soothfast docs gen-tests`
// source: docs/library/dataframe.md line 141
#[cfg(feature = "dataframe")]
mod soothfast_capture_body {
    use finance_query::{CapitalGain, Dividend, Split, Ticker, TimeRange};

    #[tokio::main]
    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        let ticker = Ticker::new("AAPL").await?;

        // Dividends
        let dividends = ticker.dividends(TimeRange::OneYear).await?;
        let div_df = Dividend::vec_to_dataframe(&dividends)?;
        // Columns: timestamp, amount
        println!("dividends: {:?}", div_df.shape());

        // Splits
        let splits = ticker.splits(TimeRange::Max).await?;
        let split_df = Split::vec_to_dataframe(&splits)?;
        // Columns: timestamp, ratio
        println!("splits: {:?}", split_df.shape());

        // Capital gains (AAPL is a stock, not a fund, so this is typically empty)
        let gains = ticker.capital_gains(TimeRange::FiveYears).await?;
        let gains_df = CapitalGain::vec_to_dataframe(&gains)?;
        // Columns: timestamp, amount
        println!("capital gains: {:?}", gains_df.shape());
        Ok(())
    }
}
#[cfg(feature = "dataframe")]
pub use soothfast_capture_body::main;

#[cfg(not(feature = "dataframe"))]
fn main() {}