/** * SEC EDGAR SDK — typed API client for SEC EDGAR data. * * Standalone — no MCP server required. Usage: * * import { getCompanyByCik, getCompanyFacts, searchEdgar } from "us-gov-open-data-mcp/sdk/sec"; * * No API key required. Must include User-Agent with contact info. * Rate limit: 10 requests/second. */ /** Sec Company. */ export interface SecCompany { cik: string; name: string; tickers: string[]; exchanges: string[]; sic: string; sicDescription: string; stateOfIncorporation: string; entityType: string; category: string; fiscalYearEnd: string; formerNames: { name: string; from: string; to: string; }[]; filings: { recent: { form: string[]; filingDate: string[]; primaryDocDescription: string[]; accessionNumber: string[]; }; }; } /** Sec Filing. */ export interface SecFiling { form: string; date: string; description: string; accessionNumber: string; } /** Sec Company Facts. */ export interface SecCompanyFacts { cik: number; entityName: string; facts: { "us-gaap"?: Record; [namespace: string]: Record | undefined; }; } /** Sec Xbrl Concept. */ export interface SecXbrlConcept { label?: string; description?: string; units: Record; } /** Sec Xbrl Observation. */ export interface SecXbrlObservation { start?: string; end?: string; val: number; accn: string; fy: number; fp: string; form: string; filed: string; frame?: string; } /** Sec Search Result. */ export interface SecSearchResult { total: number; hits: { names: string[]; form: string; date: string; description: string; }[]; } /** SEC XBRL financial concept codes to human-readable labels. */ export declare const xbrlConcepts: { readonly Revenues: "Total revenue"; readonly RevenueFromContractWithCustomerExcludingAssessedTax: "Revenue from contracts (ASC 606)"; readonly NetIncomeLoss: "Net income (loss)"; readonly OperatingIncomeLoss: "Operating income"; readonly GrossProfit: "Gross profit"; readonly Assets: "Total assets"; readonly Liabilities: "Total liabilities"; readonly StockholdersEquity: "Total stockholders equity"; readonly CashAndCashEquivalentsAtCarryingValue: "Cash and cash equivalents"; readonly LongTermDebt: "Long-term debt"; readonly EarningsPerShareBasic: "Basic earnings per share"; readonly EarningsPerShareDiluted: "Diluted earnings per share"; readonly CommonStockSharesOutstanding: "Common shares outstanding"; readonly Goodwill: "Goodwill"; readonly ResearchAndDevelopmentExpense: "R&D expense"; readonly SellingGeneralAndAdministrativeExpense: "SG&A expense"; readonly InterestExpense: "Interest expense"; readonly IncomeTaxExpenseBenefit: "Income tax expense"; }; /** Look up a company by CIK number. */ export declare function getCompanyByCik(cik: string): Promise; /** Get company financial facts (XBRL data). */ export declare function getCompanyFacts(cik: string): Promise; /** Full-text search across EDGAR filings. */ export declare function searchEdgar(query: string, opts?: { forms?: string; startDate?: string; endDate?: string; }): Promise; /** * Extract a specific XBRL concept from company facts. * Traverses facts["us-gaap"][concept].units.USD */ export declare function extractConceptData(facts: SecCompanyFacts, concept: string): { concept: string; label: string; description: string; unit: string; annual: SecXbrlObservation[]; quarterly: SecXbrlObservation[]; } | null; /** * Get a summary of key financial metrics from company facts. */ export declare function summarizeFinancials(facts: SecCompanyFacts): { entityName: string; totalMetrics: number; keyMetrics: { concept: string; label: string; value: number | null; unit: string | null; period: string | null; }[]; }; /** Clear cached responses from both clients. */ export declare function clearCache(): void; //# sourceMappingURL=sdk.d.ts.map