finance-query 2.5.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

//! TMX/Wall Street Horizon corporate events: earnings, dividends, conferences, splits.

use serde::{Deserialize, Serialize};

use crate::error::Result;

use super::build_client;
use super::models::PaginatedResponse;

/// Corporate event from Wall Street Horizon.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CorporateEvent {
    /// Ticker.
    pub ticker: Option<String>,
    /// Event type (e.g., `"earnings"`, `"dividend"`, `"conference"`, `"split"`).
    pub event_type: Option<String>,
    /// Event name.
    pub name: Option<String>,
    /// Event date.
    pub date: Option<String>,
    /// Event status.
    pub status: Option<String>,
    /// Additional details.
    #[serde(flatten)]
    pub details: std::collections::HashMap<String, serde_json::Value>,
}

/// Fetch corporate events.
pub async fn corporate_events(
    params: &[(&str, &str)],
) -> Result<PaginatedResponse<CorporateEvent>> {
    let client = build_client()?;
    client.get("/v1/reference/corporate-events", params).await
}