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

//! Short interest, short volume, and share float models.
//!
//! Served through the [`Capability::FUNDAMENTALS`](crate::Capability::FUNDAMENTALS)
//! route; Polygon is currently the only provider.

use serde::{Deserialize, Serialize};

/// A short-interest data point (bi-monthly settlement report).
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ShortInterest {
    /// Settlement date (`YYYY-MM-DD`).
    pub settlement_date: Option<String>,
    /// Total shares held short at settlement.
    pub short_interest: Option<f64>,
    /// Average daily trading volume over the reporting period.
    pub avg_daily_volume: Option<f64>,
    /// Days to cover (short interest / average daily volume).
    pub days_to_cover: Option<f64>,
}

/// A daily short-volume data point.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ShortVolume {
    /// Trade date (`YYYY-MM-DD`).
    pub date: Option<String>,
    /// Shares sold short.
    pub short_volume: Option<f64>,
    /// Shares sold short exempt from the uptick rule.
    pub short_exempt_volume: Option<f64>,
    /// Total volume.
    pub total_volume: Option<f64>,
}

/// Share float and shares outstanding.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ShareFloat {
    /// Ticker symbol.
    pub symbol: Option<String>,
    /// Freely tradable shares.
    pub float_shares: Option<f64>,
    /// Total shares outstanding, as reported by the provider. `None` when the
    /// provider does not report it; it is never derived from `float_percent`.
    pub outstanding_shares: Option<f64>,
    /// Freely tradable shares as a percentage of shares outstanding (0-100).
    pub float_percent: Option<f64>,
    /// As-of date (`YYYY-MM-DD`).
    pub date: Option<String>,
}