sec-edgar-api 0.2.1 → 0.2.2

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -38,9 +49,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var cik_by_symbol_1 = require("../../util/cik-by-symbol");
 var Client_1 = require("../Client");
-var DocumentParser_1 = require("../DocumentParser");
+var parsers_1 = require("../DocumentParser/parsers");
 var ReportParser_1 = require("../ReportParser");
-var RequestWrapper_1 = require("./RequestWrapper");
 var Throttler_1 = require("./Throttler");
 /**
  * Gets reports from companies filed with the SEC
@@ -54,14 +64,14 @@ var SecEdgarApi = /** @class */ (function () {
             throttler: new Throttler_1.default(),
             cikBySymbol: cik_by_symbol_1.default,
             reportParser: new ReportParser_1.default(),
-            documentParser: new DocumentParser_1.default(),
+            parsers: parsers_1.default,
         }; }
-        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol, reportParser = args.reportParser, documentParser = args.documentParser;
+        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol, reportParser = args.reportParser, parsers = args.parsers;
         this.client = client;
         this.throttler = throttler;
         this.cikBySymbol = cikBySymbol;
         this.reportParser = reportParser;
-        this.documentParser = documentParser;
+        this.parsers = parsers;
         this.baseUrlEdgar = 'https://data.sec.gov';
         this.baseUrlSec = 'https://www.sec.gov';
     }
@@ -120,19 +130,77 @@ var SecEdgarApi = /** @class */ (function () {
         }
         for (var _i = 0, filings_1 = filings; _i < filings_1.length; _i++) {
             var filing = filings_1[_i];
-            var accessionStr = filing.accessionNumber.replace(/-/g, '');
+            var accessionStrTrimmed = filing.accessionNumber.replace(/-/g, '');
             var primaryDocument = filing.primaryDocument;
-            filing.url = "https://www.sec.gov/Archives/edgar/data/".concat(Number(cik), "/").concat(accessionStr, "/").concat(primaryDocument);
+            var urlPrefix = "".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(Number(cik), "/").concat(accessionStrTrimmed);
+            filing.url = "".concat(urlPrefix, "/").concat(primaryDocument);
+            filing.urlXml = "".concat(urlPrefix, "/").concat(filing.accessionNumber, ".txt");
         }
         return filings;
     };
-    SecEdgarApi.prototype.getCreateRequestSubmissions = function (params, forms) {
-        var symbol = params.symbol, filings = params.filings, _a = params.cutoffDate, cutoffDate = _a === void 0 ? new Date('1970-01-01') : _a;
-        var cik = this.getCikString(symbol);
-        var filingsArr = Array.isArray(filings) ? filings : this.mapFilingListDetails(cik, filings);
-        return filingsArr.filter(function (_a) {
-            var form = _a.form, filingDate = _a.filingDate;
-            return forms.includes(form) && new Date(filingDate).getTime() > cutoffDate.getTime();
+    SecEdgarApi.prototype.filterSubmissionsInFiscalPeriodAsc = function (params) {
+        var fiscalYearEndMonth = params.fiscalYearEndMonth, fiscalPeriod = params.fiscalPeriod, year = params.fiscalYear, submissions = params.submissions;
+        var monthByFiscalPeriod = {
+            Q1: (fiscalYearEndMonth + 3) % 12,
+            Q2: (fiscalYearEndMonth + 6) % 12,
+            Q3: (fiscalYearEndMonth + 9) % 12,
+            Q4: fiscalYearEndMonth,
+            FY: fiscalYearEndMonth,
+        };
+        var monthNum = monthByFiscalPeriod[fiscalPeriod] === 0 ? 12 : monthByFiscalPeriod[fiscalPeriod];
+        var monthStr = monthNum.toString().padStart(2, '0');
+        var isNextYear = monthByFiscalPeriod[fiscalPeriod] > fiscalYearEndMonth + 2;
+        var fiscalYear = isNextYear ? year + 1 : year;
+        var dateSearch = new Date("".concat(fiscalYear, "-").concat(monthStr, "-28"));
+        var submissionsFiltered = submissions.filter(function (sub) {
+            var subDate = new Date(sub.reportDate);
+            var isWithin60DaysAfter = subDate.getTime() - dateSearch.getTime() < 1000 * 60 * 60 * 24 * 60;
+            var isWIthin30DaysBefore = dateSearch.getTime() - subDate.getTime() < 86400000 * 30;
+            return isWithin60DaysAfter && isWIthin30DaysBefore;
+        });
+        submissionsFiltered.sort(function (a, b) { return new Date(a.filingDate).getTime() - new Date(b.filingDate).getTime(); });
+        return submissionsFiltered;
+    };
+    SecEdgarApi.prototype.extractSubmissionsWithXml = function (data) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var symbol, subs, documentXml, getSubmissionUrl, xml, url, submissions, submissionList, _c, recent, recentTranslated, providedSubmissions, _d, _e;
+            return __generator(this, function (_f) {
+                switch (_f.label) {
+                    case 0:
+                        symbol = data.symbol, subs = data.submissions, documentXml = data.documentXml, getSubmissionUrl = data.getSubmissionUrl;
+                        xml = documentXml !== null && documentXml !== void 0 ? documentXml : null;
+                        url = null;
+                        submissions = [];
+                        submissionList = subs !== null && subs !== void 0 ? subs : null;
+                        if (!!xml) return [3 /*break*/, 7];
+                        _c = (_a = subs === null || subs === void 0 ? void 0 : subs.filings) !== null && _a !== void 0 ? _a : {}, recent = _c.recent, recentTranslated = _c.recentTranslated;
+                        providedSubmissions = recentTranslated !== null && recentTranslated !== void 0 ? recentTranslated : (recent ? this.mapFilingListDetails(symbol, recent) : null);
+                        if (!(subs !== null && subs !== void 0)) return [3 /*break*/, 1];
+                        _d = subs;
+                        return [3 /*break*/, 3];
+                    case 1: return [4 /*yield*/, this.getSubmissions({ symbol: symbol })];
+                    case 2:
+                        _d = (_f.sent());
+                        _f.label = 3;
+                    case 3:
+                        submissionList = _d;
+                        submissions = (_b = providedSubmissions !== null && providedSubmissions !== void 0 ? providedSubmissions : submissionList.filings.recentTranslated) !== null && _b !== void 0 ? _b : [];
+                        url = getSubmissionUrl(submissions, submissionList);
+                        if (!url) return [3 /*break*/, 5];
+                        return [4 /*yield*/, this.getDocumentXMLByUrl({ url: url })];
+                    case 4:
+                        _e = _f.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
+                        _e = null;
+                        _f.label = 6;
+                    case 6:
+                        xml = _e;
+                        _f.label = 7;
+                    case 7: return [2 /*return*/, { xml: xml, url: url, submissions: submissions, submissionList: submissionList }];
+                }
+            });
         });
     };
     /**
@@ -158,18 +226,16 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getSubmissions = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, includeTranslated, cik, submissions;
+            var symbol, cik, submissions;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        symbol = params.symbol, includeTranslated = params.includeTranslated;
+                        symbol = params.symbol;
                         cik = this.getCikString(symbol);
                         return [4 /*yield*/, this.request("".concat(this.baseUrlEdgar, "/submissions/CIK").concat(cik, ".json"))];
                     case 1:
                         submissions = _a.sent();
                         submissions.cik = Number(submissions.cik);
-                        if (!includeTranslated)
-                            return [2 /*return*/, submissions];
                         submissions.filings.recentTranslated = this.mapFilingListDetails(cik, submissions.filings.recent);
                         return [2 /*return*/, submissions];
                 }
@@ -325,7 +391,8 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response. (response.filings.recent or response.filings.recentTranslated)
+     * Gets a raw xml document string. the parameters are found in the submission list response.
+     * (response.filings.recent or response.filings.recentTranslated)
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -335,11 +402,12 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getDocumentXML = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var accessionNumber, primaryDocument, symbol, cik;
+            var accessionNumber, primaryDocument, symbol, cik, document;
             return __generator(this, function (_a) {
                 accessionNumber = params.accessionNumber, primaryDocument = params.primaryDocument, symbol = params.symbol;
                 cik = this.cikBySymbol[symbol];
-                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(cik, "/").concat(accessionNumber.replace(/-/g, ''), "/").concat(primaryDocument), true)];
+                document = primaryDocument !== null && primaryDocument !== void 0 ? primaryDocument : "".concat(accessionNumber, ".txt");
+                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(cik, "/").concat(accessionNumber.replace(/-/g, ''), "/").concat(document), true)];
             });
         });
     };
@@ -360,123 +428,193 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * Used for getting insider transactions. extracts insider transaction urls from submission list response, and parses the xml doc.
+     * Used for getting security holdings.
+     *
+     * Forms: 13F, 13F/A, 13F-HR, 13F-HR/A
      *
-     * ```ts
-     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * Extracts holdings urls from submission list response, and parses the xml doc.
      *
-     * const transactions1 = (await requestWrapper.requestNext()).result.transactions // array of transactions from most recent doc
-     * const transactions2 = (await requestWrapper.requestNext()).result.transactions // array of transactions from second most recent doc
-     * ```
+     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
+     *
+     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
      */
-    SecEdgarApi.prototype.createRequestInsiderTransactions = function (params) {
-        var _this = this;
-        var submissions = this.getCreateRequestSubmissions(params, ['4', '4/A', '5', '5/A']);
-        var options = { maxRequests: params.maxRequests };
-        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
-            var _a, _b;
-            var _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+    SecEdgarApi.prototype.getHoldings = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fiscalPeriod, fiscalYear, lookback, _a, submissions, url, xml, holdingsForm;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseForm4;
-                        _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
-                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                        fiscalPeriod = params.fiscalPeriod, fiscalYear = params.fiscalYear, lookback = params.lookback;
+                        if (!((fiscalPeriod && fiscalYear) || typeof lookback === 'number')) {
+                            throw new Error('you must provide either both fiscalPeriod & fiscalYear, or just lookback');
+                        }
+                        return [4 /*yield*/, this.extractSubmissionsWithXml(__assign(__assign({}, params), { getSubmissionUrl: function (subs, submissionList) {
+                                    var _a;
+                                    var submissions = subs.filter(function (sub) { return sub === null || sub === void 0 ? void 0 : sub.form.startsWith('13F'); });
+                                    var submission = submissions[Number(lookback)];
+                                    if (fiscalPeriod && fiscalYear) {
+                                        var submissionsInPeriod = _this.filterSubmissionsInFiscalPeriodAsc({
+                                            fiscalYearEndMonth: Number(submissionList.fiscalYearEnd.substring(0, 2)),
+                                            fiscalPeriod: fiscalPeriod,
+                                            fiscalYear: fiscalYear,
+                                            submissions: submissions,
+                                        });
+                                        submission = submissionsInPeriod[0];
+                                    }
+                                    return (_a = submission === null || submission === void 0 ? void 0 : submission.urlXml) !== null && _a !== void 0 ? _a : null;
+                                } }))];
+                    case 1:
+                        _a = _b.sent(), submissions = _a.submissions, url = _a.url, xml = _a.xml;
+                        holdingsForm = xml ? this.parsers.parseForm13f({ xml: xml }) : null;
+                        return [2 /*return*/, { url: url, holdingsForm: holdingsForm, submissions: submissions }];
                 }
             });
-        }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        });
     };
     /**
-     * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
+     * Gets institutional holders that have a large stake in the company.
+     * If multiple submissions are found within the fiscal period, uses the first submission.
+     *
+     * Forms: SC 13G, SC 13G/A
      *
-     * ```ts
-     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequestInstitutionalHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
      *
-     * const holders1 = (await requestWrapper.requestNext()).result.holders // array of holders from most recent doc
-     * const holders2 = (await requestWrapper.requestNext()).result.holders // array of holders from second most recent doc
-     * ```
+     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
      */
-    SecEdgarApi.prototype.createRequestInstitutionalHolders = function (params) {
-        var _this = this;
-        var submissions = this.getCreateRequestSubmissions(params, ['SC 13G', 'SC 13G/A']);
-        var options = { maxRequests: params.maxRequests };
-        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
-            var _a, _b;
-            var _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+    SecEdgarApi.prototype.getInstitutionalHolders = function (params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var fiscalPeriod, fiscalYear, lookback, _b, submissions, url, xml, response;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseForm13g;
-                        _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
-                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                        fiscalPeriod = params.fiscalPeriod, fiscalYear = params.fiscalYear, lookback = params.lookback;
+                        if (!((fiscalPeriod && fiscalYear) || typeof lookback === 'number')) {
+                            throw new Error('you must provide either both fiscalPeriod & fiscalYear, or just lookback');
+                        }
+                        return [4 /*yield*/, this.extractSubmissionsWithXml(__assign(__assign({}, params), { getSubmissionUrl: function (subs, submissionList) {
+                                    var _a;
+                                    var submissions = subs.filter(function (sub) { var _a; return ['SC 13G', 'SC 13G/A'].includes(sub.form) && !((_a = sub.url) === null || _a === void 0 ? void 0 : _a.endsWith('.txt')); });
+                                    var submission = submissions[Number(lookback)];
+                                    if (fiscalPeriod && fiscalYear) {
+                                        var submissionsInPeriod = _this.filterSubmissionsInFiscalPeriodAsc({
+                                            fiscalYearEndMonth: Number(submissionList.fiscalYearEnd.substring(0, 2)),
+                                            fiscalPeriod: fiscalPeriod,
+                                            fiscalYear: fiscalYear,
+                                            submissions: submissions,
+                                        });
+                                        submission = submissionsInPeriod[0];
+                                    }
+                                    return (_a = submission === null || submission === void 0 ? void 0 : submission.url) !== null && _a !== void 0 ? _a : null;
+                                } }))];
+                    case 1:
+                        _b = _c.sent(), submissions = _b.submissions, url = _b.url, xml = _b.xml;
+                        response = xml ? this.parsers.parseForm13g({ xml: xml }) : null;
+                        return [2 /*return*/, { url: url, institutionalHolders: (_a = response === null || response === void 0 ? void 0 : response.institutionalHolders) !== null && _a !== void 0 ? _a : [], submissions: submissions }];
                 }
             });
-        }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        });
     };
     /**
-     * Used for getting earnings report tables from submission files.
+     * Gets executive compensation from the proxy statement.
+     *
+     * Forms: DEF 14A
      *
-     * ```ts
-     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
      *
-     * const tables1 = (await requestWrapper.requestNext()).result.tables // array of tables from most recent doc
-     * const tables2 = (await requestWrapper.requestNext()).result.tables // array of tables from second most recent doc
-     * ```
+     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
      */
-    SecEdgarApi.prototype.createRequestEarningsReports = function (params) {
-        var _this = this;
-        var submissions = this.getCreateRequestSubmissions(params, ['10-Q', '10-Q/A', '10-K', '10-K/A']);
-        var options = { maxRequests: params.maxRequests };
-        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
-            var _a, _b;
-            var _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+    SecEdgarApi.prototype.getExecutivesCompensation = function (params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var fiscalYear, lookback, _b, submissions, url, xml, response;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseForm10k;
-                        _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
-                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                        fiscalYear = params.fiscalYear, lookback = params.lookback;
+                        if (!(fiscalYear || typeof lookback === 'number')) {
+                            throw new Error('you must provide either both fiscalYear or lookback');
+                        }
+                        return [4 /*yield*/, this.extractSubmissionsWithXml(__assign(__assign({}, params), { getSubmissionUrl: function (subs, submissionList) {
+                                    var _a;
+                                    var submissions = subs.filter(function (sub) { var _a; return sub.form === 'DEF 14A' && !((_a = sub.url) === null || _a === void 0 ? void 0 : _a.endsWith('.txt')); });
+                                    // console.log('subs', submissions)
+                                    var submission = submissions[Number(lookback) || 0];
+                                    if (fiscalYear) {
+                                        var submissionsInPeriod = _this.filterSubmissionsInFiscalPeriodAsc({
+                                            fiscalYearEndMonth: Number(submissionList.fiscalYearEnd.substring(0, 2)),
+                                            fiscalPeriod: 'Q4',
+                                            fiscalYear: fiscalYear,
+                                            submissions: submissions,
+                                        });
+                                        submission = submissionsInPeriod[0];
+                                    }
+                                    return (_a = submission === null || submission === void 0 ? void 0 : submission.url) !== null && _a !== void 0 ? _a : null;
+                                } }))];
+                    case 1:
+                        _b = _c.sent(), submissions = _b.submissions, url = _b.url, xml = _b.xml;
+                        response = xml ? this.parsers.parseFormDef14a({ xml: xml }) : null;
+                        return [2 /*return*/, { url: url, executiveCompensation: (_a = response === null || response === void 0 ? void 0 : response.executiveCompensation) !== null && _a !== void 0 ? _a : [], submissions: submissions }];
                 }
             });
-        }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        });
     };
     /**
-     * Proxy statement includes list of holders, executiveCompensation, and other tables. returns FormDef14aData
+     * Gets insider transactions - when a company's executives buy or sell shares, options, or other securities in the company.
      *
-     * ```ts
-     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequesProxyStatement({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * Forms: 4, 4/A, 5, 5/A
      *
-     * const { holders, executiveCompensation } = (await requestWrapper.requestNext()).result
-     * ```
+     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
+     *
+     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
      */
-    SecEdgarApi.prototype.createRequestProxyStatement = function (params) {
-        var _this = this;
-        var submissions = this.getCreateRequestSubmissions(params, ['DEF 14A']);
-        var options = { maxRequests: params.maxRequests };
-        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
-            var _a, _b;
-            var _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+    SecEdgarApi.prototype.getInsiderTransaction = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var lookback, _a, submissions, url, xml, insiderTransaction;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseFormDef14a;
-                        _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
-                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                        lookback = params.lookback;
+                        return [4 /*yield*/, this.extractSubmissionsWithXml(__assign(__assign({}, params), { getSubmissionUrl: function (subs) {
+                                    var _a, _b;
+                                    var submissions = subs.filter(function (sub) { return ['4', '4/A', '5', '5/A'].includes(sub.form); });
+                                    return (_b = (_a = submissions[lookback]) === null || _a === void 0 ? void 0 : _a.urlXml) !== null && _b !== void 0 ? _b : null;
+                                } }))];
+                    case 1:
+                        _a = _b.sent(), submissions = _a.submissions, url = _a.url, xml = _a.xml;
+                        insiderTransaction = xml ? this.parsers.parseForm4({ xml: xml }) : null;
+                        return [2 /*return*/, { url: url, insiderTransaction: insiderTransaction, submissions: submissions }];
+                }
+            });
+        });
+    };
+    /**
+     * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
+     */
+    SecEdgarApi.prototype.getCurrentFilings = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, taxonomy, urlByTaxonomy, url, xml;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = (params !== null && params !== void 0 ? params : {}).taxonomy, taxonomy = _a === void 0 ? 'allXbrl' : _a;
+                        urlByTaxonomy = {
+                            usGaap: 'https://www.sec.gov/Archives/edgar/usgaap.rss.xml',
+                            mutualFund: 'https://www.sec.gov/Archives/edgar/xbrl-rr.rss.xml',
+                            inlineXbrl: 'https://www.sec.gov/Archives/edgar/xbrl-inline.rss.xml',
+                            allXbrl: 'https://www.sec.gov/Archives/edgar/xbrlrss.all.xml',
+                        };
+                        url = urlByTaxonomy[taxonomy] || urlByTaxonomy.allXbrl;
+                        return [4 /*yield*/, this.request(url, true)];
+                    case 1:
+                        xml = _b.sent();
+                        return [2 /*return*/, xml ? this.parsers.parseCurrentFilings({ xml: xml }) : null];
                 }
             });
-        }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        });
     };
     return SecEdgarApi;
 }());

package/build/types/current-filings-xml.type.d.ts

@@ -0,0 +1,74 @@
+export interface CurrentFilingsXML {
+    '?xml': XML;
+    rss: RSSXML;
+}
+interface XML {
+    '@_version': string;
+    '@_encoding': string;
+}
+interface RSSXML {
+    channel: ChannelXML;
+    '@_version': string;
+}
+interface ChannelXML {
+    title: string;
+    link: string;
+    'atom:link': AtomLinkXML;
+    description: string;
+    language: string;
+    pubDate: string;
+    lastBuildDate: string;
+    item: ItemXML[];
+}
+interface AtomLinkXML {
+    '@_href': string;
+    '@_rel': string;
+    '@_type': string;
+    '@_xmlns:atom': string;
+}
+interface ItemXML {
+    title: string;
+    link: string;
+    guid: string;
+    enclosure: EnclosureXML;
+    description: string;
+    pubDate: string;
+    'edgar:xbrlFiling': EdgarXbrlFilingXML;
+}
+interface EdgarXbrlFilingXML {
+    'edgar:companyName': string;
+    'edgar:formType': string;
+    'edgar:filingDate': string;
+    'edgar:cikNumber': number;
+    'edgar:accessionNumber': string;
+    'edgar:fileNumber': string;
+    'edgar:acceptanceDatetime': number;
+    'edgar:period'?: number;
+    'edgar:assistantDirector'?: string;
+    'edgar:assignedSic'?: number;
+    'edgar:fiscalYearEnd'?: number;
+    'edgar:xbrlFiles': EdgarXbrlFilesXML;
+    '@_xmlns:edgar': string;
+    'edgar:otherCikNumbers'?: number | string;
+}
+interface EdgarXbrlFilesXML {
+    'edgar:xbrlFile': EdgarXbrlFileXML[];
+}
+interface EdgarXbrlFileXML {
+    '@_edgar:sequence': string;
+    '@_edgar:file': string;
+    '@_edgar:type': string;
+    '@_edgar:size': string;
+    '@_edgar:description': string;
+    '@_edgar:inlineXBRL'?: string;
+    '@_edgar:url': string;
+}
+interface EnclosureXML {
+    '@_url': string;
+    '@_length': string;
+    '@_type': Type;
+}
+declare enum Type {
+    ApplicationZip = "application/zip"
+}
+export {};

package/build/types/current-filings-xml.type.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Type;
+(function (Type) {
+    Type["ApplicationZip"] = "application/zip";
+})(Type || (Type = {}));

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

@@ -0,0 +1,44 @@
+export interface CurrentFilingsList {
+    title: string;
+    link: string;
+    href: string;
+    description: string;
+    language: string;
+    pubDate: string;
+    lastBuildDate: string;
+    items: CurrentFiling[];
+}
+export interface CurrentFiling {
+    title: string;
+    link: string;
+    guid: string;
+    enclosureUrl: string;
+    enclosureLength: string;
+    enclosureType: string;
+    description: string;
+    pubDate: string;
+    filing: Filing;
+}
+export interface Filing {
+    companyName: string;
+    formType: string;
+    filingDate: string;
+    cikNumber: number;
+    accessionNumber: string;
+    fileNumber: string;
+    acceptanceDatetime: string;
+    period: string;
+    assistantDirector: string;
+    assignedSic: number;
+    fiscalYearEnd: string;
+    xbrlFiles: XbrlFile[];
+}
+export interface XbrlFile {
+    sequence: number;
+    file: string;
+    type: string;
+    size: number;
+    description: string;
+    inlineXBRL: boolean;
+    url: string;
+}

package/build/types/current-filings.type.js

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