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
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
142
143
144
145
146
147
148

/// Region categories for world indices
///
/// The `alias`es mirror the shorthands [`FromStr`](std::str::FromStr) accepts, so
/// deserializing (axum query extraction, JSON) takes the same spellings parsing does.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum Region {
    /// North and South America
    #[serde(alias = "america", alias = "am")]
    Americas,
    /// European markets
    #[serde(alias = "eu")]
    Europe,
    /// Asia and Pacific markets
    #[serde(alias = "asia", alias = "apac", alias = "asia_pacific")]
    AsiaPacific,
    /// Middle East and Africa
    #[serde(alias = "mea", alias = "emea", alias = "middle_east_africa")]
    MiddleEastAfrica,
    /// Currency indices
    #[serde(alias = "currency", alias = "fx")]
    Currencies,
}

impl std::str::FromStr for Region {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().replace(['-', '_'], "").as_str() {
            "americas" | "america" | "am" => Ok(Region::Americas),
            "europe" | "eu" => Ok(Region::Europe),
            "asiapacific" | "asia" | "apac" => Ok(Region::AsiaPacific),
            "middleeastafrica" | "mea" | "emea" => Ok(Region::MiddleEastAfrica),
            "currencies" | "currency" | "fx" => Ok(Region::Currencies),
            _ => Err(()),
        }
    }
}

impl Region {
    /// Parse from string, returns None on invalid input
    pub fn parse(s: &str) -> Option<Self> {
        s.parse().ok()
    }

    /// Get the symbols for this region
    pub fn symbols(&self) -> &'static [&'static str] {
        match self {
            Region::Americas => AMERICAS,
            Region::Europe => EUROPE,
            Region::AsiaPacific => ASIA_PACIFIC,
            Region::MiddleEastAfrica => MIDDLE_EAST_AFRICA,
            Region::Currencies => CURRENCIES,
        }
    }

    /// Convert to string representation
    pub fn as_str(&self) -> &'static str {
        match self {
            Region::Americas => "americas",
            Region::Europe => "europe",
            Region::AsiaPacific => "asia-pacific",
            Region::MiddleEastAfrica => "middle-east-africa",
            Region::Currencies => "currencies",
        }
    }

    /// All region variants
    pub fn all() -> &'static [Region] {
        &[
            Region::Americas,
            Region::Europe,
            Region::AsiaPacific,
            Region::MiddleEastAfrica,
            Region::Currencies,
        ]
    }
}

/// Americas indices
pub const AMERICAS: &[&str] = &[
    "^GSPC",   // S&P 500
    "^DJI",    // Dow Jones Industrial Average
    "^IXIC",   // NASDAQ Composite
    "^NYA",    // NYSE Composite Index
    "^XAX",    // NYSE American Composite Index
    "^RUT",    // Russell 2000 Index
    "^VIX",    // CBOE Volatility Index
    "^GSPTSE", // S&P/TSX Composite (Canada)
    "^BVSP",   // IBOVESPA (Brazil)
    "^MXX",    // IPC MEXICO
    "^IPSA",   // S&P IPSA (Chile)
    "^MERV",   // MERVAL (Argentina)
];

/// Europe indices
pub const EUROPE: &[&str] = &[
    "^FTSE",            // FTSE 100 (UK)
    "^GDAXI",           // DAX (Germany)
    "^FCHI",            // CAC 40 (France)
    "^STOXX50E",        // EURO STOXX 50
    "^N100",            // Euronext 100 Index
    "^BFX",             // BEL 20 (Belgium)
    "^BUK100P",         // Cboe UK 100
    "MOEX.ME",          // Moscow Exchange
    "^125904-USD-STRD", // MSCI EUROPE
];

/// Asia Pacific indices
pub const ASIA_PACIFIC: &[&str] = &[
    "^N225",     // Nikkei 225 (Japan)
    "^HSI",      // Hang Seng Index (Hong Kong)
    "000001.SS", // SSE Composite Index (China)
    "^KS11",     // KOSPI (South Korea)
    "^TWII",     // Taiwan Weighted Index
    "^STI",      // STI Index (Singapore)
    "^AXJO",     // S&P/ASX 200 (Australia)
    "^AORD",     // All Ordinaries (Australia)
    "^NZ50",     // S&P/NZX 50 (New Zealand)
    "^BSESN",    // S&P BSE SENSEX (India)
    "^JKSE",     // IDX Composite (Indonesia)
    "^KLSE",     // FTSE Bursa Malaysia KLCI
];

/// Middle East & Africa indices
pub const MIDDLE_EAST_AFRICA: &[&str] = &[
    "^TA125.TA", // TA-125 (Israel)
    "^CASE30",   // EGX 30 (Egypt)
    "^JN0U.JO",  // Top 40 USD Net TRI (South Africa)
];

/// Currency indices
pub const CURRENCIES: &[&str] = &[
    "DX-Y.NYB", // US Dollar Index
    "^XDB",     // British Pound Currency Index
    "^XDE",     // Euro Currency Index
    "^XDN",     // Japanese Yen Currency Index
    "^XDA",     // Australian Dollar Currency Index
];

/// All world indices (all regions combined)
pub fn all_symbols() -> Vec<&'static str> {
    Region::all()
        .iter()
        .flat_map(|r| r.symbols().iter().copied())
        .collect()
}