sec-edgar-toolkit
Version:
Open source toolkit to facilitate working with the SEC EDGAR database
38 lines • 1.91 kB
TypeScript
/**
* SEC EDGAR API Client
*
* This module provides the main SEC EDGAR API client that combines all endpoint
* modules into a single, easy-to-use interface.
*
* Example:
* import { EdgarClient } from 'sec-edgar-toolkit';
*
* const client = new EdgarClient({ userAgent: 'MyApp/1.0 (contact@example.com)' });
* const company = await client.getCompanyByTicker('AAPL');
* const submissions = await client.getCompanySubmissions(company.cik_str);
*
* Note:
* The SEC requires a User-Agent header with contact information for all API requests.
* Please provide accurate contact information in case the SEC needs to reach you
* about your usage.
*/
import { CompanyEndpoints, FilingsEndpoints, XbrlEndpoints } from '../endpoints';
import { CompanyTicker, CompanySubmissions, EdgarClientConfig, RequestOptions } from '../types';
export declare class EdgarClient {
private httpClient;
private userAgent;
company: CompanyEndpoints;
filings: FilingsEndpoints;
xbrl: XbrlEndpoints;
constructor(config?: EdgarClientConfig);
getCompanyTickers(forceRefresh?: boolean): Promise<Record<string, any>>;
getCompanyByTicker(ticker: string): Promise<CompanyTicker | null>;
getCompanyByCik(cik: string | number): Promise<CompanyTicker | null>;
searchCompanies(query: string): Promise<CompanyTicker[]>;
getCompanySubmissions(cik: string | number, options?: RequestOptions): Promise<CompanySubmissions>;
getFiling(cik: string | number, accessionNumber: string): Promise<Record<string, any>>;
getCompanyFacts(cik: string | number): Promise<Record<string, any>>;
getCompanyConcept(cik: string | number, taxonomy: string, tag: string, unit?: string): Promise<Record<string, any>>;
getFrames(taxonomy: string, tag: string, unit: string, year: number, options?: RequestOptions): Promise<Record<string, any>>;
}
//# sourceMappingURL=edgar-client.d.ts.map