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

//! ETF Global partner data: analytics, constituents, fund flows, profiles, taxonomies.

use serde::{Deserialize, Serialize};

use crate::adapters::common::encode_path_segment;
use crate::error::Result;

use super::build_client;
use super::models::PaginatedResponse;

/// ETF analytics data.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfAnalytics {
    /// Ticker.
    pub ticker: Option<String>,
    /// Name.
    pub name: Option<String>,
    /// Performance data.
    #[serde(flatten)]
    pub data: std::collections::HashMap<String, serde_json::Value>,
}

/// ETF constituent/holding.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfConstituent {
    /// Holding ticker.
    pub ticker: Option<String>,
    /// Holding name.
    pub name: Option<String>,
    /// Weight in portfolio.
    pub weight: Option<f64>,
    /// Market value.
    pub market_value: Option<f64>,
    /// Share count.
    pub shares: Option<f64>,
}

/// ETF fund flow.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfFundFlow {
    /// Ticker.
    pub ticker: Option<String>,
    /// Date.
    pub date: Option<String>,
    /// Flow amount.
    pub flow: Option<f64>,
}

/// ETF profile.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfProfileData {
    /// Ticker.
    pub ticker: Option<String>,
    /// Name.
    pub name: Option<String>,
    /// Issuer.
    pub issuer: Option<String>,
    /// Expense ratio.
    pub expense_ratio: Option<f64>,
    /// Inception date.
    pub inception_date: Option<String>,
    /// Asset class.
    pub asset_class: Option<String>,
    /// Sector.
    pub sector: Option<String>,
    /// Region.
    pub region: Option<String>,
}

/// ETF taxonomy.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EtfTaxonomy {
    /// Category.
    pub category: Option<String>,
    /// Subcategory.
    pub subcategory: Option<String>,
    /// Description.
    pub description: Option<String>,
}

/// Fetch ETF analytics.
pub async fn etf_analytics(params: &[(&str, &str)]) -> Result<PaginatedResponse<EtfAnalytics>> {
    let client = build_client()?;
    client.get("/v3/reference/etfs/analytics", params).await
}

/// Fetch ETF constituents/holdings.
pub async fn etf_constituents(
    ticker: &str,
    params: &[(&str, &str)],
) -> Result<PaginatedResponse<EtfConstituent>> {
    let client = build_client()?;
    let path = format!(
        "/v3/reference/etfs/{}/constituents",
        encode_path_segment(ticker)
    );
    client.get(&path, params).await
}

/// Fetch ETF fund flows.
pub async fn etf_fund_flows(params: &[(&str, &str)]) -> Result<PaginatedResponse<EtfFundFlow>> {
    let client = build_client()?;
    client.get("/v3/reference/etfs/fund-flows", params).await
}

/// Fetch ETF profiles/exposure.
pub async fn etf_profiles(params: &[(&str, &str)]) -> Result<PaginatedResponse<EtfProfileData>> {
    let client = build_client()?;
    client.get("/v3/reference/etfs/profiles", params).await
}

/// Fetch ETF taxonomies.
pub async fn etf_taxonomies(params: &[(&str, &str)]) -> Result<PaginatedResponse<EtfTaxonomy>> {
    let client = build_client()?;
    client.get("/v3/reference/etfs/taxonomies", params).await
}