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

//! Compile and runtime tests for docs/library/indices.md
//!
//! Requires the `polygon` feature flag:
//!   cargo test --test doc_indices --features polygon
//!
//! Runtime behavior of the index quote path is covered without network access
//! by the mock + unit tests in `src/adapters/polygon/indices/snapshots.rs` and
//! `src/adapters/fmp/indices/mod.rs` (mocked HTTP → DTO → canonical `IndexQuote`).

#![cfg(feature = "polygon")]

use finance_query::{Capability, IndexQuote, Interval, Provider, Providers, TimeRange};

// ---------------------------------------------------------------------------
// IndexQuote — compile-time field verification
// ---------------------------------------------------------------------------

/// Verifies all IndexQuote fields documented in indices.md exist with correct
/// types. Never called; exists only for the compiler to type-check.
#[allow(dead_code)]
fn _verify_index_quote_fields(q: IndexQuote) {
    let _: String = q.symbol;
    let _: Option<String> = q.name;
    let _: Option<f64> = q.price;
    let _: Option<f64> = q.change;
    let _: Option<f64> = q.change_percent;
    let _: Option<i64> = q.timestamp;
}

/// Verifies Chart struct fields documented in indices.md exist with correct
/// types. Never called; exists only for the compiler to type-check.
#[allow(dead_code)]
fn _verify_chart_fields(chart: finance_query::Chart) {
    let _: String = chart.symbol;
    let _: Vec<finance_query::Candle> = chart.candles;
    let _: Option<Interval> = chart.interval;
    let _: Option<TimeRange> = chart.range;
}

// ---------------------------------------------------------------------------
// Capability and Provider constants — compile-time verification
// ---------------------------------------------------------------------------

/// Verifies that Capability::INDICES and Provider::Polygon exist as documented.
#[test]
fn test_indices_capability_and_provider_exist() {
    let _cap = Capability::INDICES;
    let _prov = Provider::Polygon;
}

// ---------------------------------------------------------------------------
// Compile-time: handle API — mirrors the setup block in indices.md
// ---------------------------------------------------------------------------

/// Verifies the documented `Index` flow type-checks:
///   providers.index("I:SPX") → quote(), chart(), history()
/// Never called; exists only for the compiler to type-check. Runtime behavior
/// is covered by the mock + unit tests in
/// `src/adapters/polygon/indices/snapshots.rs`.
#[allow(dead_code)]
async fn _verify_index_api() -> finance_query::Result<()> {
    let providers = Providers::builder()
        .route(Capability::INDICES, [Provider::Polygon])
        .build()
        .await?;

    let spx = providers.index("I:SPX");
    let _quote: IndexQuote = spx.quote().await?;
    let _chart: finance_query::Chart = spx.chart(Interval::OneDay, TimeRange::OneMonth).await?;
    let _history: finance_query::Chart = spx.history(TimeRange::OneMonth).await?;
    Ok(())
}

// ---------------------------------------------------------------------------
// Compile-time: Indicators & Risk section of indices.md
// ---------------------------------------------------------------------------

/// Verifies the documented `Index::indicators`/`indicator`/`risk` flow
/// type-checks. Never called; exists only for the compiler to type-check.
#[allow(dead_code)]
#[cfg(all(feature = "indicators", feature = "risk"))]
async fn _verify_index_indicators_and_risk() -> finance_query::Result<()> {
    use finance_query::indicators::Indicator;

    let providers = Providers::builder()
        .route(Capability::INDICES, [Provider::Polygon])
        .build()
        .await?;
    let spx = providers.index("I:SPX");

    let summary = spx
        .indicators(Interval::OneDay, TimeRange::ThreeMonths)
        .await?;
    let _: Option<f64> = summary.rsi_14;

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

    let risk = spx.risk(Interval::OneDay, TimeRange::OneYear).await?;
    let _: f64 = risk.var_95;
    let _: f64 = risk.max_drawdown;

    Ok(())
}