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

//! Provider-based SEC filing data models (Polygon EDGAR integration).
//!
//! Unlike [`crate::models::filings::EdgarFiling`] which comes from the direct
//! EDGAR adapter, these types represent the provider-agnostic canonical shape
//! returned by the FILINGS capability through ProviderSet.

use serde::{Deserialize, Serialize};

/// A collection of SEC filings from a provider (e.g., Polygon EDGAR).
///
/// Obtain via [`Ticker::filings`](crate::Ticker::filings).
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[non_exhaustive]
pub struct ProviderFilings {
    /// Ticker symbol these filings belong to.
    pub symbol: String,
    /// Individual filing entries.
    pub filings: Vec<ProviderFiling>,
}

/// A single SEC filing entry from a provider.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[non_exhaustive]
pub struct ProviderFiling {
    /// SEC accession number (unique filing ID).
    pub accession_number: Option<String>,
    /// Filing date as `YYYY-MM-DD`.
    pub filing_date: Option<String>,
    /// Filing type (e.g., `"10-K"`, `"10-Q"`, `"8-K"`).
    pub filing_type: Option<String>,
    /// URL to the filing document.
    pub filing_url: Option<String>,
    /// Company name at time of filing.
    pub company_name: Option<String>,
    /// SEC CIK number.
    pub cik: Option<String>,
}