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

//! ETF profile and holdings models.
//!
//! Served through the [`Capability::FUNDAMENTALS`](crate::Capability::FUNDAMENTALS)
//! route. Alpha Vantage, FMP, and Yahoo all implement it; coverage is ragged
//! (Alpha Vantage serves fuller profile-level fields, FMP additionally serves
//! sector/country breakdowns, Yahoo serves fee/holdings/sector data but no
//! country breakdown or inception date) so gaps default rather than
//! widening per-provider.

use serde::{Deserialize, Serialize};

/// Profile and composition of an exchange-traded fund.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfProfile {
    /// Fund ticker symbol.
    pub symbol: Option<String>,
    /// Fund name.
    pub name: Option<String>,
    /// Asset type as reported by the provider.
    pub asset_type: Option<String>,
    /// Total net assets.
    pub net_assets: Option<f64>,
    /// Net expense ratio, as a fraction (0.0003 = 3 bps).
    pub net_expense_ratio: Option<f64>,
    /// Annual portfolio turnover, as a fraction.
    pub portfolio_turnover: Option<f64>,
    /// Trailing dividend yield, as a fraction.
    pub dividend_yield: Option<f64>,
    /// Inception date (`YYYY-MM-DD`).
    pub inception_date: Option<String>,
    /// Portfolio holdings, heaviest first.
    pub holdings: Vec<EtfHolding>,
    /// Portfolio weight by sector.
    pub sector_weightings: Vec<EtfSectorWeighting>,
    /// Portfolio weight by country.
    pub country_weightings: Vec<EtfCountryWeighting>,
}

/// One position inside an ETF's portfolio.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfHolding {
    /// Ticker symbol of the held security.
    pub symbol: Option<String>,
    /// Security description.
    pub description: Option<String>,
    /// Portfolio weight, as a fraction of net assets.
    pub weight: Option<f64>,
}

/// One sector's weight inside an ETF's portfolio.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfSectorWeighting {
    /// Sector name.
    pub sector: Option<String>,
    /// Portfolio weight, as a fraction of net assets.
    pub weight: Option<f64>,
}

/// One country's weight inside an ETF's portfolio.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfCountryWeighting {
    /// Country name.
    pub country: Option<String>,
    /// Portfolio weight, as a fraction of net assets.
    pub weight: Option<f64>,
}