@mangosteen/edgar-url/dist/index.d.ts

Get SEC EDGAR URLs for filings and entities.

/**
 * Gets an entity (company, person, etc.) landing page URL in primary EDGAR system.
 *
 * @example `https://www.sec.gov/edgar/browse/?CIK=320193`
 * @param cik Entity's Central Index Key.
 * @returns URL.
 */
export declare function getEntityPageUrl(cik: number): string;
/**
 * Gets an entity landing page URL in auxiliary EDGAR system.
 *
 * @example `https://www.edgarcompany.sec.gov/servlet/CompanyDBSearch?page=detailed&main_back=1&cik=0000320193`
 * @param cik Entity's Central Index Key.
 * @returns URL.
 */
export declare function getEntityPageUrl2(cik: number): string;
/**
 * Gets URL of EDGAR page showing transactions of entity securities by insiders.
 *
 * @example `https://www.sec.gov/cgi-bin/own-disp?action=getissuer&CIK=0000320193`
 * @param cik Entity's Central Index Key.
 * @returns URL.
 */
export declare function getInsiderTransactionsPageUrl(cik: number): string;
/**
 * Gets URL of EDGAR page showing transactions of securities owned by the entity.
 *
 * @example `https://www.sec.gov/cgi-bin/own-disp?action=getowner&CIK=0000320193`
 * @param cik Entity's Central Index Key.
 * @returns URL.
 */
export declare function getOwnerTransactionsPageUrl(cik: number): string;
/**
 * Gets URL of a JSON document with entity info.
 *
 * @example `https://data.sec.gov/submissions/CIK0000320193.json`
 * @param cik Entity's Central Index Key.
 * @returns URL.
 */
export declare function geEntityJsonUrl(cik: number): string;
/**
 * Gets URL of a filing in .txt format, which contains all of the following:
 * - Filing header (in a human-readable text format)
 * - Main document
 * - Supplemental documents
 * - Attachments
 *
 * This file seems to be updated when corrections are submitted.
 *
 * @example `https://www.sec.gov/Archives/edgar/data/0000320193/0000320193-20-000096.txt`
 * @param cik Entity's Central Index Key.
 * @param accessionNumber Filing accession number.
 * @returns URL.
 */
export declare function getFilingUrl(cik: number, accessionNumber: string): string;
/**
 * Gets URL of a filing header in SGML format. The header is in machine-readable format.
 * The header file does not seem to be updated when corrections are submitted.
 *
 * @example `https://www.sec.gov/Archives/edgar/data/320193/000032019320000096/0000320193-20-000096.hdr.sgml`
 * @param cik Entity's Central Index Key.
 * @param accessionNumber Filing accession number.
 * @returns URL.
 */
export declare function getFilingHeaderUrl(cik: number, accessionNumber: string): string;
/**
 * Gets a URL of EDGAR page showing details of a specific filing.
 *
 * @example `https://www.sec.gov/Archives/edgar/data/0000320193/000032019320000096/0000320193-20-000096-index.htm`
 * @param cik Entity's Central Index Key.
 * @param accessionNumber Filing accession number.
 * @returns URL.
 */
export declare function getFilingPageUrl(cik: number, accessionNumber: string): string;
//# sourceMappingURL=index.d.ts.map