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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Market-wide performance models.
//!
//! Returned by the [`Capability::MARKET`](crate::Capability::MARKET) route via
//! [`Providers::market`](crate::Providers::market).

use serde::{Deserialize, Serialize};

/// Which set of market movers to fetch.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum MoverDirection {
    /// Largest percentage gainers.
    Gainers,
    /// Largest percentage losers.
    Losers,
    /// Highest traded volume.
    MostActive,
}

/// A sector's aggregate performance.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SectorPerformance {
    /// Sector name (e.g. `"Technology"`).
    pub sector: String,
    /// Exchange the average was computed over (e.g. `"NASDAQ"`). Providers
    /// report one row per sector per exchange.
    pub exchange: Option<String>,
    /// Percentage change, as a number (e.g. `1.23` for `"1.23%"`).
    pub change_percent: Option<f64>,
}

/// One day of aggregate performance across every sector and exchange.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SectorPerformanceHistory {
    /// Date (`YYYY-MM-DD`).
    pub date: Option<String>,
    /// Per-sector percentage change on that date, one entry per
    /// (sector, exchange) pair.
    pub sectors: Vec<SectorPerformance>,
}

/// A sector's aggregate price/earnings ratio.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SectorPe {
    /// Sector name.
    pub sector: String,
    /// Exchange the ratio was computed over.
    pub exchange: Option<String>,
    /// Price/earnings ratio.
    pub pe: Option<f64>,
    /// As-of date (`YYYY-MM-DD`).
    pub date: Option<String>,
}

/// An industry's aggregate price/earnings ratio.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct IndustryPe {
    /// Industry name.
    pub industry: String,
    /// Exchange the ratio was computed over.
    pub exchange: Option<String>,
    /// Price/earnings ratio.
    pub pe: Option<f64>,
    /// As-of date (`YYYY-MM-DD`).
    pub date: Option<String>,
}

/// A symbol appearing in a market-movers list.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct MoverQuote {
    /// Ticker symbol.
    pub symbol: String,
    /// Company name.
    pub name: Option<String>,
    /// Latest price.
    pub price: Option<f64>,
    /// Absolute price change.
    pub change: Option<f64>,
    /// Percentage price change.
    pub change_percent: Option<f64>,
    /// Exchange the symbol trades on.
    pub exchange: Option<String>,
}