sec-edgar-api 0.3.0 → 0.3.2

package/build/services/DocumentParser/DocumentParser.d.ts

@@ -13,5 +13,17 @@ export default class DocumentParser {
     parseForm13g(params: XMLParams): import("../../types").Form13GData;
     parseForm10k(params: XMLParams): import("../../types").Form10KData;
     parseFormDef14a(params: XMLParams): import("../../types").FormDef14aData;
+    parseCurrentFilingsDaily(params: XMLParams): {
+        date: string;
+        matchCount: number;
+        totalCount: number;
+        entries: {
+            accessionNumber: string;
+            form: string;
+            companyCik: number;
+            companyName: string;
+            filedDate: string;
+        }[];
+    };
 }
 export {};

package/build/services/DocumentParser/DocumentParser.js

@@ -20,6 +20,9 @@ var DocumentParser = /** @class */ (function () {
     DocumentParser.prototype.parseFormDef14a = function (params) {
         return this.parsersByName.parseFormDef14a(params, this.parser);
     };
+    DocumentParser.prototype.parseCurrentFilingsDaily = function (params) {
+        return this.parsersByName.parseCurrentFilingsDaily(params);
+    };
     return DocumentParser;
 }());
 exports.default = DocumentParser;

package/build/services/DocumentParser/parsers/index.d.ts

@@ -2,10 +2,12 @@ import { parseForm4 } from './parse-form-4';
 import { parseForm13g } from './parse-form-13g';
 import { parseForm10k } from './parse-form-10k';
 import { parseFormDef14a } from './parse-form-def14a';
+import { parseCurrentFilingsDaily } from './parse-current-filings-daily';
 declare const parsers: {
     parseForm4: typeof parseForm4;
     parseForm13g: typeof parseForm13g;
     parseForm10k: typeof parseForm10k;
     parseFormDef14a: typeof parseFormDef14a;
+    parseCurrentFilingsDaily: typeof parseCurrentFilingsDaily;
 };
 export default parsers;

package/build/services/DocumentParser/parsers/index.js

@@ -4,10 +4,12 @@ var parse_form_4_1 = require("./parse-form-4");
 var parse_form_13g_1 = require("./parse-form-13g");
 var parse_form_10k_1 = require("./parse-form-10k");
 var parse_form_def14a_1 = require("./parse-form-def14a");
+var parse_current_filings_daily_1 = require("./parse-current-filings-daily");
 var parsers = {
     parseForm4: parse_form_4_1.parseForm4,
     parseForm13g: parse_form_13g_1.parseForm13g,
     parseForm10k: parse_form_10k_1.parseForm10k,
     parseFormDef14a: parse_form_def14a_1.parseFormDef14a,
+    parseCurrentFilingsDaily: parse_current_filings_daily_1.parseCurrentFilingsDaily,
 };
 exports.default = parsers;

package/build/services/DocumentParser/parsers/parse-current-filings-daily.d.ts

@@ -0,0 +1,13 @@
+import { XMLParams } from '../../../types';
+export declare function parseCurrentFilingsDaily(params: XMLParams): {
+    date: string;
+    matchCount: number;
+    totalCount: number;
+    entries: {
+        accessionNumber: string;
+        form: string;
+        companyCik: number;
+        companyName: string;
+        filedDate: string;
+    }[];
+};

package/build/services/DocumentParser/parsers/parse-current-filings-daily.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCurrentFilingsDaily = void 0;
+function parseCurrentFilingsDaily(params) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    var xml = params.xml;
+    var csv = (_a = xml.split('<hr>')[1]) !== null && _a !== void 0 ? _a : '';
+    var lines = csv.split('\n').slice(0, -1);
+    var _k = (_b = xml.match(/<strong>.{1,20}?<\/strong>/g)) !== null && _b !== void 0 ? _b : [], _l = _k[0], matchHtml = _l === void 0 ? '' : _l, _m = _k[1], totalHtml = _m === void 0 ? '' : _m;
+    var date = (_e = (_d = (_c = xml.split('of matches for')) === null || _c === void 0 ? void 0 : _c[1].split('is', 1)) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.trim();
+    var matchCount = Number((_g = (_f = matchHtml.split('>')[1]) === null || _f === void 0 ? void 0 : _f.split('<')[0]) === null || _g === void 0 ? void 0 : _g.trim()) || 0;
+    var totalCount = Number((_j = (_h = totalHtml.split('>')[1]) === null || _h === void 0 ? void 0 : _h.split('<')[0]) === null || _j === void 0 ? void 0 : _j.trim()) || 0;
+    var entries = lines.map(function (line) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+        var parts = line.split('<a ');
+        var partDate = (_a = parts[0]) !== null && _a !== void 0 ? _a : '';
+        var partNameCik = (_b = parts[parts.length - 1]) !== null && _b !== void 0 ? _b : '';
+        var partAccessionForm = (_f = (_e = (_d = ((_c = parts[1]) !== null && _c !== void 0 ? _c : '').split('/Archives/edgar/data/')[1]) === null || _d === void 0 ? void 0 : _d.split('/')) === null || _e === void 0 ? void 0 : _e[1]) !== null && _f !== void 0 ? _f : '';
+        var partNameCikParts = partNameCik.split('</a>');
+        var _q = partAccessionForm === null || partAccessionForm === void 0 ? void 0 : partAccessionForm.split('>'), accession = _q[0], formUnfiltered = _q[1];
+        var accessionNumber = ((_g = accession === null || accession === void 0 ? void 0 : accession.substring(0, accession.lastIndexOf('-'))) !== null && _g !== void 0 ? _g : '').trim();
+        var form = ((_h = formUnfiltered === null || formUnfiltered === void 0 ? void 0 : formUnfiltered.replace(/</g, '')) !== null && _h !== void 0 ? _h : '').trim();
+        var companyCik = Number((_l = (_k = (_j = partNameCikParts[0]) === null || _j === void 0 ? void 0 : _j.split('>')[1]) === null || _k === void 0 ? void 0 : _k.trim()) !== null && _l !== void 0 ? _l : '');
+        var companyName = (_o = (_m = partNameCikParts[1]) === null || _m === void 0 ? void 0 : _m.trim()) !== null && _o !== void 0 ? _o : '';
+        var filedDate = (_p = partDate.trim()) !== null && _p !== void 0 ? _p : '';
+        var _r = filedDate.split('-'), month = _r[0], day = _r[1], year = _r[2];
+        return {
+            accessionNumber: accessionNumber,
+            form: form,
+            companyCik: companyCik,
+            companyName: companyName,
+            filedDate: "".concat(year, "-").concat(month, "-").concat(day),
+        };
+    });
+    return { date: date, matchCount: matchCount, totalCount: totalCount, entries: entries };
+}
+exports.parseCurrentFilingsDaily = parseCurrentFilingsDaily;

package/build/services/ReportParser/ReportParser.d.ts

@@ -20,7 +20,10 @@ export default class ReportParser {
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
-    parseReportsFromRaw(reportsRaw: ReportRaw[], usePropertyResolver?: boolean): ReportWrapper[];
+    parseReportsFromRaw(params: {
+        reportsRaw: ReportRaw[];
+        usePropertyResolver?: boolean;
+    }): ReportWrapper[];
     /**
      * Parse raw reports
      *

package/build/services/ReportParser/ReportParser.js

@@ -17,8 +17,8 @@ var ReportParser = /** @class */ (function () {
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
-    ReportParser.prototype.parseReportsFromRaw = function (reportsRaw, usePropertyResolver) {
-        if (usePropertyResolver === void 0) { usePropertyResolver = true; }
+    ReportParser.prototype.parseReportsFromRaw = function (params) {
+        var reportsRaw = params.reportsRaw, _a = params.usePropertyResolver, usePropertyResolver = _a === void 0 ? true : _a;
         var reportByYearQuarter = new Map();
         var reportsRawFiltered = reportsRaw;
         this.translateReportsRaw(reportsRawFiltered, function (report, reportRaw) {

package/build/services/ReportRawBuilder/FactPeriodResolver.js

@@ -35,7 +35,8 @@ var FactPeriodResolver = /** @class */ (function () {
      */
     FactPeriodResolver.isAverageShares = function (params) {
         var propertyName = params.propertyName;
-        return propertyName.includes('WeightedAverage') && propertyName.includes('SharesOutstanding');
+        return (propertyName.includes('Average') &&
+            (propertyName.includes('SharesOutstanding') || propertyName.includes('SharesIssued')));
     };
     FactPeriodResolver.prototype.isAverageShares = function (params) {
         return FactPeriodResolver.isAverageShares(params);

package/build/services/SecEdgarApi/SecEdgarApi.d.ts

@@ -1,4 +1,4 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
+import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
@@ -57,11 +57,6 @@ export interface GetDocumentXMLParams {
     accessionNumber: string;
     primaryDocument: string;
 }
-export interface GetSubmissionsParams {
-    /** symbol or cik */
-    symbol: string;
-    includeTranslated?: boolean;
-}
 /**
  * Gets reports from companies filed with the SEC
  *
@@ -93,7 +88,10 @@ export default class SecEdgarApi {
      *
      * endpoint: `/submissions/CIK${cik}.json`
      */
-    getSubmissions(params: GetSubmissionsParams): Promise<SubmissionList>;
+    getSubmissions(params: GetSymbolParams): Promise<{
+        submissionList: SubmissionList;
+        filings: FilingListItemTranslated[];
+    }>;
     /**
      * The company-concept API returns all the XBRL disclosures from a single company (CIK)
      * and concept (a taxonomy and tag) into a single JSON file, with a separate array
@@ -143,8 +141,7 @@ export default class SecEdgarApi {
      */
     getReports<T extends GetReportsParams>(params: T): Promise<T['withWrapper'] extends true ? ReportWrapper[] : ReportTranslated[]>;
     /**
-     * Parses reports from company facts. Calculates missing properties and uses a single interface
-     * for all reports.
+     * Parses reports from company facts.
      */
     getReportsRaw(params: GetReportsRawParams): Promise<ReportRaw[]>;
     /**
@@ -166,7 +163,7 @@ export default class SecEdgarApi {
      */
     getMutualFundList(): Promise<FieldDataResponse<'cik' | 'seriesId' | 'classId' | 'symbol'>>;
     /**
-     * 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.
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -234,5 +231,25 @@ export default class SecEdgarApi {
      * ```
      */
     createRequestProxyStatement(params: CreateRequestWrapperParams): SubmissionRequestWrapper<FormDef14aData>;
+    /**
+     * Gets list of latest filings.
+     *
+     * @see https://www.sec.gov/edgar/searchedgar/currentevents
+     */
+    getCurrentFilingsDaily(params?: {
+        formType?: DailyFilingFormType;
+        lookbackDays?: number;
+    }): Promise<{
+        date: string;
+        matchCount: number;
+        totalCount: number;
+        entries: {
+            accessionNumber: string;
+            form: string;
+            companyCik: number;
+            companyName: string;
+            filedDate: string;
+        }[];
+    }>;
 }
 export {};

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -168,21 +168,19 @@ var SecEdgarApi = /** @class */ (function () {
      * endpoint: `/submissions/CIK${cik}.json`
      */
     SecEdgarApi.prototype.getSubmissions = function (params) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, includeTranslated, cik, submissions;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var symbol, cik, submissionList;
+            return __generator(this, function (_b) {
+                switch (_b.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];
+                        submissionList = _b.sent();
+                        submissionList.cik = Number(submissionList.cik);
+                        return [2 /*return*/, { submissionList: submissionList, filings: this.mapFilingListDetails(cik, (_a = submissionList === null || submissionList === void 0 ? void 0 : submissionList.filings) === null || _a === void 0 ? void 0 : _a.recent) }];
                 }
             });
         });
@@ -270,15 +268,14 @@ var SecEdgarApi = /** @class */ (function () {
                         return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: false }))];
                     case 1:
                         reportsRaw = _c.sent();
-                        reports = this.reportParser.parseReportsFromRaw(reportsRaw, usePropertyResolver);
+                        reports = this.reportParser.parseReportsFromRaw({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
                         return [2 /*return*/, withWrapper ? reports : reports.map(function (report) { return report.getReport(); })];
                 }
             });
         });
     };
     /**
-     * Parses reports from company facts. Calculates missing properties and uses a single interface
-     * for all reports.
+     * Parses reports from company facts.
      */
     SecEdgarApi.prototype.getReportsRaw = function (params) {
         return __awaiter(this, void 0, void 0, function () {
@@ -343,7 +340,7 @@ 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.
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -496,6 +493,41 @@ var SecEdgarApi = /** @class */ (function () {
         }); };
         return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
     };
+    /**
+     * Gets list of latest filings.
+     *
+     * @see https://www.sec.gov/edgar/searchedgar/currentevents
+     */
+    SecEdgarApi.prototype.getCurrentFilingsDaily = function (params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var _b, _c, formType, _d, lookbackDays, indexByFormType, indexFormType, url, xml;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _b = params !== null && params !== void 0 ? params : {}, _c = _b.formType, formType = _c === void 0 ? 'ALL' : _c, _d = _b.lookbackDays, lookbackDays = _d === void 0 ? 0 : _d;
+                        if (lookbackDays > 5) {
+                            throw new Error("lookbackDays must be <= 5. Received ".concat(lookbackDays));
+                        }
+                        indexByFormType = {
+                            '10-K': 0,
+                            '10-Q': 1,
+                            '14': 2,
+                            '485': 3,
+                            '8-K': 4,
+                            'S-8': 5,
+                            ALL: 6,
+                        };
+                        indexFormType = (_a = indexByFormType[formType]) !== null && _a !== void 0 ? _a : 0;
+                        url = "".concat(this.baseUrlSec, "/cgi-bin/current?q1=").concat(lookbackDays, "&q2=").concat(indexFormType);
+                        return [4 /*yield*/, this.request(url, true)];
+                    case 1:
+                        xml = (_e.sent());
+                        return [2 /*return*/, this.documentParser.parseCurrentFilingsDaily({ xml: xml })];
+                }
+            });
+        });
+    };
     return SecEdgarApi;
 }());
 exports.default = SecEdgarApi;

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

@@ -93,4 +93,5 @@ export interface FormDef14aData {
     executiveCompensation: ExecutiveCompensation[];
     holders: Holder[];
 }
+export type DailyFilingFormType = '10-K' | '10-Q' | '8-K' | '14' | '485' | 'S-8' | 'ALL';
 export {};

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

@@ -57,7 +57,6 @@ export interface FilingListItemTranslated {
 interface FilingList {
     recent: FilingListDetails;
     files: FileData[];
-    recentTranslated?: FilingListItemTranslated[];
 }
 export interface SubmissionList {
     cik: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.3.0",
+    "version": "0.3.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)",