Struct EdgarFiling 

#[non_exhaustive]
pub struct EdgarFiling {
    pub accession_number: String,
    pub filing_date: String,
    pub report_date: String,
    pub acceptance_date_time: String,
    pub form: String,
    pub size: u64,
    pub is_xbrl: bool,
    pub is_inline_xbrl: bool,
    pub primary_document: String,
    pub primary_doc_description: String,
}

A single SEC filing with metadata.

Derived from the parallel arrays in EdgarFilingRecent via to_filings().

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

accession_number: String

Accession number (unique filing identifier, e.g., “0000320193-24-000123”)

filing_date: String

Filing date (YYYY-MM-DD)

report_date: String

Report date (YYYY-MM-DD)

acceptance_date_time: String

Acceptance date-time

form: String

Form type (e.g., “10-K”, “10-Q”, “8-K”)

size: u64

Filing size in bytes

is_xbrl: bool

Whether the filing contains XBRL data

is_inline_xbrl: bool

Whether the filing contains Inline XBRL data

primary_document: String

Primary document filename

primary_doc_description: String

Primary document description

Implementations

impl EdgarFiling

pub fn to_dataframe(&self) -> PolarsResult<DataFrame>

Converts this struct to a single-row polars DataFrame.

All scalar fields are included as columns. Nested objects and complex types are excluded.

This method is auto-generated by the ToDataFrame derive macro.

pub fn vec_to_dataframe(items: &[Self]) -> PolarsResult<DataFrame>

Converts a slice of structs to a multi-row polars DataFrame.

All scalar fields are included as columns. Nested objects and complex types are excluded.

This method is auto-generated by the ToDataFrame derive macro.

impl EdgarFiling

pub fn new( accession_number: String, filing_date: String, report_date: String, acceptance_date_time: String, form: String, size: u64, is_xbrl: bool, is_inline_xbrl: bool, primary_document: String, primary_doc_description: String, ) -> Self

Create a new EdgarFiling instance.

This constructor is provided to support creating EdgarFiling instances outside the library crate, since the struct is marked #[non_exhaustive].

pub fn edgar_url(&self) -> String

Get the URL to view this filing on SEC EDGAR.

Example

use finance_query::edgar;

edgar::init("user@example.com")?;
let cik = edgar::resolve_cik("AAPL").await?;
let submissions = edgar::submissions(cik).await?;

if let Some(filings) = &submissions.filings {
    if let Some(recent) = &filings.recent {
        for filing in recent.to_filings() {
            let url = filing.edgar_url();
            println!("Filing URL: {}", url);
        }
    }
}

Trait Implementations

impl Clone for EdgarFiling

fn clone(&self) -> EdgarFiling

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EdgarFiling

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EdgarFiling

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EdgarFiling

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.