@chadwin/sdk 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -186,7 +186,7 @@ interface components {
                  */
                 content_url: string;
                 /** @enum {string} */
-                form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
+                form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
                 /**
                  * Format: date
                  * @description End date of the fiscal period covered by this filing, or null when the SEC filing does not provide one.
@@ -196,7 +196,7 @@ interface components {
                 sec_url: string;
             }[];
             /** @enum {string} */
-            fiscal_period: "FY";
+            fiscal_period: "FY" | "Q1" | "Q2" | "Q3";
             fiscal_year: number;
             issuer: {
                 cik: string;
@@ -217,10 +217,10 @@ interface components {
              */
             content_url: string;
             /** @enum {string|null} */
-            fiscal_period: "FY" | null;
+            fiscal_period: "FY" | "Q1" | "Q2" | "Q3" | null;
             fiscal_year: number | null;
             /** @enum {string} */
-            form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
+            form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
             issuer: {
                 cik: string;
                 name: string | null;
@@ -1249,7 +1249,7 @@ interface operations {
                      *               "ticker": "IBM"
                      *             }
                      *           ],
-                     *           "name": "INTERNATIONAL BUSINESS MACHINES CORP",
+                     *           "name": "International Business Machines Corporation",
                      *           "sic": {
                      *             "code": "3570",
                      *             "industry_title": "COMPUTER & OFFICE EQUIPMENT",
@@ -1356,7 +1356,7 @@ interface operations {
                      *             "ticker": "IBM"
                      *           }
                      *         ],
-                     *         "name": "INTERNATIONAL BUSINESS MACHINES CORP",
+                     *         "name": "International Business Machines Corporation",
                      *         "sic": {
                      *           "code": "3570",
                      *           "industry_title": "COMPUTER & OFFICE EQUIPMENT",
@@ -1879,12 +1879,131 @@ interface operations {
             };
         };
     };
+    getCompanyReportForFiscalPeriod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                ticker: string;
+                fiscal_year: string;
+                fiscal_period: "Q1" | "Q2" | "Q3";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Quarterly report filing family */
+            200: {
+                headers: {
+                    "Cache-Control"?: string;
+                    ETag?: string;
+                    "X-Billing-Period-Quota-Limit"?: string;
+                    "X-Billing-Period-Quota-Remaining"?: string;
+                    "X-Billing-Period-Quota-Reset"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "filings": [
+                     *         {
+                     *           "accepted_at": "2025-08-01T10:00:42.000Z",
+                     *           "accession_number": "0000320193-25-000073",
+                     *           "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
+                     *           "form": "10-Q",
+                     *           "period_end_date": "2025-06-28",
+                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
+                     *         }
+                     *       ],
+                     *       "fiscal_period": "Q3",
+                     *       "fiscal_year": 2025,
+                     *       "issuer": {
+                     *         "cik": "0000320193",
+                     *         "name": "Apple Inc.",
+                     *         "ticker": "AAPL"
+                     *       }
+                     *     }
+                     */
+                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
+                };
+            };
+            /** @description The ticker, fiscal year, or fiscal period is invalid */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The request is missing a valid Chadwin API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The subscription does not include this dataset. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
+                };
+            };
+            /** @description The company or eligible quarterly report was not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description More than one original quarterly report matches the fiscal period */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The request exceeded a rate limit. */
+            429: {
+                headers: {
+                    "RateLimit-Limit"?: string;
+                    "RateLimit-Reset"?: string;
+                    "Retry-After"?: string;
+                    "X-Billing-Period-Quota-Limit"?: string;
+                    "X-Billing-Period-Quota-Remaining"?: string;
+                    "X-Billing-Period-Quota-Reset"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The filing catalog is unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listCompanyReportFeed: {
         parameters: {
             query?: {
                 /** @description Use `next_cursor` from the previous response. Keep the same `forms` filter and do not combine this with `start`. */
                 cursor?: string;
-                /** @description Optional comma-separated annual-report families. Supported values are 10-K, 20-F, and 40-F. Each family includes its /A amendments. */
+                /** @description Optional comma-separated report families. Supported values are 10-K, 10-Q, 20-F, and 40-F. Each family includes its /A amendments. */
                 forms?: string;
                 /** @description Page size from 1 through 1000. */
                 limit?: string;
@@ -1897,7 +2016,7 @@ interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Published annual report updates. */
+            /** @description Published company report updates. */
             200: {
                 headers: {
                     "Cache-Control"?: string;
@@ -1910,24 +2029,24 @@ interface operations {
                     /**
                      * @example {
                      *       "has_more": false,
-                     *       "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
+                     *       "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MTIzNDV9",
                      *       "updates": [
                      *         {
-                     *           "accepted_at": "2026-08-09T14:02:28.000Z",
-                     *           "accession_number": "0000320193-26-000101",
-                     *           "content_url": "/v1/sec/company-reports/0000320193-26-000101/content.html",
-                     *           "feed_event_id": "crfe_000000000001",
-                     *           "fiscal_period": "FY",
+                     *           "accepted_at": "2025-08-01T10:00:42.000Z",
+                     *           "accession_number": "0000320193-25-000073",
+                     *           "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
+                     *           "feed_event_id": "crfe_000000012345",
+                     *           "fiscal_period": "Q3",
                      *           "fiscal_year": 2025,
-                     *           "form": "10-K",
+                     *           "form": "10-Q",
                      *           "issuer": {
                      *             "cik": "0000320193",
                      *             "name": "Apple Inc.",
                      *             "ticker": "AAPL"
                      *           },
-                     *           "period_end_date": "2025-09-27",
-                     *           "published_at": "2026-08-09T14:04:12.000Z",
-                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000101/0000320193-26-000101-index.htm"
+                     *           "period_end_date": "2025-06-28",
+                     *           "published_at": "2026-08-12T08:15:30.000Z",
+                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
                      *         }
                      *       ]
                      *     }
@@ -1947,10 +2066,10 @@ interface operations {
                             /** @description Stable idempotency key for this publication event. */
                             feed_event_id: string;
                             /** @enum {string|null} */
-                            fiscal_period: "FY" | null;
+                            fiscal_period: "FY" | "Q1" | "Q2" | "Q3" | null;
                             fiscal_year: number | null;
                             /** @enum {string} */
-                            form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
+                            form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
                             issuer: {
                                 cik: string;
                                 name: string | null;
@@ -2115,7 +2234,7 @@ interface operations {
                 from: string;
                 /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. If the filing-date window matches more than 1000 rows, narrow the window. */
                 until?: string;
-                /** @description Optional comma-separated US listed ticker filter. Tickers are resolved against current listed-company reference data before transactions are returned. */
+                /** @description Optional comma-separated US listed ticker filter. */
                 tickers?: string;
             };
             header?: never;
@@ -3314,19 +3433,19 @@ interface operations {
                 content: {
                     /**
                      * @example {
-                     *       "accepted_at": "2024-11-01T10:00:00.000Z",
-                     *       "accession_number": "0000320193-24-000123",
-                     *       "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
-                     *       "fiscal_period": "FY",
-                     *       "fiscal_year": 2024,
-                     *       "form": "10-K",
+                     *       "accepted_at": "2025-08-01T10:00:42.000Z",
+                     *       "accession_number": "0000320193-25-000073",
+                     *       "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
+                     *       "fiscal_period": "Q3",
+                     *       "fiscal_year": 2025,
+                     *       "form": "10-Q",
                      *       "issuer": {
                      *         "cik": "0000320193",
                      *         "name": "Apple Inc.",
                      *         "ticker": "AAPL"
                      *       },
-                     *       "period_end_date": "2024-09-28",
-                     *       "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
+                     *       "period_end_date": "2025-06-28",
+                     *       "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
                      *     }
                      */
                     "application/json": components["schemas"]["CompanyReportResponse"];
@@ -3405,7 +3524,7 @@ interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Cleaned company report HTML */
+            /** @description Company report HTML */
             200: {
                 headers: {
                     "Cache-Control"?: string;
@@ -3418,7 +3537,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    /** @example <!doctype html><html><body><h1>Annual report</h1></body></html> */
+                    /** @example <!doctype html><html><body><h1>Company report</h1></body></html> */
                     "text/html": string;
                 };
             };
@@ -4097,7 +4216,8 @@ interface operations {
     };
 }
 
-type CompanyReportForm = "10-K" | "20-F" | "40-F";
+type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
+type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
 type InsiderActivityForm = "3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "144" | "144/A";
 type InsiderTransactionCode = "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
 type InstitutionalFilingForm = "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
@@ -4229,6 +4349,11 @@ declare class CompanyReports {
         ticker: string;
         fiscalYear: number;
     }): PromiseWithResponse<JsonResponse<"getCompanyReport">>;
+    getByFiscalPeriod({ ticker, fiscalYear, fiscalPeriod, }: {
+        ticker: string;
+        fiscalYear: number;
+        fiscalPeriod: CompanyReportFiscalPeriod;
+    }): PromiseWithResponse<JsonResponse<"getCompanyReportForFiscalPeriod">>;
     getHtml({ accessionNumber, }: {
         accessionNumber: string;
     }): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
@@ -4236,16 +4361,16 @@ declare class CompanyReports {
 declare class InsiderTransactions {
     private readonly transport;
     constructor(transport: HttpTransport);
-    list({ filingDateFrom, filingDateUntil, tickers, transactionCodes, }: {
-        filingDateFrom: string;
-        filingDateUntil?: string;
+    list({ from, until, tickers, transactionCodes, }: {
+        from: string;
+        until?: string;
         tickers?: string[];
         transactionCodes?: InsiderTransactionCode[];
     }): PromiseWithResponse<JsonResponse<"listInsiderTransactions">>;
-    listForCompany({ ticker, filingDateFrom, filingDateUntil, transactionCodes, }: {
+    listForCompany({ ticker, from, until, transactionCodes, }: {
         ticker: string;
-        filingDateFrom: string;
-        filingDateUntil?: string;
+        from: string;
+        until?: string;
         transactionCodes?: InsiderTransactionCode[];
     }): PromiseWithResponse<JsonResponse<"listCompanyInsiderTransactions">>;
 }
@@ -4259,15 +4384,15 @@ declare class InsiderFilings {
 declare class ProposedSales {
     private readonly transport;
     constructor(transport: HttpTransport);
-    list({ filingDateFrom, filingDateUntil, tickers, }: {
-        filingDateFrom: string;
-        filingDateUntil?: string;
+    list({ from, until, tickers, }: {
+        from: string;
+        until?: string;
         tickers?: string[];
     }): PromiseWithResponse<JsonResponse<"listProposedSales">>;
-    listForCompany({ ticker, filingDateFrom, filingDateUntil, }: {
+    listForCompany({ ticker, from, until, }: {
         ticker: string;
-        filingDateFrom: string;
-        filingDateUntil?: string;
+        from: string;
+        until?: string;
     }): PromiseWithResponse<JsonResponse<"listCompanyProposedSales">>;
     getFiling({ accessionNumber, }: {
         accessionNumber: string;
@@ -4307,31 +4432,31 @@ declare class InstitutionalManagers {
     listPeriods({ form13fFileNumber, }: {
         form13fFileNumber: string;
     }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerPeriods">>;
-    listHoldings({ form13fFileNumber, reportPeriod, cursor, limit, }: {
+    listHoldings({ form13fFileNumber, period, cursor, limit, }: {
         form13fFileNumber: string;
-        reportPeriod: string;
+        period: string;
         cursor?: string;
         limit?: number;
     }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerHoldings">>;
-    listPositions({ form13fFileNumber, reportPeriod, cursor, limit, }: {
+    listPositions({ form13fFileNumber, period, cursor, limit, }: {
         form13fFileNumber: string;
-        reportPeriod: string;
+        period: string;
         cursor?: string;
         limit?: number;
     }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerPositions">>;
-    iterate({ cik, form13fFileNumber, limit, }?: {
+    iterateManagers({ cik, form13fFileNumber, limit, }?: {
         cik?: string;
         form13fFileNumber?: string;
         limit?: number;
     }): AsyncGenerator<InstitutionalManager>;
-    iterateHoldings({ form13fFileNumber, reportPeriod, limit, }: {
+    iterateHoldings({ form13fFileNumber, period, limit, }: {
         form13fFileNumber: string;
-        reportPeriod: string;
+        period: string;
         limit?: number;
     }): AsyncGenerator<InstitutionalHolding>;
-    iteratePositions({ form13fFileNumber, reportPeriod, limit, }: {
+    iteratePositions({ form13fFileNumber, period, limit, }: {
         form13fFileNumber: string;
-        reportPeriod: string;
+        period: string;
         limit?: number;
     }): AsyncGenerator<InstitutionalPosition>;
 }
@@ -4364,4 +4489,4 @@ declare class APIError extends Error {
     constructor(message: string, options?: APIErrorOptions);
 }
 
-export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportForm, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };
+export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };

package/dist/index.js

@@ -384,6 +384,24 @@ var CompanyReports = class {
       ]
     });
   }
+  getByFiscalPeriod({
+    ticker,
+    fiscalYear,
+    fiscalPeriod
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "companies",
+        "US",
+        ticker,
+        "reports",
+        "quarterly",
+        String(fiscalYear),
+        fiscalPeriod
+      ]
+    });
+  }
   getHtml({
     accessionNumber
   }) {
@@ -405,33 +423,33 @@ var InsiderTransactions = class {
   }
   transport;
   list({
-    filingDateFrom,
-    filingDateUntil,
+    from,
+    until,
     tickers,
     transactionCodes
   }) {
     return this.transport.request({
       path: ["v1", "insider-transactions"],
       query: {
-        from: filingDateFrom,
+        from,
         tickers: commaSeparated(tickers),
         transaction_codes: commaSeparated(transactionCodes),
-        until: filingDateUntil
+        until
       }
     });
   }
   listForCompany({
     ticker,
-    filingDateFrom,
-    filingDateUntil,
+    from,
+    until,
     transactionCodes
   }) {
     return this.transport.request({
       path: ["v1", "companies", "US", ticker, "insider-transactions"],
       query: {
-        from: filingDateFrom,
+        from,
         transaction_codes: commaSeparated(transactionCodes),
-        until: filingDateUntil
+        until
       }
     });
   }
@@ -455,27 +473,27 @@ var ProposedSales = class {
   }
   transport;
   list({
-    filingDateFrom,
-    filingDateUntil,
+    from,
+    until,
     tickers
   }) {
     return this.transport.request({
       path: ["v1", "proposed-sales"],
       query: {
-        from: filingDateFrom,
+        from,
         tickers: commaSeparated(tickers),
-        until: filingDateUntil
+        until
       }
     });
   }
   listForCompany({
     ticker,
-    filingDateFrom,
-    filingDateUntil
+    from,
+    until
   }) {
     return this.transport.request({
       path: ["v1", "companies", "US", ticker, "proposed-sales"],
-      query: { from: filingDateFrom, until: filingDateUntil }
+      query: { from, until }
     });
   }
   getFiling({
@@ -586,7 +604,7 @@ var InstitutionalManagers = class {
   }
   listHoldings({
     form13fFileNumber,
-    reportPeriod,
+    period,
     cursor,
     limit
   }) {
@@ -598,12 +616,12 @@ var InstitutionalManagers = class {
         form13fFileNumber,
         "holdings"
       ],
-      query: { cursor, limit, period: reportPeriod }
+      query: { cursor, limit, period }
     });
   }
   listPositions({
     form13fFileNumber,
-    reportPeriod,
+    period,
     cursor,
     limit
   }) {
@@ -615,10 +633,10 @@ var InstitutionalManagers = class {
         form13fFileNumber,
         "positions"
       ],
-      query: { cursor, limit, period: reportPeriod }
+      query: { cursor, limit, period }
     });
   }
-  async *iterate({
+  async *iterateManagers({
     cik,
     form13fFileNumber,
     limit
@@ -637,14 +655,14 @@ var InstitutionalManagers = class {
   }
   async *iterateHoldings({
     form13fFileNumber,
-    reportPeriod,
+    period,
     limit
   }) {
     let cursor;
     do {
       const page = await this.listHoldings({
         form13fFileNumber,
-        reportPeriod,
+        period,
         ...cursor === void 0 ? {} : { cursor },
         ...limit === void 0 ? {} : { limit }
       });
@@ -654,14 +672,14 @@ var InstitutionalManagers = class {
   }
   async *iteratePositions({
     form13fFileNumber,
-    reportPeriod,
+    period,
     limit
   }) {
     let cursor;
     do {
       const page = await this.listPositions({
         form13fFileNumber,
-        reportPeriod,
+        period,
         ...cursor === void 0 ? {} : { cursor },
         ...limit === void 0 ? {} : { limit }
       });