sec-edgar-api/build/services/DocumentParser/XBRLParser/FilingSummaryParser.d.ts

Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.

export interface XbrlFilingSummary {
    baseTaxonomies: string[];
    inputFiles: string[];
    contextCount: number;
    elementCount: number;
    entityCount: number;
    footnotesReported: boolean;
    hasCalculationLinkbase: boolean;
    hasPresentationLinkbase: boolean;
    scenarioCount: number;
    segmentCount: number;
    tuplesReported: boolean;
    unitCount: number;
    version: string;
    reportFormat: string;
    reports: XbrlFilingSummaryReport[];
}
export type XbrlFilingSummaryMenuCategory = 'Cover' | 'Statements' | 'Notes' | 'Policies' | 'Tables' | 'Details';
export type XbrlFilingSummaryReportType = 'Sheet' | 'Notes' | 'Book';
export interface XbrlFilingSummaryReport {
    longName: string;
    shortName: string;
    isDefault: boolean;
    hasEmbeddedReports: boolean;
    htmlFileName: string;
    reportType: XbrlFilingSummaryReportType;
    role: string;
    menuCategory: XbrlFilingSummaryMenuCategory | null;
    position: number;
    parentRole: string | null;
    instance: string;
}
/**
 * Parse FilingSummary.xml
 */
export default class FilingSummaryParser {
    private readonly xmlParser;
    private toText;
    parse(xml: string): XbrlFilingSummary | null;
}