sec-edgar-api 0.0.1

package/build/util/key-translations.d.ts

@@ -0,0 +1,7 @@
+import { ReportTranslated } from '../types/report-translated.type';
+/**
+ * Checks if any of the array keys exist in the object to assign to the translated key
+ * These were checked against Yahoo Finance values, adding the ones that most often matched the yahoo values
+ */
+declare const keyTranslations: Record<keyof ReportTranslated, string[]>;
+export default keyTranslations;

package/build/util/key-translations.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Checks if any of the array keys exist in the object to assign to the translated key
+ * These were checked against Yahoo Finance values, adding the ones that most often matched the yahoo values
+ */
+var keyTranslations = {
+    // --- Added from ReportParser --- //
+    dateReport: ['dateReport'],
+    dateFiled: ['dateFiled'],
+    fiscalPeriod: ['fiscalPeriod'],
+    fiscalYear: ['fiscalYear'],
+    form: ['form'],
+    isTTM: ['isTTM'],
+    // ------------------------------- //
+    assetTotal: ['Assets'],
+    assetCurrent: ['AssetsCurrent', 'CurrentAssets'],
+    assetCurrentCashEquivalents: [
+        'CashAndCashEquivalentsAtCarryingValue',
+        'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents',
+        'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations',
+        'CashAndCashEquivalents',
+        'Cash',
+        'CashAndCashEquivalentsFairValueDisclosure',
+        'CashCashEquivalentsAndShortTermInvestments',
+        'CashAndCashEquivalentsAtCarryingValueIncludingDiscontinuedOperations',
+        'CashAndCashEquivalentsIfDifferentFromStatementOfFinancialPosition',
+        'CashAndDueFromBanks',
+        'CashAndBankBalancesAtCentralBanks',
+    ],
+    assetCurrentInvestments: [
+        'ShortTermInvestments',
+        'MarketableSecuritiesCurrent',
+        'AvailableForSaleSecuritiesDebtSecuritiesCurrent',
+        'AvailableForSaleSecuritiesDebtSecurities',
+        'OtherShortTermInvestments',
+        'AvailableForSaleSecuritiesDebtMaturitiesWithinOneYearFairValue',
+        'Investments',
+        'DebtSecuritiesAvailableForSaleExcludingAccruedInterestCurrent',
+        'SecuritiesPurchasedUnderAgreementsToResell',
+        'OtherCurrentFinancialAssets',
+        'EquitySecuritiesFvNi',
+        'MarketableSecurities',
+    ],
+    assetCurrentAccountsReceivable: [
+        'AccountsReceivableNetCurrent',
+        'ReceivablesNetCurrent',
+        'AccountsReceivableNet',
+        'AccountsNotesAndLoansReceivableNetCurrent',
+        'AccountsAndOtherReceivablesNetCurrent',
+    ],
+    assetCurrentInventory: [
+        'InventoryNet',
+        'Inventories',
+        'InventoryFinishedGoodsNetOfReserves',
+        'InventoryNetOfAllowancesCustomerAdvancesAndProgressBillings',
+        'InventoryGross',
+    ],
+    assetNonCurrent: ['AssetsNonCurrent', 'NonCurrentAssets'],
+    assetNonCurrentGoodwill: ['Goodwill'],
+    assetNonCurrentIntangibleLessGoodwill: ['IntangibleAssetsNetExcludingGoodwill'],
+    assetNonCurrentPPENet: [
+        'PropertyPlantAndEquipmentNet',
+        // 'PropertyPlantAndEquipmentGross',
+        'PropertyPlantAndEquipment',
+        'PropertyPlantAndEquipmentAndFinanceLeaseRightOfUseAssetAfterAccumulatedDepreciationAndAmortization',
+    ],
+    assetNonCurrentPPEGross: ['PropertyPlantAndEquipmentGross'],
+    assetNonCurrentInvestments: [
+        'LongTermInvestments',
+        'InvestmentsInAffiliatesSubsidiariesAssociatesAndJointVentures',
+        'EquityMethodInvestments',
+    ],
+    liabilityTotal: ['Liabilities'],
+    liabilityCurrent: ['LiabilitiesCurrent', 'CurrentLiabilities'],
+    liabilityCurrentAccountsPayable: [
+        'AccountsPayableCurrent',
+        'AccountsPayableTradeCurrent',
+        'AccountsPayableAndAccruedLiabilitiesCurrent',
+        'TradeAndOtherCurrentPayables',
+        'Deposits',
+        'AccountsPayableCurrentAndNoncurrent',
+        'AccountsPayableAndAccruedLiabilitiesCurrentAndNoncurrent',
+    ],
+    liabilityCurrentDebt: ['LongTermDebtCurrent', 'DebtCurrent', 'LongTermDebtAndCapitalLeaseObligationsCurrent'],
+    liabilityNonCurrent: ['LiabilitiesNonCurrent', 'NonCurrentLiabilities'],
+    liabilityNonCurrentDebt: [
+        'LongTermDebtNoncurrent',
+        'LongTermDebtAndCapitalLeaseObligations',
+        'LongTermDebt',
+        'UnsecuredLongTermDebt',
+        'DebtLongtermAndShorttermCombinedAmount',
+        'LongtermBorrowings',
+        'ConvertibleLongTermNotesPayable',
+        'LongTermNotesAndLoans',
+        'DebtAndCapitalLeaseObligations',
+    ],
+    equityTotal: [
+        'StockholdersEquity',
+        'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest',
+        'EquityAttributableToOwnersOfParent',
+    ],
+    equityRetainedEarnings: ['RetainedEarningsAccumulatedDeficit', 'RetainedEarnings'],
+    equityStockPreferred: [
+    // TODO: Add this
+    ],
+    sharesOutstanding: ['WeightedAverageNumberOfSharesOutstandingBasic', 'CommonStockSharesOutstanding'],
+    sharesOutstandingDiluted: ['WeightedAverageNumberOfDilutedSharesOutstanding'],
+    eps: ['EarningsPerShareBasic', 'EarningsPerShareBasicAndDiluted'],
+    epsDiluted: ['EarningsPerShareDiluted', 'EarningsPerShareBasicAndDiluted'],
+    ebit: ['OperatingIncomeLoss'],
+    ebitda: [],
+    profitGross: ['GrossProfit'],
+    revenueTotal: [
+        // 'RevenueFromContractWithCustomerExcludingAssessedTax',
+        'RevenueFromContractWithCustomerExcludingAssessedTax',
+        'Revenues',
+        'RevenueFromContractWithCustomerIncludingAssessedTax',
+        'Revenue',
+    ],
+    revenueCost: ['CostOfGoodsAndServicesSold', 'CostOfRevenue', 'CostOfServices'],
+    revenueOperating: [
+        'OperatingIncomeLoss',
+        'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest',
+        'ProfitLossBeforeTax',
+    ],
+    expenseTotal: ['CostsAndExpenses'],
+    expenseOperating: ['OperatingExpenses', 'CostsAndExpenses'],
+    expenseResearchDevelopment: [
+        'ResearchAndDevelopmentExpense',
+        'ResearchAndDevelopmentExpenseExcludingAcquiredInProcessCost',
+        'ResearchAndDevelopmentExpenseSoftwareExcludingAcquiredInProcessCost',
+    ],
+    expenseInterest: [
+        'InterestIncomeExpenseNet',
+        'InterestExpense',
+        'InterestIncomeExpenseNonoperatingNet',
+        'InterestRevenueExpenseNet',
+    ],
+    expenseDepreciation: [
+        'DepreciationDepletionAndAmortization',
+        'DepreciationAndAmortization',
+        'DepreciationAndAmortisationExpense',
+        'DepreciationAmortizationAndAccretionNet',
+        'Depreciation',
+        'AdjustmentsForDepreciationAndAmortisationExpense',
+        'AmortisationExpense',
+    ],
+    expenseDepreciationAccumulated: ['AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment'],
+    expenseTax: ['IncomeTaxExpenseBenefit', 'IncomeTaxExpenseContinuingOperations'],
+    expenseNonCashOther: ['OtherNoncashIncomeExpense'],
+    incomeOperating: [
+        'OperatingIncomeLoss',
+        'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest',
+        'ProfitLossBeforeTax',
+    ],
+    incomeNet: [
+        'NetIncomeLoss',
+        'NetIncomeLossAvailableToCommonStockholdersBasic',
+        'ProfitLoss',
+        'NetIncomeLossAvailableToCommonStockholdersDiluted',
+        'IncomeLossFromContinuingOperations',
+        'ProfitLossAttributableToOwnersOfParent',
+    ],
+    cashFlowFree: [],
+    cashFlowDividendsPaid: ['PaymentsOfDividendsCommonStock', 'PaymentsOfDividends'],
+    cashFlowDividendsPaidPreferred: ['DividendsPreferredStock'],
+    cashFlowCapex: ['PaymentsToAcquirePropertyPlantAndEquipment'],
+    cashFlowOperating: ['NetCashProvidedByUsedInOperatingActivities'],
+    cashFlowDeferredTax: ['DeferredIncomeTaxExpenseBenefit'],
+    cashFlowWorkingCapitalNonCash: [],
+    expenseStockCompensation: ['AllocatedShareBasedCompensationExpense'],
+};
+exports.default = keyTranslations;

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "sec-edgar-api",
+    "version": "0.0.1",
+    "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
+    "main": "index.js",
+    "author": "Andrew Evers (https://github.com/andyevers)",
+    "homepage": "https://github.com/andyevers/sec-edgar-api#readme",
+    "license": "ISC",
+    "dependencies": {
+        "unzipper": "^0.10.14"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/andyevers/sec-edgar-api.git"
+    },
+    "scripts": {
+        "test": "jest test",
+        "build": "tsc"
+    },
+    "keywords": [
+        "sec",
+        "edgar",
+        "api",
+        "stock",
+        "financial",
+        "analysis",
+        "earnings",
+        "reports"
+    ],
+    "devDependencies": {
+        "@types/jest": "^29.5.2",
+        "@types/unzipper": "^0.10.6",
+        "jest": "^29.5.0",
+        "prettier": "^2.8.8",
+        "ts-jest": "^29.1.0",
+        "typescript": "^5.1.3"
+    },
+    "files": [
+        "build/**/*"
+    ]
+}