sec-edgar-api 0.3.4 → 0.4.0

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -46,6 +46,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var cik_by_symbol_1 = require("../../util/cik-by-symbol");
 var Client_1 = require("../Client");
@@ -460,7 +471,16 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.createRequestEarningsReports = function (params) {
         var _this = this;
-        var submissions = this.getCreateRequestSubmissions(params, ['10-Q', '10-Q/A', '10-K', '10-K/A']);
+        var submissions = this.getCreateRequestSubmissions(params, [
+            '10-Q',
+            '10-Q/A',
+            '10-K',
+            '10-K/A',
+            '20-F',
+            '20-F/A',
+            '40-F',
+            '40-F/A',
+        ]);
         var options = { maxRequests: params.maxRequests };
         var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
             var _a, _b;
@@ -517,7 +537,7 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * Gets list of latest filings.
+     * Gets list of filings for a day up to 5 days ago.
      *
      * @see https://www.sec.gov/edgar/searchedgar/currentevents
      */
@@ -551,6 +571,131 @@ var SecEdgarApi = /** @class */ (function () {
             });
         });
     };
+    SecEdgarApi.prototype.getCurrentFilings = function (params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var _b, _c, page, _d, itemsPerPage, formType, searchType, symbol, type, owner, offset, cik, url, xml;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _b = params !== null && params !== void 0 ? params : {}, _c = _b.page, page = _c === void 0 ? 1 : _c, _d = _b.itemsPerPage, itemsPerPage = _d === void 0 ? 100 : _d, formType = _b.formType, searchType = _b.searchType, symbol = _b.symbol;
+                        type = (_a = formType === null || formType === void 0 ? void 0 : formType.replace(/\s/, '+')) !== null && _a !== void 0 ? _a : null;
+                        owner = searchType !== null && searchType !== void 0 ? searchType : ((formType === null || formType === void 0 ? void 0 : formType.includes(' ')) ? 'include' : 'only');
+                        offset = (page - 1) * Math.max(1, itemsPerPage || 100);
+                        cik = symbol ? Number(this.getCikString(symbol)) : null;
+                        url = "".concat(this.baseUrlSec, "/cgi-bin/browse-edgar?action=getcurrent&start=").concat(offset, "&count=").concat(itemsPerPage, "&output=atom");
+                        if (cik)
+                            url += "&CIK=".concat(symbol);
+                        if (type)
+                            url += "&type=".concat(formType);
+                        if (owner)
+                            url += "&owner=".concat(searchType);
+                        return [4 /*yield*/, this.request(url, true)];
+                    case 1:
+                        xml = (_e.sent());
+                        return [2 /*return*/, this.documentParser.parseCurrentFilings({ xml: xml })];
+                }
+            });
+        });
+    };
+    /**
+     * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
+     */
+    SecEdgarApi.prototype.getCurrentFilingsXBRL = 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*/, this.documentParser.parseCurrentFilingsXbrl({ xml: xml })];
+                }
+            });
+        });
+    };
+    SecEdgarApi.prototype.getDocumentXbrl = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, options, xml;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = params.url, options = __rest(params, ["url"]);
+                        return [4 /*yield*/, this.getDocumentXMLByUrl({ url: url })];
+                    case 1:
+                        xml = _a.sent();
+                        return [2 /*return*/, this.documentParser.parseXbrl(__assign({ xml: xml }, options))];
+                }
+            });
+        });
+    };
+    /**
+     * Gets insider transactions for a provided symbol or CIK.
+     *
+     * To get transactions by a specific owner, set isOwnerCik to true and provide
+     * the owner CIK for the symbol parameter.
+     *
+     * example at https://www.sec.gov/cgi-bin/own-disp?action=getissuer&CIK=0000320193
+     */
+    SecEdgarApi.prototype.getInsiderTransactions = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var page, symbol, itemsPerPage, _a, isOwnerCik, action, offset, cik, url, xml;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        page = params.page, symbol = params.symbol, itemsPerPage = params.itemsPerPage, _a = params.isOwnerCik, isOwnerCik = _a === void 0 ? false : _a;
+                        action = isOwnerCik ? 'getowner' : 'getissuer';
+                        offset = (page - 1) * Math.max(1, itemsPerPage || 100);
+                        cik = this.getCikString(symbol);
+                        url = "".concat(this.baseUrlSec, "/cgi-bin/own-disp?action=").concat(action, "&CIK=").concat(cik, "&owner=include&start=").concat(offset, "&count=").concat(itemsPerPage);
+                        return [4 /*yield*/, this.request(url, true)];
+                    case 1:
+                        xml = (_b.sent());
+                        return [2 /*return*/, this.documentParser.parseInsiderTransactions({ xml: xml })];
+                }
+            });
+        });
+    };
+    /**
+     * Search for companies from by name, sic code, or state.
+     */
+    SecEdgarApi.prototype.searchCompanies = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var sic, page, itemsPerPageProp, state, company, companyMatch, match, itemsPerPage, offset, url, xml;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sic = params.sic, page = params.page, itemsPerPageProp = params.itemsPerPage, state = params.state, company = params.company, companyMatch = params.companyMatch;
+                        match = companyMatch === 'startsWith' ? '' : 'contains';
+                        itemsPerPage = Math.max(1, Math.min(100, itemsPerPageProp || 100));
+                        offset = (page - 1) * itemsPerPage;
+                        url = "".concat(this.baseUrlSec, "/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=").concat(offset, "&count=").concat(itemsPerPage, "&hidefilings=0");
+                        if (sic)
+                            url += "&SIC=".concat(sic);
+                        if (state)
+                            url += "&State=".concat(state);
+                        if (company)
+                            url += "&company=".concat(company, "&match=").concat(match);
+                        if (!sic && !state && !company) {
+                            throw new Error('You must provide sic, company, or state filters');
+                        }
+                        return [4 /*yield*/, this.request(url, true)];
+                    case 1:
+                        xml = (_a.sent());
+                        return [2 /*return*/, this.documentParser.parseCompanies({ xml: xml })];
+                }
+            });
+        });
+    };
     return SecEdgarApi;
 }());
 exports.default = SecEdgarApi;

package/build/types/company-search.type.d.ts

@@ -0,0 +1,5 @@
+export interface CompanySearchResult {
+    cik: number;
+    companyName: string;
+    stateOrCountry: string;
+}

package/build/types/company-search.type.js

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

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

@@ -0,0 +1,57 @@
+export interface CurrentFilingsXBRL {
+    title: string;
+    link: string;
+    description: string;
+    language: string;
+    pubDate: string;
+    lastBuildDate: string;
+    items: FilingItemXBRL[];
+}
+export interface FilingItemXBRL {
+    title: string;
+    link: string;
+    guid: string;
+    enclosureUrl: string;
+    enclosureLength: number;
+    enclosureType: string;
+    pubDate: string;
+    description: string;
+    companyName: string;
+    formType: string;
+    filingDate: string;
+    cikNumber: number;
+    accessionNumber: string;
+    fileNumber: string;
+    acceptanceDatetime: string;
+    period: string;
+    assistantDirector: string;
+    assignedSic: number;
+    fiscalYearEnd: string;
+    files: FilingItemXBRLFile[];
+}
+export interface FilingItemXBRLFile {
+    sequence: number;
+    file: string;
+    type: string;
+    size: number;
+    description: string;
+    url: string;
+    inlineXBRL: boolean;
+}
+export interface CurrentFilingEntry {
+    title: string;
+    link: string;
+    filingDate: string;
+    accessionNumber: string;
+    size: string;
+    updated: string;
+    form: string;
+    url: string;
+    cik: number;
+}
+export interface CurrentFilingsList {
+    title: string;
+    id: string;
+    updated: string;
+    entries: CurrentFilingEntry[];
+}

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

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

package/build/types/index.d.ts

@@ -4,3 +4,6 @@ export * from './report-translated.type';
 export * from './submission.type';
 export * from './parsed-filings.type';
 export * from './common.type';
+export * from './insider-transaction.type';
+export * from './company-search.type';
+export * from './current-filings.type';

package/build/types/index.js

@@ -20,3 +20,6 @@ __exportStar(require("./report-translated.type"), exports);
 __exportStar(require("./submission.type"), exports);
 __exportStar(require("./parsed-filings.type"), exports);
 __exportStar(require("./common.type"), exports);
+__exportStar(require("./insider-transaction.type"), exports);
+__exportStar(require("./company-search.type"), exports);
+__exportStar(require("./current-filings.type"), exports);

package/build/types/insider-transaction.type.d.ts

@@ -0,0 +1,32 @@
+export interface Owner {
+    ownerName: string;
+    ownerCik: number;
+    ownerPosition: string | null;
+    isDirector: boolean;
+    isOfficer: boolean;
+}
+export interface Issuer {
+    issuerName: string;
+    issuerCik: number;
+}
+export interface InsiderTransaction {
+    ownerName: string;
+    ownerCik: number;
+    ownerPosition: string | null;
+    issuerCik: number;
+    issuerName: string;
+    isDirector: boolean;
+    isOfficer: boolean;
+    /** true = buy, false = sell */
+    isAcquisition: boolean;
+    isDirectOwnership: boolean;
+    securityTitle: string;
+    transactionDate: string;
+    transactionCode: string;
+    transactionShares: number;
+    sharesOwnedFollowingTransaction: number;
+    lineNumber: number;
+    deemedExecutionDate: string;
+    form: string;
+    accessionNumber: string;
+}

package/build/types/insider-transaction.type.js

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

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

@@ -22,7 +22,7 @@ interface TransactionDescriptionByCode {
 export type TransactionType = 'Acquire' | 'Dispose';
 export type TransactionCode = keyof TransactionDescriptionByCode;
 export type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
-export interface InsiderTransaction {
+export interface InsiderTransactionExtended {
     filerName: string;
     filerPosition: string;
     filerPositionTypes: string[];
@@ -42,7 +42,7 @@ export interface InsiderTransaction {
     price: number | null;
     priceExcercised: number | null;
     ownership: string;
-    explainationByKey: Partial<Record<keyof InsiderTransaction, string>>;
+    explainationByKey: Partial<Record<keyof InsiderTransactionExtended, string>>;
 }
 export interface InstitutionalHolder {
     name: string;
@@ -81,7 +81,7 @@ export interface Holder {
     percentOfClass: string | null;
 }
 export interface Form4Data {
-    transactions: InsiderTransaction[];
+    transactions: InsiderTransactionExtended[];
 }
 export interface Form10KData {
     tables: TableData[];

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

@@ -0,0 +1,155 @@
+export interface XbrlContext {
+    id: string;
+    entity: {
+        identifier: {
+            value: string;
+            scheme: string;
+        };
+        segment: {
+            value: string;
+            dimension: string;
+        }[];
+    };
+    period: {
+        startDate?: string;
+        endDate?: string;
+        instant?: string;
+    };
+}
+export interface XbrlUnit {
+    id: string;
+    measure: string;
+}
+export interface XbrlElement {
+    id: string;
+    name: string;
+    contextRef: string;
+    continuedAt?: string;
+    decimals?: string;
+    escape?: string;
+    format?: string;
+    order?: string;
+    precision?: string;
+    scale?: string;
+    sign?: string;
+    target?: string;
+    text?: string;
+    tupleID?: string;
+    tupleRef?: string;
+    unitRef?: string;
+}
+export interface XbrlInstance {
+    contexts: XbrlContext[];
+    units: XbrlUnit[];
+    factElements: XbrlElement[];
+}
+export interface XbrlSchema {
+    annotation?: XbrlSchemaAnnotation;
+    import?: XbrlSchemaImport[];
+    element?: XbrlSchemaElement[];
+    targetNamespace?: string;
+    elementFormDefault?: string;
+    attributeFormDefault?: string;
+    xmlns?: string;
+    _xmlnsProps: Record<string, string>;
+}
+export interface XbrlLinkbaseRoleType {
+    id: string;
+    definition: string;
+    usedOn: string[];
+    roleURI: string;
+}
+export interface XbrlLinkbaseItemExtended {
+    type: 'extended';
+    id?: string;
+    role?: string;
+    loc?: XbrlLinkbaseItemLocator[];
+    calculationArc?: XbrlLinkbaseItemArc[];
+    definitionArc?: XbrlLinkbaseItemArc[];
+    labelArc?: XbrlLinkbaseItemArc[];
+    presentationArc?: XbrlLinkbaseItemArc[];
+    footnoteArc?: XbrlLinkbaseItemArc[];
+    label?: XbrlLinkbaseItemResource[];
+    footnote?: XbrlLinkbaseItemResource[];
+}
+export interface XbrlLinkbaseItemSimple {
+    type: 'simple';
+    href?: string;
+    xlink?: string;
+    arcrole?: string;
+    role?: string;
+    title?: string;
+    roleURI?: string;
+    arcroleURI?: string;
+}
+export interface XbrlLinkbaseItemLocator {
+    type: 'locator';
+    label: string;
+    href: string;
+}
+export interface XbrlLinkbaseItemArc {
+    type: 'arc';
+    from: string;
+    to: string;
+    order?: number;
+    weight?: number;
+    arcrole?: string;
+    priority?: number;
+    closed?: boolean;
+    contextElement?: string;
+    preferredLabel?: string;
+}
+export interface XbrlLinkbaseItemResource {
+    type: 'resource';
+    id?: string;
+    text?: string;
+    label?: string;
+    role?: string;
+    xml?: string;
+    lang?: string;
+}
+export interface XML {
+    version?: string;
+    encoding?: string;
+}
+export interface XbrlLinkbase {
+    roleRef?: XbrlLinkbaseItemSimple[];
+    arcroleRef?: XbrlLinkbaseItemSimple[];
+    referenceLink?: XbrlLinkbaseItemExtended[];
+    labelLink?: XbrlLinkbaseItemExtended[];
+    presentationLink?: XbrlLinkbaseItemExtended[];
+    calculationLink?: XbrlLinkbaseItemExtended[];
+    definitionLink?: XbrlLinkbaseItemExtended[];
+    xmlns?: string;
+    xsi?: string;
+    xlink?: string;
+    schemaLocation?: string;
+}
+export interface XbrlSchemaAnnotation {
+    appinfo: XbrlSchemaAppinfo;
+    documentation?: string;
+}
+export interface XbrlSchemaAppinfo {
+    roleType: XbrlLinkbaseRoleType[];
+    linkbaseRef: XbrlLinkbaseItemSimple[];
+}
+export interface XbrlSchemaElement {
+    name: string;
+    id: string;
+    type: string;
+    abstract?: boolean;
+    periodType?: 'instant' | 'duration';
+    nillable?: boolean;
+    substitutionGroup?: string;
+    balance?: string;
+    typedDomainRef?: string;
+    domain?: string;
+    headUsable?: boolean;
+    linkrole?: string;
+    complexType?: object;
+    annotation?: object;
+}
+export interface XbrlSchemaImport {
+    namespace: string;
+    schemaLocation: string;
+}

package/build/types/xbrl.type.js

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

package/package.json

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