@chadwin/sdk 0.6.0 → 0.7.0

package/dist/index.d.cts

@@ -7,6 +7,23 @@ interface PromiseWithResponse<T> extends Promise<T> {
 
 interface components {
     schemas: {
+        CompanyFinancialStatementPeriod: {
+            accession_number: string;
+            balance_sheet: components["schemas"]["FinancialStatementBalanceSheet"];
+            cash_flow_statement: components["schemas"]["FinancialStatementCashFlowStatement"];
+            currency: string;
+            /** @enum {string} */
+            fiscal_period: "FY";
+            fiscal_year: number;
+            income_statement: components["schemas"]["FinancialStatementIncomeStatement"];
+            metrics: components["schemas"]["FinancialStatementMetrics"];
+            /** Format: date */
+            period_end_date: string;
+        };
+        CompanyFinancialStatementsResponse: {
+            issuer: components["schemas"]["FinancialStatementIssuer"];
+            periods: components["schemas"]["CompanyFinancialStatementPeriod"][];
+        };
         CompanyInsiderTransactionListItem: {
             /**
              * Format: date-time
@@ -252,6 +269,123 @@ interface components {
             /** @example unauthorized */
             error: string;
         };
+        FinancialStatementBalanceSheet: {
+            accounts_payable_current?: string;
+            accounts_receivable_current?: string;
+            cash_and_cash_equivalents?: string;
+            current_portion_of_long_term_debt?: string;
+            equity_attributable_to_parent?: string;
+            goodwill?: string;
+            intangible_assets_net_excluding_goodwill?: string;
+            inventory?: string;
+            long_term_debt_noncurrent?: string;
+            property_plant_and_equipment_net?: string;
+            short_term_borrowings?: string;
+            short_term_investments?: string;
+            total_assets?: string;
+            total_borrowings?: string;
+            total_current_assets?: string;
+            total_current_liabilities?: string;
+            total_liabilities?: string;
+            total_liabilities_and_equity?: string;
+        };
+        FinancialStatementCashFlowStatement: {
+            business_acquisitions_net?: string;
+            capital_expenditure?: string;
+            common_dividends_paid?: string;
+            common_stock_repurchases?: string;
+            depreciation_and_amortization_adjustment?: string;
+            effect_of_exchange_rate_on_cash?: string;
+            net_cash_from_financing_activities?: string;
+            net_cash_from_investing_activities?: string;
+            net_cash_from_operating_activities?: string;
+            net_change_in_cash_cash_equivalents_and_restricted_cash_including_exchange_rate_effect?: string;
+            proceeds_from_common_stock_issuance?: string;
+            proceeds_from_debt_issuance?: string;
+            purchases_of_investments?: string;
+            repayments_of_debt?: string;
+            share_based_compensation_adjustment?: string;
+        };
+        FinancialStatementIncomeStatement: {
+            basic_earnings_per_share?: string;
+            basic_weighted_average_shares?: string;
+            cost_of_sales?: string;
+            diluted_earnings_per_share?: string;
+            diluted_weighted_average_shares?: string;
+            gross_profit?: string;
+            income_before_income_taxes?: string;
+            income_tax_expense?: string;
+            interest_expense?: string;
+            net_income_attributable_to_noncontrolling_interests?: string;
+            net_income_attributable_to_parent?: string;
+            net_income_including_noncontrolling_interests?: string;
+            nonoperating_income_expense?: string;
+            operating_income?: string;
+            research_and_development_expense?: string;
+            revenue?: string;
+            selling_general_and_administrative_expense?: string;
+            total_operating_expenses?: string;
+        };
+        FinancialStatementIssuer: {
+            cik: string;
+            name: string;
+            ticker: string;
+        };
+        FinancialStatementMetrics: {
+            asset_turnover?: string;
+            cash_ratio?: string;
+            current_ratio?: string;
+            debt_to_assets?: string;
+            debt_to_equity?: string;
+            ebit?: string;
+            effective_tax_rate?: string;
+            free_cash_flow?: string;
+            free_cash_flow_margin?: string;
+            gross_margin?: string;
+            interest_coverage?: string;
+            net_debt?: string;
+            net_margin?: string;
+            operating_cash_flow_margin?: string;
+            operating_cash_flow_to_net_income?: string;
+            operating_margin?: string;
+            pretax_margin?: string;
+            quick_ratio?: string;
+            return_on_assets?: string;
+            return_on_equity?: string;
+            working_capital?: string;
+        };
+        FinancialStatementsBadRequest: {
+            /** @enum {string} */
+            error: "invalid_ticker" | "invalid_query_parameters";
+        };
+        FinancialStatementsCompanyNotFound: {
+            /** @enum {string} */
+            error: "company_not_found";
+        };
+        FinancialStatementsInternalError: {
+            /** @enum {string} */
+            error: "internal_server_error";
+        };
+        FinancialStatementsNotEntitled: {
+            /** @enum {string} */
+            error: "dataset_not_entitled";
+        };
+        FinancialStatementsTickerAmbiguous: {
+            /** @enum {string} */
+            error: "company_ticker_ambiguous";
+        };
+        FinancialStatementsTooManyRequests: {
+            /** @enum {string} */
+            error: "rate_limited" | "billing_period_quota_exceeded";
+        };
+        FinancialStatementsUnauthorized: {
+            /** @enum {string} */
+            error: "unauthorized";
+        };
+        FinancialStatementsUnavailable: {
+            /** @enum {string} */
+            error: "database_unavailable";
+        };
         InitialOwnershipActivity: {
             /**
              * Format: date-time
@@ -313,7 +447,7 @@ interface components {
             has_more: boolean;
             /**
              * @description Cursor to send after the current page has been processed successfully.
-             * @example cur_eyJ2IjoxLCJhZnRlciI6MjAzfQ
+             * @example cur_request_bound_example
              */
             next_cursor: string;
         };
@@ -525,7 +659,7 @@ interface components {
             has_more: boolean;
             /**
              * @description Cursor to send after the current page has been processed successfully.
-             * @example cur_eyJ2IjoxLCJhZnRlciI6MTI5fQ
+             * @example cur_request_bound_example
              */
             next_cursor: string;
             transactions: components["schemas"]["InsiderTransactionFeedEvent"][];
@@ -722,7 +856,7 @@ interface components {
             has_more: boolean;
             /**
              * @description Cursor to send after the current page has been processed successfully.
-             * @example cur_eyJ2IjoxLCJhZnRlciI6MTIzfQ
+             * @example cur_request_bound_example
              */
             next_cursor: string;
             updates: components["schemas"]["InstitutionalHoldingFeedUpdate"][];
@@ -1433,6 +1567,166 @@ interface operations {
             };
         };
     };
+    getCompanyFinancialStatements: {
+        parameters: {
+            query?: {
+                /** @description One fiscal year from 1900 through 9999. */
+                fiscal_year?: number;
+                /** @description Newest available fiscal years to return, from 1 through 20. */
+                years?: number;
+            };
+            header?: never;
+            path: {
+                /** @description US listed company ticker */
+                ticker: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Published and reviewed normalized annual financial statements. */
+            200: {
+                headers: {
+                    "Cache-Control"?: string;
+                    "X-Billing-Period-Quota-Limit"?: string;
+                    "X-Billing-Period-Quota-Remaining"?: string;
+                    "X-Billing-Period-Quota-Reset"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "issuer": {
+                     *         "cik": "0000320193",
+                     *         "name": "Apple Inc.",
+                     *         "ticker": "AAPL"
+                     *       },
+                     *       "periods": [
+                     *         {
+                     *           "accession_number": "0000320193-24-000123",
+                     *           "balance_sheet": {
+                     *             "cash_and_cash_equivalents": "29943000000",
+                     *             "equity_attributable_to_parent": "56950000000",
+                     *             "total_assets": "364980000000",
+                     *             "total_current_assets": "152987000000",
+                     *             "total_current_liabilities": "176392000000"
+                     *           },
+                     *           "cash_flow_statement": {
+                     *             "net_cash_from_financing_activities": "-121983000000",
+                     *             "net_cash_from_investing_activities": "2935000000",
+                     *             "net_cash_from_operating_activities": "118254000000"
+                     *           },
+                     *           "currency": "USD",
+                     *           "fiscal_period": "FY",
+                     *           "fiscal_year": 2024,
+                     *           "income_statement": {
+                     *             "basic_earnings_per_share": "6.11",
+                     *             "diluted_earnings_per_share": "6.08",
+                     *             "income_before_income_taxes": "123485000000",
+                     *             "income_tax_expense": "29749000000",
+                     *             "net_income_attributable_to_parent": "93736000000",
+                     *             "operating_income": "123216000000",
+                     *             "revenue": "391035000000"
+                     *           },
+                     *           "metrics": {
+                     *             "cash_ratio": "0.17",
+                     *             "current_ratio": "0.87",
+                     *             "effective_tax_rate": "24.09",
+                     *             "net_margin": "23.97",
+                     *             "operating_cash_flow_margin": "30.24",
+                     *             "operating_margin": "31.51",
+                     *             "pretax_margin": "31.58",
+                     *             "return_on_equity": "157.41",
+                     *             "working_capital": "-23405000000"
+                     *           },
+                     *           "period_end_date": "2024-09-28"
+                     *         }
+                     *       ]
+                     *     }
+                     */
+                    "application/json": components["schemas"]["CompanyFinancialStatementsResponse"];
+                };
+            };
+            /** @description The ticker or query parameters are invalid. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsBadRequest"];
+                };
+            };
+            /** @description The request is missing a valid Chadwin API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsUnauthorized"];
+                };
+            };
+            /** @description The subscription does not include this dataset. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsNotEntitled"];
+                };
+            };
+            /** @description No current company has the requested ticker. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsCompanyNotFound"];
+                };
+            };
+            /** @description More than one current company has the ticker. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsTickerAmbiguous"];
+                };
+            };
+            /** @description The request exceeded a rate limit or monthly quota. */
+            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"]["FinancialStatementsTooManyRequests"];
+                };
+            };
+            /** @description A stored result cannot map to the public schema. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsInternalError"];
+                };
+            };
+            /** @description The database is unavailable. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FinancialStatementsUnavailable"];
+                };
+            };
+        };
+    };
     listCompanyInsiderTransactions: {
         parameters: {
             query: {
@@ -2022,7 +2316,7 @@ interface operations {
     listCompanyReportFeed: {
         parameters: {
             query?: {
-                /** @description Use `next_cursor` from the previous response. Keep the same `forms` filter and do not combine this with `start`. */
+                /** @description Use `next_cursor` from the previous response. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not combine it with `start`. */
                 cursor?: string;
                 /** @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;
@@ -2050,7 +2344,7 @@ interface operations {
                     /**
                      * @example {
                      *       "has_more": false,
-                     *       "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MTIzNDV9",
+                     *       "next_cursor": "cur_request_bound_example",
                      *       "updates": [
                      *         {
                      *           "accepted_at": "2025-08-01T10:00:42.000Z",
@@ -2167,7 +2461,7 @@ interface operations {
             query?: {
                 /** @description Optional comma-separated SEC forms to include. Supported forms: 3, 3/A, 4, 4/A, 5, 5/A, 144, 144/A. Omission selects all supported forms. Reuse the same selection with every cursor request. */
                 forms?: string;
-                /** @description Use `next_cursor` from the previous response to continue where you left off. Keep the same `forms` filter. Do not use `cursor` and `start` together. Omit both to get the most recent activity updates. */
+                /** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent activity updates. */
                 cursor?: string;
                 /** @description Page size from 1 through 1000. */
                 limit?: string;
@@ -2466,7 +2760,7 @@ interface operations {
     listInsiderTransactionFeed: {
         parameters: {
             query?: {
-                /** @description Use `next_cursor` from the previous response to continue where you left off. Keep the same `transaction_codes` filter. Do not use `cursor` and `start` together. Omit both to get the most recent transaction updates. */
+                /** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `transaction_codes` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent transaction updates. */
                 cursor?: string;
                 /** @description Page size from 1 through 1000. */
                 limit?: string;
@@ -2550,7 +2844,7 @@ interface operations {
     listInstitutionalFilingFeed: {
         parameters: {
             query?: {
-                /** @description Use `next_cursor` from the previous response to continue where you left off. Keep the same `forms` filter. Do not use `cursor` and `start` together. Omit both to get the most recent filing updates. */
+                /** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent filing updates. */
                 cursor?: string;
                 /** @description Optional comma-separated 13F form types to include. Supported forms: 13F-HR, 13F-HR/A, 13F-NT, 13F-NT/A. Omitted or empty means all supported forms. */
                 forms?: string;
@@ -2634,7 +2928,7 @@ interface operations {
     listInstitutionalManagers: {
         parameters: {
             query?: {
-                /** @description Optional pagination cursor returned as next_cursor from a prior response. */
+                /** @description Opaque next_cursor from the prior page. Keep the same filters and page size. */
                 cursor?: string;
                 /** @description Page size from 1 through 1000. */
                 limit?: string;
@@ -2673,7 +2967,7 @@ interface operations {
                      *           "total_value_usd": "267891234567"
                      *         }
                      *       ],
-                     *       "next_cursor": "cur_eyJ2IjoxLCJuYW1lIjoiQmVya3NoaXJlIEhhdGhhd2F5IEluYy4iLCJmb3JtXzEzZl9maWxlX251bWJlciI6IjAyOC0wNDU0NSJ9"
+                     *       "next_cursor": "cur_request_bound_example"
                      *     }
                      */
                     "application/json": components["schemas"]["InstitutionalManagersResponse"];
@@ -2933,7 +3227,7 @@ interface operations {
     listInstitutionalManagerHoldings: {
         parameters: {
             query: {
-                /** @description Optional pagination cursor returned as next_cursor from a prior response. */
+                /** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
                 cursor?: string;
                 /** @description Page size from 1 through 5000. */
                 limit?: string;
@@ -2997,7 +3291,7 @@ interface operations {
                      *         "form_13f_file_number": "028-04545",
                      *         "name": "Berkshire Hathaway Inc."
                      *       },
-                     *       "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
+                     *       "next_cursor": "cur_request_bound_example",
                      *       "period": {
                      *         "accepted_at": "2026-05-15T20:12:34.000Z",
                      *         "period_of_report": "2026-03-31"
@@ -3043,6 +3337,15 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
+            /** @description The manager-period holdings changed after the cursor was issued. Restart pagination from the first page. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
             /** @description The request exceeded a rate limit. */
             429: {
                 headers: {
@@ -3188,7 +3491,7 @@ interface operations {
     listInstitutionalManagerPositions: {
         parameters: {
             query: {
-                /** @description Optional pagination cursor returned as next_cursor from a prior response. */
+                /** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
                 cursor?: string;
                 /** @description Page size from 1 through 5000. */
                 limit?: string;
@@ -3971,7 +4274,7 @@ interface operations {
     listSecInstitutionalFilingHoldings: {
         parameters: {
             query?: {
-                /** @description Optional pagination cursor returned as next_cursor from a prior response. */
+                /** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
                 cursor?: string;
                 /** @description Page size from 1 through 5000. */
                 limit?: string;
@@ -4027,7 +4330,7 @@ interface operations {
                      *           }
                      *         }
                      *       ],
-                     *       "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
+                     *       "next_cursor": "cur_request_bound_example",
                      *       "period_of_report": "2026-03-31",
                      *       "report_type": "13F HOLDINGS REPORT"
                      *     }
@@ -4071,6 +4374,15 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
+            /** @description The filing holdings changed after the cursor was issued. Restart pagination from the first page. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
             /** @description The request exceeded a rate limit. */
             429: {
                 headers: {
@@ -4254,6 +4566,19 @@ interface operations {
 
 type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
 type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
+type FinancialStatementsGetParams = {
+    ticker: string;
+    fiscalYear: number;
+    years?: never;
+} | {
+    ticker: string;
+    years: number;
+    fiscalYear?: never;
+} | {
+    ticker: string;
+    fiscalYear?: never;
+    years?: never;
+};
 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";
@@ -4394,6 +4719,11 @@ declare class CompanyReports {
         accessionNumber: string;
     }): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
 }
+declare class FinancialStatements {
+    private readonly transport;
+    constructor(transport: HttpTransport);
+    get({ ticker, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
+}
 declare class InsiderTransactions {
     private readonly transport;
     constructor(transport: HttpTransport);
@@ -4539,6 +4869,7 @@ declare class Chadwin {
     readonly companies: Companies;
     readonly companyReports: CompanyReports;
     readonly feeds: Feeds;
+    readonly financialStatements: FinancialStatements;
     readonly insiderFilings: InsiderFilings;
     readonly insiderTransactions: InsiderTransactions;
     readonly institutionalFilings: InstitutionalFilings;
@@ -4559,4 +4890,4 @@ declare class APIError extends Error {
     constructor(message: string, options?: APIErrorOptions);
 }
 
-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 };
+export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, type FinancialStatementsGetParams, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };