quiverquant 0.2.2

A crate for accessing the QuiverQuant API.
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

//! Data types for the Congressional Trading, House Trading, and Senate Trading datasets.
//!
//! From the QuiverQuant API: 
//! > The Stock Trading on Congressional Knowledge Act requires members of U.S. Congress to publicly
//! file and disclose any financial transaction within 45 days of its occurrence. We download those
//! disclosures and parse them for stock trades.
//!
//! NOTE: All three datasets rely on the `TradingEntry` struct. Those fields may be accessed under
//! the `common` field of the `CongressTradingEntry` struct when using the Congress Trading dataset.

use super::*;

pub type CongressTrading = Vec<CongressTradingEntry>;
pub type SenateTrading = Vec<TradingEntry>;
pub type HouseTrading = Vec<TradingEntry>;

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
/// Direction of Transaction
/// Sale or Purchase
pub enum Transaction {
    Sale,
    Purchase,
    Exchange
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
/// House of Congress
pub enum CongressHouse {
    Senate,
    Representatives,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
/// An Entry in the [`CongressTrading`] dataset
pub struct CongressTradingEntry {
    /// Date of Report
    pub report_date: Date,

    /// House the Representative serves in
    pub house: CongressHouse,
    
    #[serde(flatten)]
    pub common: TradingEntry
}


#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
/// This is the Structure returned from QuiverQuant's API for the HouseTrading and SenateTrading
/// API endpoints.
pub struct TradingEntry {
    /// Date of Transaction
    #[serde(alias = "TransactionDate")]
    #[serde(alias = "Date")]
    pub transaction_date: Date,
    /// Ticker of Transaction
    pub ticker: Ticker,
    /// Name of Senator
    #[serde(alias = "Senator")]
    #[serde(alias = "Representative")]
    pub representative: String,
    /// Transaction Direction
    pub transaction: Transaction,
    /// Amount of Transaction
    pub amount: Option<f64>
}