sec-edgar-api 0.2.1 → 0.2.2

package/build/types/form-13f-xml.type.d.ts

@@ -0,0 +1,105 @@
+export interface Form13FXML {
+    edgarSubmission: EdgarSubmissionXML;
+    informationTable: InformationTableXML;
+}
+export interface EdgarSubmissionXML {
+    headerData: HeaderDataXML;
+    formData: FormDataXML;
+}
+export interface FormDataXML {
+    coverPage: CoverPageXML;
+    signatureBlock: SignatureBlockXML;
+    summaryPage: SummaryPageXML;
+}
+export interface CoverPageXML {
+    reportCalendarOrQuarter: string;
+    filingManager: FilingManagerXML;
+    reportType: string;
+    form13FFileNumber: string;
+    otherManagersInfo: OtherManagersInfoXML;
+    provideInfoForInstruction5: string;
+}
+export interface FilingManagerXML {
+    name: string;
+    address: AddressXML;
+}
+export interface AddressXML {
+    'ns1:street1': string;
+    'ns1:city': string;
+    'ns1:stateOrCountry': string;
+    'ns1:zipCode': number;
+}
+export interface OtherManagersInfoXML {
+    otherManager: OtherManagerXML;
+}
+export interface OtherManagerXML {
+    form13FFileNumber: string;
+    name: string;
+}
+export interface SignatureBlockXML {
+    name: string;
+    title: string;
+    phone: string;
+    signature: string;
+    city: string;
+    stateOrCountry: string;
+    signatureDate: string;
+}
+export interface SummaryPageXML {
+    otherIncludedManagersCount: number;
+    tableEntryTotal: number;
+    tableValueTotal: number;
+    isConfidentialOmitted: boolean;
+    otherManagers2Info: OtherManagers2InfoXML;
+}
+export interface OtherManagers2InfoXML {
+    otherManager2: OtherManager2XML[];
+}
+export interface OtherManager2XML {
+    sequenceNumber: number;
+    otherManager: OtherManagerXML;
+}
+export interface HeaderDataXML {
+    submissionType: string;
+    filerInfo: FilerInfoXML;
+}
+export interface FilerInfoXML {
+    liveTestFlag: string;
+    flags: FlagsXML;
+    filer: FilerXML;
+    periodOfReport: string;
+}
+export interface FilerXML {
+    credentials: CredentialsXML;
+}
+export interface CredentialsXML {
+    cik: number;
+    ccc: string;
+}
+export interface FlagsXML {
+    confirmingCopyFlag: boolean;
+    returnCopyFlag: boolean;
+    overrideInternetFlag: boolean;
+}
+export interface InformationTableXML {
+    infoTable: InfoTableXML[];
+}
+export interface InfoTableXML {
+    nameOfIssuer: string;
+    titleOfClass: string;
+    cusip: number | string;
+    value: number;
+    shrsOrPrnAmt: ShrsOrPrnAmtXML;
+    investmentDiscretion: string;
+    otherManager: number | string;
+    votingAuthority: VotingAuthorityXML;
+}
+export interface ShrsOrPrnAmtXML {
+    sshPrnamt: number;
+    sshPrnamtType: string;
+}
+export interface VotingAuthorityXML {
+    Sole: number;
+    Shared: number;
+    None: number;
+}

package/build/types/form-13f-xml.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/form-4-xml.type.d.ts

@@ -0,0 +1,132 @@
+export interface Form4XML {
+    schemaVersion: string;
+    documentType: number;
+    periodOfReport: string;
+    notSubjectToSection16: number;
+    issuer: IssuerXML;
+    reportingOwner: ReportingOwnerXML;
+    aff10b5One: number;
+    nonDerivativeTable: NonDerivativeTableXML;
+    derivativeTable: DerivativeTableXML;
+    footnotes: FootnotesXML;
+    remarks: string;
+    ownerSignature: OwnerSignatureXML;
+}
+export interface DerivativeTableXML {
+    derivativeHolding: DerivativeHoldingXML[];
+    derivativeTransaction: DerivativeTransactionXML[];
+}
+export interface DerivativeHoldingXML {
+    securityTitle: ValueCellXML;
+    conversionOrExercisePrice: ValueCellXML;
+    exerciseDate: ValueCellXML;
+    expirationDate: ValueCellXML;
+    underlyingSecurity: UnderlyingSecurityXML;
+    postTransactionAmounts: DerivativeHoldingPostTransactionAmountsXML;
+    ownershipNature: DerivativeHoldingOwnershipNatureXML;
+}
+export interface DerivativeHoldingOwnershipNatureXML {
+    directOrIndirectOwnership: ValueCellXML;
+    natureOfOwnership?: ValueCellXML;
+}
+export interface ValueCellXML {
+    value?: string | number;
+    footnoteId?: string;
+}
+export interface DerivativeHoldingPostTransactionAmountsXML {
+    sharesOwnedFollowingTransaction: ValueCellXML;
+}
+export interface UnderlyingSecurityXML {
+    underlyingSecurityTitle: ValueCellXML;
+    underlyingSecurityShares: ValueCellXML;
+}
+export interface DerivativeTransactionXML {
+    securityTitle: ValueCellXML;
+    conversionOrExercisePrice: ValueCellXML;
+    transactionDate: ValueCellXML;
+    deemedExecutionDate: string;
+    transactionCoding: TransactionCodingXML;
+    transactionTimeliness: ValueCellXML;
+    transactionAmounts: TransactionAmountsXML;
+    exerciseDate: ValueCellXML;
+    expirationDate: ValueCellXML;
+    underlyingSecurity: UnderlyingSecurityXML;
+    postTransactionAmounts: DerivativeHoldingPostTransactionAmountsXML;
+    ownershipNature: DerivativeTransactionOwnershipNatureXML;
+}
+export interface DerivativeTransactionOwnershipNatureXML {
+    directOrIndirectOwnership: ValueCellXML;
+    natureOfOwnership: ValueCellXML;
+}
+export interface TransactionAmountsXML {
+    transactionShares: ValueCellXML;
+    transactionPricePerShare: ValueCellXML;
+    transactionAcquiredDisposedCode: ValueCellXML;
+}
+export interface TransactionCodingXML {
+    transactionFormType: number;
+    transactionCode: string;
+    equitySwapInvolved: number;
+    footnoteId: string;
+}
+export interface FootnotesXML {
+    footnote: string[];
+}
+export interface IssuerXML {
+    issuerCik: number;
+    issuerName: string;
+    issuerTradingSymbol: string;
+}
+export interface NonDerivativeTableXML {
+    nonDerivativeHolding: NonDerivativeHoldingXML[];
+    nonDerivativeTransaction: NonDerivativeTransactionXML[];
+}
+export interface NonDerivativeHoldingXML {
+    securityTitle: ValueCellXML;
+    postTransactionAmounts: NonDerivativeHoldingPostTransactionAmountsXML;
+    ownershipNature: DerivativeHoldingOwnershipNatureXML;
+}
+export interface NonDerivativeHoldingPostTransactionAmountsXML {
+    sharesOwnedFollowingTransaction: PurpleValueCell;
+}
+export interface PurpleValueCell {
+    value: number;
+    footnoteId: string;
+}
+export interface NonDerivativeTransactionXML {
+    securityTitle: ValueCellXML;
+    transactionDate: ValueCellXML;
+    deemedExecutionDate: string;
+    transactionCoding: TransactionCodingXML;
+    transactionTimeliness: ValueCellXML;
+    transactionAmounts: TransactionAmountsXML;
+    postTransactionAmounts: DerivativeHoldingPostTransactionAmountsXML;
+    ownershipNature: DerivativeTransactionOwnershipNatureXML;
+}
+export interface OwnerSignatureXML {
+    signatureName: string;
+    signatureDate: string;
+}
+export interface ReportingOwnerXML {
+    reportingOwnerId: ReportingOwnerIDXML;
+    reportingOwnerAddress: ReportingOwnerAddressXML;
+    reportingOwnerRelationship: ReportingOwnerRelationshipXML;
+}
+export interface ReportingOwnerAddressXML {
+    rptOwnerStreet1: string;
+    rptOwnerStreet2: string;
+    rptOwnerCity: string;
+    rptOwnerState: string;
+    rptOwnerZipCode: number;
+    rptOwnerStateDescription: string;
+}
+export interface ReportingOwnerIDXML {
+    rptOwnerCik: number;
+    rptOwnerName: string;
+}
+export interface ReportingOwnerRelationshipXML {
+    isDirector: number;
+    isOfficer: number;
+    isTenPercentOwner: number;
+    isOther: number;
+}

package/build/types/form-4-xml.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/index.d.ts

@@ -1,6 +1,6 @@
+export * from './common.type';
 export * from './company-facts.type';
+export * from './parsed-filings.type';
 export * from './report-raw.type';
 export * from './report-translated.type';
 export * from './submission.type';
-export * from './parsed-filings.type';
-export * from './common.type';

package/build/types/index.js

@@ -14,9 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common.type"), exports);
 __exportStar(require("./company-facts.type"), exports);
+__exportStar(require("./parsed-filings.type"), exports);
 __exportStar(require("./report-raw.type"), exports);
 __exportStar(require("./report-translated.type"), exports);
 __exportStar(require("./submission.type"), exports);
-__exportStar(require("./parsed-filings.type"), exports);
-__exportStar(require("./common.type"), exports);

package/build/types/parsed-filings.type.d.ts

@@ -67,6 +67,7 @@ export interface ExecutiveCompensation {
     name: string;
     position: string | null;
     year: number | null;
+    positionLevel: 'Executive' | 'Director';
     salaryDollars: number | null;
     bonusDollars: number | null;
     stockAwardDollars: number | null;
@@ -80,17 +81,155 @@ export interface Holder {
     shares: number | null;
     percentOfClass: string | null;
 }
-export interface Form4Data {
-    transactions: InsiderTransaction[];
-}
 export interface Form10KData {
     tables: TableData[];
 }
 export interface Form13GData {
-    holders: InstitutionalHolder[];
+    institutionalHolders: InstitutionalHolder[];
 }
 export interface FormDef14aData {
     executiveCompensation: ExecutiveCompensation[];
-    holders: Holder[];
+}
+export interface Form4Data {
+    schemaVersion: string;
+    documentType: string;
+    periodOfReport: string;
+    issuerCik: number;
+    issuerName: string;
+    issuerTradingSymbol: string;
+    notSubjectToSection16: boolean;
+    reportingOwners: ReportingOwner[];
+    aff10b5One: boolean;
+    nonDerivativeHolding: NonDerivativeHolding[];
+    nonDerivativeTransaction: NonDerivativeTransaction[];
+    derivativeHolding: DerivativeHolding[];
+    derivativeTransaction: DerivativeTransaction[];
+    footnotes: string[];
+    remarks: string;
+    signatureName: string;
+    signatureDate: string;
+}
+export interface DerivativeHolding {
+    securityTitle: string;
+    directOrIndirectOwnership: string;
+    natureOfOwnership: string | null;
+    sharesOwnedFollowingTransaction: number;
+    conversionOrExercisePrice: number | null;
+    exerciseDate: string | null;
+    expirationDate: string | null;
+    underlyingSecurityShares: number | null;
+    underlyingSecurityTitle: string | null;
+}
+export interface DerivativeTransaction {
+    securityTitle: string;
+    directOrIndirectOwnership: string;
+    natureOfOwnership: string | null;
+    sharesOwnedFollowingTransaction: number;
+    deemedExecutionDate: string | null;
+    equitySwapInvolved: boolean;
+    transactionShares: number;
+    transactionCode: string;
+    transactionFormType: string;
+    transactionDate: string;
+    transactionTimeliness: string | null;
+    transactionPricePerShare: number | null;
+    transactionAcquiredDisposedCode: string;
+    conversionOrExercisePrice: number | null;
+    exerciseDate: string | null;
+    expirationDate: string | null;
+    underlyingSecurityShares: number | null;
+    underlyingSecurityTitle: string | null;
+}
+export interface NonDerivativeHolding {
+    securityTitle: string;
+    directOrIndirectOwnership: string;
+    natureOfOwnership: string | null;
+    sharesOwnedFollowingTransaction: number;
+}
+export interface NonDerivativeTransaction {
+    securityTitle: string;
+    directOrIndirectOwnership: string;
+    natureOfOwnership: string | null;
+    sharesOwnedFollowingTransaction: number;
+    deemedExecutionDate: string | null;
+    equitySwapInvolved: boolean;
+    transactionShares: number;
+    transactionCode: string;
+    transactionFormType: string;
+    transactionDate: string;
+    transactionTimeliness: string | null;
+    transactionPricePerShare: number | null;
+    transactionAcquiredDisposedCode: string;
+}
+export interface ReportingOwner {
+    rptOwnerCity: string;
+    rptOwnerState: string;
+    rptOwnerStateDescription: string;
+    rptOwnerStreet1: string;
+    rptOwnerStreet2: string;
+    rptOwnerZipCode: string;
+    rptOwnerCik: number;
+    rptOwnerName: string;
+    isDirector: boolean;
+    isOfficer: boolean;
+    isTenPercentOwner: boolean;
+    isOther: boolean;
+}
+export interface Form13FData {
+    submissionType: string;
+    periodOfReport: string;
+    cik: number;
+    ccc: string;
+    form13FFileNumber: string;
+    liveTestFlag: string;
+    reportCalendarOrQuarter: string;
+    reportType: string;
+    confirmingCopyFlag: boolean;
+    overrideInternetFlag: boolean;
+    returnCopyFlag: boolean;
+    filingManager: FilingManager;
+    otherManagers: Manager[];
+    provideInfoForInstruction5: string;
+    signatureBlock: SignatureBlock;
+    otherManagers2: Manager[];
+    otherIncludedManagersCount: number;
+    tableEntryTotal: number;
+    tableValueTotal: number;
+    isConfidentialOmitted: boolean;
+    infoTable: InfoTable[];
+}
+export interface FilingManager {
+    name: string;
+    ns1City: string;
+    ns1StateOrCountry: string;
+    ns1Street1: string;
+    ns1ZipCode: string;
+}
+export interface InfoTable {
+    nameOfIssuer: string;
+    titleOfClass: string;
+    cusip: string;
+    value: number;
+    sharesOrPrincipalAmount: number;
+    isPrincipalAmount: boolean;
+    investmentDiscretion: string;
+    votingAuthoritySole: number;
+    votingAuthorityShared: number;
+    votingAuthorityNone: number;
+    otherManagers: number[];
+}
+export interface Manager {
+    sequenceNumber: number | null;
+    name: string;
+    form13FFileNumber: string;
+}
+export interface SignatureBlock {
+    city: string;
+    name: string;
+    phone: string;
+    signature: string;
+    signatureDate: string;
+    stateOrCountry: string;
+    title: string;
 }
 export {};

package/build/types/report-raw.type.d.ts

@@ -2,16 +2,13 @@
  * Contains all keys matched from the report, along with the added keys dateEnd, dateFiled, fiscalPeriod, fiscalYear.
  */
 export type ReportRaw = {
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | null;
     dateReport: string;
     dateFiled: string;
-    form: string;
-    isTTM: boolean;
-    frame: string;
-    taxonomy: string;
-    reportType: ReportType;
     fiscalPeriod: FiscalPeriod;
     fiscalYear: number;
+    splitRatio: number | null;
+    splitDate: string | null;
 };
 /**
  * QUARTERLY = 10-Q and 10-K forms for the quarter | ANNUAL = 10-K forms for the year |
@@ -19,5 +16,5 @@ export type ReportRaw = {
  *
  * for dei, see https://www.sec.gov/structureddata/announcement/osd-announcement-2212-new-2022q4-taxonomies
  */
-export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
+export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K';
 export type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';

package/build/types/report-translated.type.d.ts

@@ -4,8 +4,6 @@ export interface ReportTranslated {
     dateFiled: string;
     fiscalPeriod: FiscalPeriod;
     fiscalYear: number;
-    form: string;
-    isTTM: boolean;
     assetTotal: number | null;
     assetCurrent: number | null;
     assetCurrentCashEquivalents: number | null;
@@ -55,4 +53,5 @@ export interface ReportTranslated {
     cashFlowOperating: number | null;
     cashFlowDeferredTax: number | null;
     cashFlowWorkingCapitalNonCash: number | null;
+    splitRatio: number | null;
 }

package/build/types/submission.type.d.ts

@@ -53,11 +53,12 @@ export interface FilingListItemTranslated {
     primaryDocument: string;
     primaryDocDescription: string;
     url: string;
+    urlXml: string;
 }
-interface FilingList {
+export interface FilingList {
     recent: FilingListDetails;
     files: FileData[];
-    recentTranslated?: FilingListItemTranslated[];
+    recentTranslated: FilingListItemTranslated[];
 }
 export interface SubmissionList {
     cik: number;

package/build/util/calculation-map-by-ns.d.ts

@@ -0,0 +1,6 @@
+/**
+ * TODO: Add this.
+ *
+ *  @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
+ */
+export declare const calculationMapByNs: Record<string, Record<string, string[]>>;

package/build/util/calculation-map-by-ns.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculationMapByNs = void 0;
+/**
+ * TODO: Add this.
+ *
+ *  @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
+ */
+exports.calculationMapByNs = {};

package/build/util/key-translations.js

@@ -10,8 +10,6 @@ var keyTranslations = {
     dateFiled: ['dateFiled'],
     fiscalPeriod: ['fiscalPeriod'],
     fiscalYear: ['fiscalYear'],
-    form: ['form'],
-    isTTM: ['isTTM'],
     // ------------------------------- //
     assetTotal: ['Assets'],
     assetCurrent: ['AssetsCurrent', 'CurrentAssets'],
@@ -170,5 +168,6 @@ var keyTranslations = {
     cashFlowDeferredTax: ['DeferredIncomeTaxExpenseBenefit'],
     cashFlowWorkingCapitalNonCash: [],
     expenseStockCompensation: ['AllocatedShareBasedCompensationExpense'],
+    splitRatio: ['StockholdersEquityNoteStockSplitConversionRatio1'],
 };
 exports.default = keyTranslations;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.2.1",
+    "version": "0.2.2",
     "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
     "main": "build/index.js",
     "author": "Andrew Evers (https://github.com/andyevers)",
@@ -34,5 +34,8 @@
     },
     "files": [
         "build/**/*"
-    ]
+    ],
+    "dependencies": {
+        "fast-xml-parser": "^4.5.0"
+    }
 }