yfinance-rs 0.1.1

Ergonomic Rust client for Yahoo Finance, supporting historical prices, real-time streaming, options, fundamentals, and more.
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

//! Public profile types + loading strategy (API first, then scrape).
//!
//! Internals are split into:
//! - `api`:    quoteSummary v10 API path
//! - `scrape`: HTML scrape + JSON extraction path
//! - `internal`: common utilities for both API and scrape
//! - `debug`:  optional debug dump helpers (only in debug builds or with `debug-dumps` feature)

mod api;
mod scrape;

#[cfg(any(debug_assertions, feature = "debug-dumps"))]
pub(crate) mod debug;

use crate::{YfClient, YfError};

mod model;
pub use model::{Address, Company, Fund, Profile};

/// Helper to contain the API->Scrape fallback logic.
async fn load_with_fallback(client: &YfClient, symbol: &str) -> Result<Profile, YfError> {
    client.ensure_credentials().await?;

    match api::load_from_quote_summary_api(client, symbol).await {
        Ok(p) => Ok(p),
        Err(e) => {
            if std::env::var("YF_DEBUG").ok().as_deref() == Some("1") {
                eprintln!("YF_DEBUG: API call failed ({e}), falling back to scrape.");
            }
            scrape::load_from_scrape(client, symbol).await
        }
    }
}

impl Profile {
    /// Loads the profile for a given symbol.
    ///
    /// This method first attempts to fetch the profile from the `quoteSummary` API.
    /// If that fails, it falls back to scraping the profile from the Yahoo Finance website.
    ///
    /// The behavior can be controlled in `test-mode` builds using `ApiPreference`
    /// on the `YfClientBuilder`.
    pub async fn load(client: &YfClient, symbol: &str) -> Result<Profile, YfError> {
        #[cfg(not(feature = "test-mode"))]
        {
            load_with_fallback(client, symbol).await
        }

        #[cfg(feature = "test-mode")]
        {
            use crate::core::client::ApiPreference;
            match client.api_preference() {
                ApiPreference::ApiThenScrape => load_with_fallback(client, symbol).await,
                ApiPreference::ApiOnly => {
                    client.ensure_credentials().await?;
                    api::load_from_quote_summary_api(client, symbol).await
                }
                ApiPreference::ScrapeOnly => scrape::load_from_scrape(client, symbol).await,
            }
        }
    }
}