volumeleaders-client 0.2.0

Browser-session API client for VolumeLeaders data
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! VolumeLeaders trade cluster and trade cluster bomb models.

use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};

use super::types::{AspNetDate, FlexBool};

/// A single VolumeLeaders trade cluster row.
///
/// All fields are `Option` to handle missing or null values from the API.
/// Field names match the API's PascalCase convention via `rename_all`, with
/// explicit `rename` overrides for all-caps abbreviations.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct TradeCluster {
    // -- Dates --
    pub date: Option<AspNetDate>,
    #[serde(rename = "IPODate")]
    pub ipo_date: Option<AspNetDate>,

    // -- Keys --
    pub date_key: Option<i64>,
    pub security_key: Option<i64>,

    // -- Security info --
    pub ticker: Option<String>,
    pub sector: Option<String>,
    pub industry: Option<String>,
    pub name: Option<String>,

    // -- Time range --
    pub min_full_date_time: Option<String>,
    pub max_full_date_time: Option<String>,
    #[serde(rename = "MinFullTimeString24")]
    pub min_full_time_string_24: Option<String>,
    #[serde(rename = "MaxFullTimeString24")]
    pub max_full_time_string_24: Option<String>,

    // -- Price / size --
    pub price: Option<Decimal>,
    pub close_price: Option<Decimal>,
    pub dollars: Option<Decimal>,
    pub average_block_size_shares: Option<i64>,
    pub average_block_size_dollars: Option<Decimal>,
    pub volume: Option<i64>,
    pub average_daily_volume: Option<i64>,

    // -- Rank / distribution --
    pub trade_count: Option<i64>,
    pub dollars_multiplier: Option<f64>,
    pub cumulative_distribution: Option<f64>,
    pub trade_cluster_rank: Option<i64>,

    // -- Reference dates --
    pub last_comparible_trade_cluster_date: Option<AspNetDate>,

    // -- Calendar flags --
    #[serde(rename = "EOM")]
    pub eom: Option<FlexBool>,
    #[serde(rename = "EOQ")]
    pub eoq: Option<FlexBool>,
    #[serde(rename = "EOY")]
    pub eoy: Option<FlexBool>,
    #[serde(rename = "OPEX")]
    pub opex: Option<FlexBool>,
    #[serde(rename = "VOLEX")]
    pub volex: Option<FlexBool>,
    pub inside_bar: Option<FlexBool>,
    pub double_inside_bar: Option<FlexBool>,

    // -- Metadata --
    pub total_rows: Option<i64>,
    pub external_feed: Option<FlexBool>,
}

/// A single VolumeLeaders trade cluster bomb row.
///
/// All fields are `Option` to handle missing or null values from the API.
/// Field names match the API's PascalCase convention via `rename_all`, with
/// explicit `rename` overrides for all-caps abbreviations.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct TradeClusterBomb {
    // -- Dates --
    pub date: Option<AspNetDate>,
    #[serde(rename = "IPODate")]
    pub ipo_date: Option<AspNetDate>,

    // -- Keys --
    pub date_key: Option<i64>,
    pub security_key: Option<i64>,

    // -- Security info --
    pub ticker: Option<String>,
    pub sector: Option<String>,
    pub industry: Option<String>,
    pub name: Option<String>,

    // -- Time range --
    pub min_full_date_time: Option<String>,
    pub max_full_date_time: Option<String>,
    #[serde(rename = "MinFullTimeString24")]
    pub min_full_time_string_24: Option<String>,
    #[serde(rename = "MaxFullTimeString24")]
    pub max_full_time_string_24: Option<String>,

    // -- Price / size --
    pub close_price: Option<Decimal>,
    pub dollars: Option<Decimal>,
    pub average_block_size_shares: Option<i64>,
    pub average_block_size_dollars: Option<Decimal>,
    pub volume: Option<i64>,
    pub average_daily_volume: Option<i64>,

    // -- Rank / distribution --
    pub trade_count: Option<i64>,
    pub dollars_multiplier: Option<f64>,
    pub cumulative_distribution: Option<f64>,
    pub trade_cluster_bomb_rank: Option<i64>,

    // -- Reference dates --
    pub last_comparable_trade_cluster_bomb_date: Option<AspNetDate>,

    // -- Calendar flags --
    #[serde(rename = "EOM")]
    pub eom: Option<FlexBool>,
    #[serde(rename = "EOQ")]
    pub eoq: Option<FlexBool>,
    #[serde(rename = "EOY")]
    pub eoy: Option<FlexBool>,
    #[serde(rename = "OPEX")]
    pub opex: Option<FlexBool>,
    #[serde(rename = "VOLEX")]
    pub volex: Option<FlexBool>,
    pub inside_bar: Option<FlexBool>,
    pub double_inside_bar: Option<FlexBool>,

    // -- Metadata --
    pub total_rows: Option<i64>,
    pub external_feed: Option<FlexBool>,
}