@chadwin/sdk 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +18 -0
  2. package/dist/index.cjs +13 -104
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +244 -1055
  5. package/dist/index.d.ts +244 -1055
  6. package/dist/index.js +13 -104
  7. package/dist/index.js.map +1 -1
  8. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -25,137 +25,6 @@ interface components {
25
25
  issuer: components["schemas"]["FinancialStatementIssuer"];
26
26
  periods: components["schemas"]["CompanyFinancialStatementPeriod"][];
27
27
  };
28
- CompanyInsiderTransactionListItem: {
29
- /**
30
- * Format: date-time
31
- * @description SEC acceptance timestamp for the containing filing.
32
- * @example 2026-05-29T22:30:27.000Z
33
- */
34
- accepted_at: string;
35
- /** @example 0001140361-26-023363 */
36
- accession_number: string;
37
- /**
38
- * @description A when securities were acquired, D when disposed, or null when not stated.
39
- * @example D
40
- */
41
- acquired_disposed_code: string | null;
42
- /** @example null */
43
- conversion_or_exercise_price: string | null;
44
- /**
45
- * @description Deemed execution date reported for the transaction, or null when not applicable or absent.
46
- * @example null
47
- */
48
- deemed_execution_date: string | null;
49
- /** @example false */
50
- equity_swap_involved: boolean | null;
51
- /** @example null */
52
- exercise_date: string | null;
53
- /** @example null */
54
- expiration_date: string | null;
55
- field_footnote_ids: components["schemas"]["InsiderFieldFootnoteIds"];
56
- /**
57
- * @description All document-level footnote IDs referenced by fields on this row.
58
- * @example [
59
- * "F1"
60
- * ]
61
- */
62
- footnote_ids: string[];
63
- footnotes: components["schemas"]["InsiderTransactionFootnote"][];
64
- /** @example null */
65
- nature_of_ownership: string | null;
66
- /**
67
- * @description Normalized ownership value: direct for direct beneficial ownership, indirect for ownership through another person or entity, or null when not stated.
68
- * @example direct
69
- */
70
- ownership_type: string | null;
71
- /** @example 311.02 */
72
- price: string | null;
73
- /** @description Reporting owners listed on the SEC filing that contains this transaction. These owners are filing-level context and are not guaranteed to identify the owner of this exact transaction row. */
74
- reporting_owners: components["schemas"]["InsiderTransactionReportingOwner"][];
75
- /**
76
- * @description SEC ownership table containing the transaction row.
77
- * @example nonderivative_transaction
78
- * @enum {string}
79
- */
80
- row_kind: "nonderivative_transaction" | "derivative_transaction";
81
- /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm */
82
- sec_url: string;
83
- /** @example Common Stock */
84
- security: string | null;
85
- /** @example 50000 */
86
- shares: string | null;
87
- /** @example 3764576 */
88
- shares_owned_after: string | null;
89
- /**
90
- * @description One-based row position within the filing's derivative or non-derivative transaction table.
91
- * @example 1
92
- */
93
- source_row_index: number;
94
- /**
95
- * @description SEC transaction code: P purchase; S sale; A grant or award; D disposition to issuer; F tax or exercise-price payment with securities; I discretionary Rule 16b-3 transaction; M exempt derivative exercise or conversion; C derivative conversion; E short-position expiration; H long-position expiration or cancellation with value; O out-of-the-money exercise; X in- or at-the-money exercise; G gift; L small acquisition; W inheritance; Z voting-trust transfer; J other event explained in the filing; K equity swap; U tender in a change of control; V voluntary early report.
96
- * @example S
97
- * @enum {string}
98
- */
99
- transaction_code: "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
100
- /**
101
- * @description Transaction date reported in the filing, or null when absent.
102
- * @example 2026-05-27
103
- */
104
- transaction_date: string | null;
105
- /**
106
- * @description Row-level SEC form timing code, or null when not stated. This can differ from the containing document form.
107
- * @example 4
108
- */
109
- transaction_form_type: string | null;
110
- /**
111
- * @description E for early, L for late, or null when the filing does not state transaction timeliness.
112
- * @example null
113
- */
114
- transaction_timeliness: string | null;
115
- /**
116
- * @description SEC transactionTotalValue when present. This value is not computed by the API.
117
- * @example null
118
- */
119
- transaction_total_value: string | null;
120
- underlying_security: components["schemas"]["InsiderUnderlyingSecurity"];
121
- };
122
- CompanyInsiderTransactionsBadRequestResponse: {
123
- /**
124
- * @example invalid_cursor
125
- * @enum {string}
126
- */
127
- error: "invalid_cursor" | "invalid_transaction_codes" | "invalid_limit" | "invalid_since" | "invalid_date_window" | "unsupported_cursor";
128
- };
129
- CompanyInsiderTransactionsResponse: {
130
- has_more: boolean;
131
- issuer: components["schemas"]["InsiderIssuer"];
132
- next_cursor: string | null;
133
- transactions: components["schemas"]["CompanyInsiderTransactionListItem"][];
134
- };
135
- CompanyProposedSalesResponse: {
136
- has_more: boolean;
137
- issuer: {
138
- cik: string;
139
- name: string;
140
- ticker: string;
141
- };
142
- next_cursor: string | null;
143
- proposed_sales: {
144
- accepted_at: string;
145
- accession_number: string;
146
- amount: string;
147
- approximate_sale_date: string;
148
- market_value: string;
149
- reporting_person: {
150
- cik: string;
151
- name: string;
152
- relationships: string[];
153
- };
154
- sec_url: string;
155
- security: string;
156
- source_row_index: number;
157
- }[];
158
- };
159
28
  CompanyReference: {
160
29
  /**
161
30
  * @description Zero-padded SEC Central Index Key.
@@ -822,7 +691,7 @@ interface components {
822
691
  * @example invalid_tickers
823
692
  * @enum {string}
824
693
  */
825
- error: "invalid_cursor" | "invalid_transaction_codes" | "invalid_tickers" | "invalid_limit" | "invalid_since" | "invalid_date_window" | "unsupported_cursor";
694
+ error: "invalid_cursor" | "invalid_transaction_codes" | "invalid_query_parameters" | "invalid_limit" | "invalid_date_window";
826
695
  };
827
696
  InsiderTransactionsResponse: {
828
697
  has_more: boolean;
@@ -1262,7 +1131,7 @@ interface components {
1262
1131
  form: "144" | "144/A";
1263
1132
  issuer: {
1264
1133
  cik: string;
1265
- name: string;
1134
+ name: string | null;
1266
1135
  ticker: string | null;
1267
1136
  };
1268
1137
  nothing_to_report: boolean;
@@ -1369,7 +1238,7 @@ interface components {
1369
1238
  approximate_sale_date: string;
1370
1239
  issuer: {
1371
1240
  cik: string;
1372
- name: string;
1241
+ name: string | null;
1373
1242
  ticker: string | null;
1374
1243
  };
1375
1244
  market_value: string;
@@ -1394,859 +1263,21 @@ interface operations {
1394
1263
  getCompany: {
1395
1264
  parameters: {
1396
1265
  query?: {
1397
- /** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
1398
- ticker?: string;
1399
- /** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
1400
- cik?: string;
1401
- };
1402
- header?: never;
1403
- path?: never;
1404
- cookie?: never;
1405
- };
1406
- requestBody?: never;
1407
- responses: {
1408
- /** @description Company reference details. */
1409
- 200: {
1410
- headers: {
1411
- "Cache-Control"?: string;
1412
- "X-Billing-Period-Quota-Limit"?: string;
1413
- "X-Billing-Period-Quota-Remaining"?: string;
1414
- "X-Billing-Period-Quota-Reset"?: string;
1415
- [name: string]: unknown;
1416
- };
1417
- content: {
1418
- /**
1419
- * @example {
1420
- * "company": {
1421
- * "cik": "0000051143",
1422
- * "fiscal_year_end": "1231",
1423
- * "listings": [
1424
- * {
1425
- * "exchange": "NYSE",
1426
- * "is_current": true,
1427
- * "share_class_figi": "BBG001S5S399",
1428
- * "ticker": "IBM"
1429
- * }
1430
- * ],
1431
- * "name": "International Business Machines Corporation",
1432
- * "sic": {
1433
- * "code": "3570",
1434
- * "industry_title": "COMPUTER & OFFICE EQUIPMENT",
1435
- * "office": "Office of Technology"
1436
- * }
1437
- * }
1438
- * }
1439
- */
1440
- "application/json": components["schemas"]["CompanyReferenceResponse"];
1441
- };
1442
- };
1443
- /** @description Supply exactly one valid ticker or CIK and no other query keys. */
1444
- 400: {
1445
- headers: {
1446
- [name: string]: unknown;
1447
- };
1448
- content: {
1449
- "application/json": {
1450
- /** @enum {string} */
1451
- error: "invalid_query_parameters";
1452
- };
1453
- };
1454
- };
1455
- /** @description The request is missing a valid Chadwin API key. */
1456
- 401: {
1457
- headers: {
1458
- [name: string]: unknown;
1459
- };
1460
- content: {
1461
- "application/json": components["schemas"]["ErrorResponse"];
1462
- };
1463
- };
1464
- /** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
1465
- 404: {
1466
- headers: {
1467
- [name: string]: unknown;
1468
- };
1469
- content: {
1470
- /**
1471
- * @example {
1472
- * "error": "company_not_found"
1473
- * }
1474
- */
1475
- "application/json": components["schemas"]["ErrorResponse"];
1476
- };
1477
- };
1478
- /** @description The ticker matches multiple CIKs. */
1479
- 409: {
1480
- headers: {
1481
- [name: string]: unknown;
1482
- };
1483
- content: {
1484
- "application/json": {
1485
- /** @enum {string} */
1486
- error: "company_ambiguous";
1487
- };
1488
- };
1489
- };
1490
- /** @description The request exceeded a rate limit. */
1491
- 429: {
1492
- headers: {
1493
- "RateLimit-Limit"?: string;
1494
- "RateLimit-Reset"?: string;
1495
- "Retry-After"?: string;
1496
- "X-Billing-Period-Quota-Limit"?: string;
1497
- "X-Billing-Period-Quota-Remaining"?: string;
1498
- "X-Billing-Period-Quota-Reset"?: string;
1499
- [name: string]: unknown;
1500
- };
1501
- content: {
1502
- /**
1503
- * @example {
1504
- * "error": "rate_limited"
1505
- * }
1506
- */
1507
- "application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
1508
- };
1509
- };
1510
- /** @description The database is unavailable. */
1511
- 503: {
1512
- headers: {
1513
- [name: string]: unknown;
1514
- };
1515
- content: {
1516
- /**
1517
- * @example {
1518
- * "error": "database_unavailable"
1519
- * }
1520
- */
1521
- "application/json": components["schemas"]["ErrorResponse"];
1522
- };
1523
- };
1524
- };
1525
- };
1526
- listCompanyInsiderTransactions: {
1527
- parameters: {
1528
- query: {
1529
- /** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
1530
- cursor?: string;
1531
- /** @description Rows per page from 1 through 1000. Defaults to 1000. */
1532
- limit?: string;
1533
- /** @description Optional comma-separated SEC insider transaction codes to include. Supported codes: A, C, D, E, F, G, H, I, J, K, L, M, O, P, S, U, V, W, X, Z. Omitted or empty means all supported codes. */
1534
- transaction_codes?: string;
1535
- /** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. */
1536
- from: string;
1537
- /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
1538
- until?: string;
1539
- };
1540
- header?: never;
1541
- path: {
1542
- /** @description US listed company ticker */
1543
- ticker: string;
1544
- };
1545
- cookie?: never;
1546
- };
1547
- requestBody?: never;
1548
- responses: {
1549
- /** @description Company insider transactions filed during the requested coverage window. */
1550
- 200: {
1551
- headers: {
1552
- "Cache-Control"?: string;
1553
- "X-Billing-Period-Quota-Limit"?: string;
1554
- "X-Billing-Period-Quota-Remaining"?: string;
1555
- "X-Billing-Period-Quota-Reset"?: string;
1556
- [name: string]: unknown;
1557
- };
1558
- content: {
1559
- /**
1560
- * @example {
1561
- * "has_more": false,
1562
- * "issuer": {
1563
- * "cik": "0000320193",
1564
- * "name": "Apple Inc.",
1565
- * "ticker": "AAPL"
1566
- * },
1567
- * "next_cursor": null,
1568
- * "transactions": [
1569
- * {
1570
- * "accepted_at": "2026-05-29T22:30:27.000Z",
1571
- * "accession_number": "0001140361-26-023363",
1572
- * "acquired_disposed_code": "D",
1573
- * "conversion_or_exercise_price": null,
1574
- * "deemed_execution_date": null,
1575
- * "equity_swap_involved": false,
1576
- * "exercise_date": null,
1577
- * "expiration_date": null,
1578
- * "field_footnote_ids": {
1579
- * "price": [
1580
- * "F1"
1581
- * ]
1582
- * },
1583
- * "footnote_ids": [
1584
- * "F1"
1585
- * ],
1586
- * "footnotes": [
1587
- * {
1588
- * "id": "F1",
1589
- * "text": "This transaction was executed in multiple trades at prices ranging from $310.76 to $311.42; the price reported above reflects the weighted average sale price. The reporting person hereby undertakes to provide full information regarding the number of shares and prices at which the transactions were effected upon request to the SEC staff, Apple, or a security holder of Apple."
1590
- * }
1591
- * ],
1592
- * "nature_of_ownership": null,
1593
- * "ownership_type": "direct",
1594
- * "price": "311.02",
1595
- * "reporting_owners": [
1596
- * {
1597
- * "address": {
1598
- * "city": "CUPERTINO",
1599
- * "country": null,
1600
- * "state": "CA",
1601
- * "street1": "ONE APPLE PARK WAY",
1602
- * "street2": null,
1603
- * "zip_code": "95014"
1604
- * },
1605
- * "cik": "0001214128",
1606
- * "name": "LEVINSON ARTHUR D",
1607
- * "relationship": {
1608
- * "is_director": true,
1609
- * "is_officer": null,
1610
- * "is_other": null,
1611
- * "is_ten_percent_owner": null,
1612
- * "officer_title": null,
1613
- * "other_text": null
1614
- * }
1615
- * }
1616
- * ],
1617
- * "row_kind": "nonderivative_transaction",
1618
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
1619
- * "security": "Common Stock",
1620
- * "shares": "50000",
1621
- * "shares_owned_after": "3764576",
1622
- * "source_row_index": 1,
1623
- * "transaction_code": "S",
1624
- * "transaction_date": "2026-05-27",
1625
- * "transaction_form_type": "4",
1626
- * "transaction_timeliness": null,
1627
- * "transaction_total_value": null,
1628
- * "underlying_security": null
1629
- * },
1630
- * {
1631
- * "accepted_at": "2026-05-29T22:30:27.000Z",
1632
- * "accession_number": "0001140361-26-023363",
1633
- * "acquired_disposed_code": "D",
1634
- * "conversion_or_exercise_price": null,
1635
- * "deemed_execution_date": null,
1636
- * "equity_swap_involved": false,
1637
- * "exercise_date": null,
1638
- * "expiration_date": null,
1639
- * "field_footnote_ids": {},
1640
- * "footnote_ids": [],
1641
- * "footnotes": [],
1642
- * "nature_of_ownership": null,
1643
- * "ownership_type": "direct",
1644
- * "price": "0",
1645
- * "reporting_owners": [
1646
- * {
1647
- * "address": {
1648
- * "city": "CUPERTINO",
1649
- * "country": null,
1650
- * "state": "CA",
1651
- * "street1": "ONE APPLE PARK WAY",
1652
- * "street2": null,
1653
- * "zip_code": "95014"
1654
- * },
1655
- * "cik": "0001214128",
1656
- * "name": "LEVINSON ARTHUR D",
1657
- * "relationship": {
1658
- * "is_director": true,
1659
- * "is_officer": null,
1660
- * "is_other": null,
1661
- * "is_ten_percent_owner": null,
1662
- * "officer_title": null,
1663
- * "other_text": null
1664
- * }
1665
- * }
1666
- * ],
1667
- * "row_kind": "nonderivative_transaction",
1668
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
1669
- * "security": "Common Stock",
1670
- * "shares": "65000",
1671
- * "shares_owned_after": "3699576",
1672
- * "source_row_index": 2,
1673
- * "transaction_code": "G",
1674
- * "transaction_date": "2026-05-27",
1675
- * "transaction_form_type": "4",
1676
- * "transaction_timeliness": null,
1677
- * "transaction_total_value": null,
1678
- * "underlying_security": null
1679
- * }
1680
- * ]
1681
- * }
1682
- */
1683
- "application/json": components["schemas"]["CompanyInsiderTransactionsResponse"];
1684
- };
1685
- };
1686
- /** @description The query parameters or pagination cursor are invalid. */
1687
- 400: {
1688
- headers: {
1689
- [name: string]: unknown;
1690
- };
1691
- content: {
1692
- "application/json": components["schemas"]["CompanyInsiderTransactionsBadRequestResponse"];
1693
- };
1694
- };
1695
- /** @description The request is missing a valid Chadwin API key. */
1696
- 401: {
1697
- headers: {
1698
- [name: string]: unknown;
1699
- };
1700
- content: {
1701
- "application/json": components["schemas"]["ErrorResponse"];
1702
- };
1703
- };
1704
- /** @description The subscription does not include this dataset. */
1705
- 403: {
1706
- headers: {
1707
- [name: string]: unknown;
1708
- };
1709
- content: {
1710
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1711
- };
1712
- };
1713
- /** @description The requested company ticker was not found. */
1714
- 404: {
1715
- headers: {
1716
- [name: string]: unknown;
1717
- };
1718
- content: {
1719
- "application/json": components["schemas"]["ErrorResponse"];
1720
- };
1721
- };
1722
- /** @description The request exceeded a rate limit. */
1723
- 429: {
1724
- headers: {
1725
- "RateLimit-Limit"?: string;
1726
- "RateLimit-Reset"?: string;
1727
- "Retry-After"?: string;
1728
- "X-Billing-Period-Quota-Limit"?: string;
1729
- "X-Billing-Period-Quota-Remaining"?: string;
1730
- "X-Billing-Period-Quota-Reset"?: string;
1731
- [name: string]: unknown;
1732
- };
1733
- content: {
1734
- "application/json": components["schemas"]["ErrorResponse"];
1735
- };
1736
- };
1737
- /** @description The database is unavailable. */
1738
- 503: {
1739
- headers: {
1740
- [name: string]: unknown;
1741
- };
1742
- content: {
1743
- "application/json": components["schemas"]["ErrorResponse"];
1744
- };
1745
- };
1746
- };
1747
- };
1748
- listCompanyProposedSales: {
1749
- parameters: {
1750
- query: {
1751
- /** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
1752
- cursor?: string;
1753
- /** @description Rows per page from 1 through 1000. Defaults to 1000. */
1754
- limit?: string;
1755
- from: string;
1756
- until?: string;
1757
- };
1758
- header?: never;
1759
- path: {
1760
- /** @description US listed company ticker */
1761
- ticker: string;
1762
- };
1763
- cookie?: never;
1764
- };
1765
- requestBody?: never;
1766
- responses: {
1767
- /** @description Form 144 proposed-sale rows */
1768
- 200: {
1769
- headers: {
1770
- "Cache-Control"?: string;
1771
- "X-Billing-Period-Quota-Limit"?: string;
1772
- "X-Billing-Period-Quota-Remaining"?: string;
1773
- "X-Billing-Period-Quota-Reset"?: string;
1774
- [name: string]: unknown;
1775
- };
1776
- content: {
1777
- /**
1778
- * @example {
1779
- * "has_more": false,
1780
- * "issuer": {
1781
- * "cik": "0000320193",
1782
- * "name": "Apple Inc.",
1783
- * "ticker": "AAPL"
1784
- * },
1785
- * "next_cursor": null,
1786
- * "proposed_sales": [
1787
- * {
1788
- * "accepted_at": "2026-07-29T18:04:05.000Z",
1789
- * "accession_number": "0001140361-26-030001",
1790
- * "amount": "100",
1791
- * "approximate_sale_date": "2026-07-30",
1792
- * "market_value": "20000.00",
1793
- * "reporting_person": {
1794
- * "cik": "0002100523",
1795
- * "name": "Example Reporting Person",
1796
- * "relationships": [
1797
- * "Officer"
1798
- * ]
1799
- * },
1800
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm",
1801
- * "security": "Common Stock",
1802
- * "source_row_index": 1
1803
- * }
1804
- * ]
1805
- * }
1806
- */
1807
- "application/json": components["schemas"]["CompanyProposedSalesResponse"];
1808
- };
1809
- };
1810
- /** @description The query parameters or pagination cursor are invalid */
1811
- 400: {
1812
- headers: {
1813
- [name: string]: unknown;
1814
- };
1815
- content: {
1816
- "application/json": {
1817
- /** @enum {string} */
1818
- error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_tickers" | "unsupported_cursor";
1819
- };
1820
- };
1821
- };
1822
- /** @description The request is missing a valid Chadwin API key. */
1823
- 401: {
1824
- headers: {
1825
- [name: string]: unknown;
1826
- };
1827
- content: {
1828
- "application/json": components["schemas"]["ErrorResponse"];
1829
- };
1830
- };
1831
- /** @description The subscription does not include this dataset. */
1832
- 403: {
1833
- headers: {
1834
- [name: string]: unknown;
1835
- };
1836
- content: {
1837
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1838
- };
1839
- };
1840
- /** @description The requested company was not found */
1841
- 404: {
1842
- headers: {
1843
- [name: string]: unknown;
1844
- };
1845
- content: {
1846
- "application/json": components["schemas"]["ErrorResponse"];
1847
- };
1848
- };
1849
- /** @description The request exceeded a rate limit. */
1850
- 429: {
1851
- headers: {
1852
- "RateLimit-Limit"?: string;
1853
- "RateLimit-Reset"?: string;
1854
- "Retry-After"?: string;
1855
- "X-Billing-Period-Quota-Limit"?: string;
1856
- "X-Billing-Period-Quota-Remaining"?: string;
1857
- "X-Billing-Period-Quota-Reset"?: string;
1858
- [name: string]: unknown;
1859
- };
1860
- content: {
1861
- "application/json": components["schemas"]["ErrorResponse"];
1862
- };
1863
- };
1864
- /** @description The database is unavailable */
1865
- 503: {
1866
- headers: {
1867
- [name: string]: unknown;
1868
- };
1869
- content: {
1870
- "application/json": components["schemas"]["ErrorResponse"];
1871
- };
1872
- };
1873
- };
1874
- };
1875
- getCompanyReport: {
1876
- parameters: {
1877
- query?: never;
1878
- header?: never;
1879
- path: {
1880
- ticker: string;
1881
- fiscal_year: string;
1882
- };
1883
- cookie?: never;
1884
- };
1885
- requestBody?: never;
1886
- responses: {
1887
- /** @description Annual report filing family */
1888
- 200: {
1889
- headers: {
1890
- "Cache-Control"?: string;
1891
- ETag?: string;
1892
- "X-Billing-Period-Quota-Limit"?: string;
1893
- "X-Billing-Period-Quota-Remaining"?: string;
1894
- "X-Billing-Period-Quota-Reset"?: string;
1895
- [name: string]: unknown;
1896
- };
1897
- content: {
1898
- /**
1899
- * @example {
1900
- * "filings": [
1901
- * {
1902
- * "accepted_at": "2024-11-01T10:00:00.000Z",
1903
- * "accession_number": "0000320193-24-000123",
1904
- * "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
1905
- * "form": "10-K",
1906
- * "period_end_date": "2024-09-28",
1907
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
1908
- * }
1909
- * ],
1910
- * "fiscal_period": "FY",
1911
- * "fiscal_year": 2024,
1912
- * "issuer": {
1913
- * "cik": "0000320193",
1914
- * "name": "Apple Inc.",
1915
- * "ticker": "AAPL"
1916
- * }
1917
- * }
1918
- */
1919
- "application/json": components["schemas"]["CompanyReportFamilyResponse"];
1920
- };
1921
- };
1922
- /** @description The ticker or fiscal year is invalid */
1923
- 400: {
1924
- headers: {
1925
- [name: string]: unknown;
1926
- };
1927
- content: {
1928
- "application/json": components["schemas"]["ErrorResponse"];
1929
- };
1930
- };
1931
- /** @description The request is missing a valid Chadwin API key. */
1932
- 401: {
1933
- headers: {
1934
- [name: string]: unknown;
1935
- };
1936
- content: {
1937
- "application/json": components["schemas"]["ErrorResponse"];
1938
- };
1939
- };
1940
- /** @description The subscription does not include this dataset. */
1941
- 403: {
1942
- headers: {
1943
- [name: string]: unknown;
1944
- };
1945
- content: {
1946
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1947
- };
1948
- };
1949
- /** @description The company or eligible annual report was not found */
1950
- 404: {
1951
- headers: {
1952
- [name: string]: unknown;
1953
- };
1954
- content: {
1955
- "application/json": components["schemas"]["ErrorResponse"];
1956
- };
1957
- };
1958
- /** @description More than one original annual report matches the fiscal year */
1959
- 409: {
1960
- headers: {
1961
- [name: string]: unknown;
1962
- };
1963
- content: {
1964
- "application/json": components["schemas"]["ErrorResponse"];
1965
- };
1966
- };
1967
- /** @description The request exceeded a rate limit. */
1968
- 429: {
1969
- headers: {
1970
- "RateLimit-Limit"?: string;
1971
- "RateLimit-Reset"?: string;
1972
- "Retry-After"?: string;
1973
- "X-Billing-Period-Quota-Limit"?: string;
1974
- "X-Billing-Period-Quota-Remaining"?: string;
1975
- "X-Billing-Period-Quota-Reset"?: string;
1976
- [name: string]: unknown;
1977
- };
1978
- content: {
1979
- "application/json": components["schemas"]["ErrorResponse"];
1980
- };
1981
- };
1982
- /** @description The filing catalog is unavailable */
1983
- 503: {
1984
- headers: {
1985
- [name: string]: unknown;
1986
- };
1987
- content: {
1988
- "application/json": components["schemas"]["ErrorResponse"];
1989
- };
1990
- };
1991
- };
1992
- };
1993
- getCompanyReportForFiscalPeriod: {
1994
- parameters: {
1995
- query?: never;
1996
- header?: never;
1997
- path: {
1998
- ticker: string;
1999
- fiscal_year: string;
2000
- fiscal_period: "Q1" | "Q2" | "Q3";
2001
- };
2002
- cookie?: never;
2003
- };
2004
- requestBody?: never;
2005
- responses: {
2006
- /** @description Quarterly report filing family */
2007
- 200: {
2008
- headers: {
2009
- "Cache-Control"?: string;
2010
- ETag?: string;
2011
- "X-Billing-Period-Quota-Limit"?: string;
2012
- "X-Billing-Period-Quota-Remaining"?: string;
2013
- "X-Billing-Period-Quota-Reset"?: string;
2014
- [name: string]: unknown;
2015
- };
2016
- content: {
2017
- /**
2018
- * @example {
2019
- * "filings": [
2020
- * {
2021
- * "accepted_at": "2025-08-01T10:00:42.000Z",
2022
- * "accession_number": "0000320193-25-000073",
2023
- * "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
2024
- * "form": "10-Q",
2025
- * "period_end_date": "2025-06-28",
2026
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
2027
- * }
2028
- * ],
2029
- * "fiscal_period": "Q3",
2030
- * "fiscal_year": 2025,
2031
- * "issuer": {
2032
- * "cik": "0000320193",
2033
- * "name": "Apple Inc.",
2034
- * "ticker": "AAPL"
2035
- * }
2036
- * }
2037
- */
2038
- "application/json": components["schemas"]["CompanyReportFamilyResponse"];
2039
- };
2040
- };
2041
- /** @description The ticker, fiscal year, or fiscal period is invalid */
2042
- 400: {
2043
- headers: {
2044
- [name: string]: unknown;
2045
- };
2046
- content: {
2047
- "application/json": components["schemas"]["ErrorResponse"];
2048
- };
2049
- };
2050
- /** @description The request is missing a valid Chadwin API key. */
2051
- 401: {
2052
- headers: {
2053
- [name: string]: unknown;
2054
- };
2055
- content: {
2056
- "application/json": components["schemas"]["ErrorResponse"];
2057
- };
2058
- };
2059
- /** @description The subscription does not include this dataset. */
2060
- 403: {
2061
- headers: {
2062
- [name: string]: unknown;
2063
- };
2064
- content: {
2065
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2066
- };
2067
- };
2068
- /** @description The company or eligible quarterly report was not found */
2069
- 404: {
2070
- headers: {
2071
- [name: string]: unknown;
2072
- };
2073
- content: {
2074
- "application/json": components["schemas"]["ErrorResponse"];
2075
- };
2076
- };
2077
- /** @description More than one original quarterly report matches the fiscal period */
2078
- 409: {
2079
- headers: {
2080
- [name: string]: unknown;
2081
- };
2082
- content: {
2083
- "application/json": components["schemas"]["ErrorResponse"];
2084
- };
2085
- };
2086
- /** @description The request exceeded a rate limit. */
2087
- 429: {
2088
- headers: {
2089
- "RateLimit-Limit"?: string;
2090
- "RateLimit-Reset"?: string;
2091
- "Retry-After"?: string;
2092
- "X-Billing-Period-Quota-Limit"?: string;
2093
- "X-Billing-Period-Quota-Remaining"?: string;
2094
- "X-Billing-Period-Quota-Reset"?: string;
2095
- [name: string]: unknown;
2096
- };
2097
- content: {
2098
- "application/json": components["schemas"]["ErrorResponse"];
2099
- };
2100
- };
2101
- /** @description The filing catalog is unavailable */
2102
- 503: {
2103
- headers: {
2104
- [name: string]: unknown;
2105
- };
2106
- content: {
2107
- "application/json": components["schemas"]["ErrorResponse"];
2108
- };
2109
- };
2110
- };
2111
- };
2112
- getCompanyReportByCik: {
2113
- parameters: {
2114
- query?: never;
2115
- header?: never;
2116
- path: {
2117
- fiscal_year: string;
2118
- /** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
2119
- cik: string;
2120
- };
2121
- cookie?: never;
2122
- };
2123
- requestBody?: never;
2124
- responses: {
2125
- /** @description Annual report filing family */
2126
- 200: {
2127
- headers: {
2128
- "Cache-Control"?: string;
2129
- ETag?: string;
2130
- "X-Billing-Period-Quota-Limit"?: string;
2131
- "X-Billing-Period-Quota-Remaining"?: string;
2132
- "X-Billing-Period-Quota-Reset"?: string;
2133
- [name: string]: unknown;
2134
- };
2135
- content: {
2136
- /**
2137
- * @example {
2138
- * "filings": [
2139
- * {
2140
- * "accepted_at": "2024-11-01T10:00:00.000Z",
2141
- * "accession_number": "0000320193-24-000123",
2142
- * "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
2143
- * "form": "10-K",
2144
- * "period_end_date": "2024-09-28",
2145
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
2146
- * }
2147
- * ],
2148
- * "fiscal_period": "FY",
2149
- * "fiscal_year": 2024,
2150
- * "issuer": {
2151
- * "cik": "0000320193",
2152
- * "name": "Apple Inc.",
2153
- * "ticker": "AAPL"
2154
- * }
2155
- * }
2156
- */
2157
- "application/json": components["schemas"]["CompanyReportFamilyResponse"];
2158
- };
2159
- };
2160
- /** @description The cik or fiscal year is invalid */
2161
- 400: {
2162
- headers: {
2163
- [name: string]: unknown;
2164
- };
2165
- content: {
2166
- "application/json": components["schemas"]["ErrorResponse"];
2167
- };
2168
- };
2169
- /** @description The request is missing a valid Chadwin API key. */
2170
- 401: {
2171
- headers: {
2172
- [name: string]: unknown;
2173
- };
2174
- content: {
2175
- "application/json": components["schemas"]["ErrorResponse"];
2176
- };
2177
- };
2178
- /** @description The subscription does not include this dataset. */
2179
- 403: {
2180
- headers: {
2181
- [name: string]: unknown;
2182
- };
2183
- content: {
2184
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2185
- };
2186
- };
2187
- /** @description The company or eligible annual report was not found */
2188
- 404: {
2189
- headers: {
2190
- [name: string]: unknown;
2191
- };
2192
- content: {
2193
- "application/json": components["schemas"]["ErrorResponse"];
2194
- };
2195
- };
2196
- /** @description More than one original annual report matches the fiscal year */
2197
- 409: {
2198
- headers: {
2199
- [name: string]: unknown;
2200
- };
2201
- content: {
2202
- "application/json": components["schemas"]["ErrorResponse"];
2203
- };
2204
- };
2205
- /** @description The request exceeded a rate limit. */
2206
- 429: {
2207
- headers: {
2208
- "RateLimit-Limit"?: string;
2209
- "RateLimit-Reset"?: string;
2210
- "Retry-After"?: string;
2211
- "X-Billing-Period-Quota-Limit"?: string;
2212
- "X-Billing-Period-Quota-Remaining"?: string;
2213
- "X-Billing-Period-Quota-Reset"?: string;
2214
- [name: string]: unknown;
2215
- };
2216
- content: {
2217
- "application/json": components["schemas"]["ErrorResponse"];
2218
- };
2219
- };
2220
- /** @description The filing catalog is unavailable */
2221
- 503: {
2222
- headers: {
2223
- [name: string]: unknown;
2224
- };
2225
- content: {
2226
- "application/json": components["schemas"]["ErrorResponse"];
2227
- };
2228
- };
2229
- };
2230
- };
2231
- getCompanyReportByCikForFiscalPeriod: {
2232
- parameters: {
2233
- query?: never;
2234
- header?: never;
2235
- path: {
2236
- fiscal_year: string;
2237
- /** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
2238
- cik: string;
2239
- fiscal_period: "Q1" | "Q2" | "Q3";
1266
+ /** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
1267
+ ticker?: string;
1268
+ /** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
1269
+ cik?: string;
2240
1270
  };
1271
+ header?: never;
1272
+ path?: never;
2241
1273
  cookie?: never;
2242
1274
  };
2243
1275
  requestBody?: never;
2244
1276
  responses: {
2245
- /** @description Quarterly report filing family */
1277
+ /** @description Company reference details. */
2246
1278
  200: {
2247
1279
  headers: {
2248
1280
  "Cache-Control"?: string;
2249
- ETag?: string;
2250
1281
  "X-Billing-Period-Quota-Limit"?: string;
2251
1282
  "X-Billing-Period-Quota-Remaining"?: string;
2252
1283
  "X-Billing-Period-Quota-Reset"?: string;
@@ -2255,35 +1286,39 @@ interface operations {
2255
1286
  content: {
2256
1287
  /**
2257
1288
  * @example {
2258
- * "filings": [
2259
- * {
2260
- * "accepted_at": "2025-08-01T10:00:42.000Z",
2261
- * "accession_number": "0000320193-25-000073",
2262
- * "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
2263
- * "form": "10-Q",
2264
- * "period_end_date": "2025-06-28",
2265
- * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
1289
+ * "company": {
1290
+ * "cik": "0000051143",
1291
+ * "fiscal_year_end": "1231",
1292
+ * "listings": [
1293
+ * {
1294
+ * "exchange": "NYSE",
1295
+ * "is_current": true,
1296
+ * "share_class_figi": "BBG001S5S399",
1297
+ * "ticker": "IBM"
1298
+ * }
1299
+ * ],
1300
+ * "name": "International Business Machines Corporation",
1301
+ * "sic": {
1302
+ * "code": "3570",
1303
+ * "industry_title": "COMPUTER & OFFICE EQUIPMENT",
1304
+ * "office": "Office of Technology"
2266
1305
  * }
2267
- * ],
2268
- * "fiscal_period": "Q3",
2269
- * "fiscal_year": 2025,
2270
- * "issuer": {
2271
- * "cik": "0000320193",
2272
- * "name": "Apple Inc.",
2273
- * "ticker": "AAPL"
2274
1306
  * }
2275
1307
  * }
2276
1308
  */
2277
- "application/json": components["schemas"]["CompanyReportFamilyResponse"];
1309
+ "application/json": components["schemas"]["CompanyReferenceResponse"];
2278
1310
  };
2279
1311
  };
2280
- /** @description The cik, fiscal year, or fiscal period is invalid */
1312
+ /** @description Supply exactly one valid ticker or CIK and no other query keys. */
2281
1313
  400: {
2282
1314
  headers: {
2283
1315
  [name: string]: unknown;
2284
1316
  };
2285
1317
  content: {
2286
- "application/json": components["schemas"]["ErrorResponse"];
1318
+ "application/json": {
1319
+ /** @enum {string} */
1320
+ error: "invalid_query_parameters";
1321
+ };
2287
1322
  };
2288
1323
  };
2289
1324
  /** @description The request is missing a valid Chadwin API key. */
@@ -2295,31 +1330,30 @@ interface operations {
2295
1330
  "application/json": components["schemas"]["ErrorResponse"];
2296
1331
  };
2297
1332
  };
2298
- /** @description The subscription does not include this dataset. */
2299
- 403: {
2300
- headers: {
2301
- [name: string]: unknown;
2302
- };
2303
- content: {
2304
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2305
- };
2306
- };
2307
- /** @description The company or eligible quarterly report was not found */
1333
+ /** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
2308
1334
  404: {
2309
1335
  headers: {
2310
1336
  [name: string]: unknown;
2311
1337
  };
2312
1338
  content: {
1339
+ /**
1340
+ * @example {
1341
+ * "error": "company_not_found"
1342
+ * }
1343
+ */
2313
1344
  "application/json": components["schemas"]["ErrorResponse"];
2314
1345
  };
2315
1346
  };
2316
- /** @description More than one original quarterly report matches the fiscal period */
1347
+ /** @description The ticker matches multiple CIKs. */
2317
1348
  409: {
2318
1349
  headers: {
2319
1350
  [name: string]: unknown;
2320
1351
  };
2321
1352
  content: {
2322
- "application/json": components["schemas"]["ErrorResponse"];
1353
+ "application/json": {
1354
+ /** @enum {string} */
1355
+ error: "company_ambiguous";
1356
+ };
2323
1357
  };
2324
1358
  };
2325
1359
  /** @description The request exceeded a rate limit. */
@@ -2334,15 +1368,25 @@ interface operations {
2334
1368
  [name: string]: unknown;
2335
1369
  };
2336
1370
  content: {
2337
- "application/json": components["schemas"]["ErrorResponse"];
1371
+ /**
1372
+ * @example {
1373
+ * "error": "rate_limited"
1374
+ * }
1375
+ */
1376
+ "application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
2338
1377
  };
2339
1378
  };
2340
- /** @description The filing catalog is unavailable */
1379
+ /** @description The database is unavailable. */
2341
1380
  503: {
2342
1381
  headers: {
2343
1382
  [name: string]: unknown;
2344
1383
  };
2345
1384
  content: {
1385
+ /**
1386
+ * @example {
1387
+ * "error": "database_unavailable"
1388
+ * }
1389
+ */
2346
1390
  "application/json": components["schemas"]["ErrorResponse"];
2347
1391
  };
2348
1392
  };
@@ -2541,6 +1585,139 @@ interface operations {
2541
1585
  };
2542
1586
  };
2543
1587
  };
1588
+ getCompanyReportsForPeriod: {
1589
+ parameters: {
1590
+ query: {
1591
+ /** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
1592
+ ticker?: string;
1593
+ /** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
1594
+ cik?: string;
1595
+ /** @description Required four-digit fiscal year, from 1900 through 9999. */
1596
+ fiscal_year: string;
1597
+ /** @description Required FY for annual reports, or Q1, Q2 or Q3 for quarterly reports. FY is not Q4. */
1598
+ fiscal_period: "FY" | "Q1" | "Q2" | "Q3";
1599
+ };
1600
+ header?: never;
1601
+ path?: never;
1602
+ cookie?: never;
1603
+ };
1604
+ requestBody?: never;
1605
+ responses: {
1606
+ /** @description Original report and subsequent amendments */
1607
+ 200: {
1608
+ headers: {
1609
+ "Cache-Control"?: string;
1610
+ ETag?: string;
1611
+ "X-Billing-Period-Quota-Limit"?: string;
1612
+ "X-Billing-Period-Quota-Remaining"?: string;
1613
+ "X-Billing-Period-Quota-Reset"?: string;
1614
+ [name: string]: unknown;
1615
+ };
1616
+ content: {
1617
+ /**
1618
+ * @example {
1619
+ * "filings": [
1620
+ * {
1621
+ * "accepted_at": "2024-11-01T10:00:00.000Z",
1622
+ * "accession_number": "0000320193-24-000123",
1623
+ * "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
1624
+ * "form": "10-K",
1625
+ * "period_end_date": "2024-09-28",
1626
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
1627
+ * }
1628
+ * ],
1629
+ * "fiscal_period": "FY",
1630
+ * "fiscal_year": 2024,
1631
+ * "issuer": {
1632
+ * "cik": "0000320193",
1633
+ * "name": "Apple Inc.",
1634
+ * "ticker": "AAPL"
1635
+ * }
1636
+ * }
1637
+ */
1638
+ "application/json": components["schemas"]["CompanyReportFamilyResponse"];
1639
+ };
1640
+ };
1641
+ /** @description Supply one identifier, a valid fiscal year and FY, Q1, Q2 or Q3; no extra or repeated keys. */
1642
+ 400: {
1643
+ headers: {
1644
+ [name: string]: unknown;
1645
+ };
1646
+ content: {
1647
+ "application/json": {
1648
+ /** @enum {string} */
1649
+ error: "invalid_query_parameters";
1650
+ };
1651
+ };
1652
+ };
1653
+ /** @description The request is missing a valid Chadwin API key. */
1654
+ 401: {
1655
+ headers: {
1656
+ [name: string]: unknown;
1657
+ };
1658
+ content: {
1659
+ "application/json": components["schemas"]["ErrorResponse"];
1660
+ };
1661
+ };
1662
+ /** @description The subscription does not include this dataset. */
1663
+ 403: {
1664
+ headers: {
1665
+ [name: string]: unknown;
1666
+ };
1667
+ content: {
1668
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1669
+ };
1670
+ };
1671
+ /** @description The ticker is unresolved or no eligible report family exists. */
1672
+ 404: {
1673
+ headers: {
1674
+ [name: string]: unknown;
1675
+ };
1676
+ content: {
1677
+ "application/json": {
1678
+ /** @enum {string} */
1679
+ error: "company_not_found" | "company_report_not_found";
1680
+ };
1681
+ };
1682
+ };
1683
+ /** @description The ticker matches multiple CIKs or multiple original reports match the selected period. */
1684
+ 409: {
1685
+ headers: {
1686
+ [name: string]: unknown;
1687
+ };
1688
+ content: {
1689
+ "application/json": {
1690
+ /** @enum {string} */
1691
+ error: "company_ambiguous" | "company_report_ambiguous";
1692
+ };
1693
+ };
1694
+ };
1695
+ /** @description The request exceeded a rate limit. */
1696
+ 429: {
1697
+ headers: {
1698
+ "RateLimit-Limit"?: string;
1699
+ "RateLimit-Reset"?: string;
1700
+ "Retry-After"?: string;
1701
+ "X-Billing-Period-Quota-Limit"?: string;
1702
+ "X-Billing-Period-Quota-Remaining"?: string;
1703
+ "X-Billing-Period-Quota-Reset"?: string;
1704
+ [name: string]: unknown;
1705
+ };
1706
+ content: {
1707
+ "application/json": components["schemas"]["ErrorResponse"];
1708
+ };
1709
+ };
1710
+ /** @description The filing catalog is unavailable */
1711
+ 503: {
1712
+ headers: {
1713
+ [name: string]: unknown;
1714
+ };
1715
+ content: {
1716
+ "application/json": components["schemas"]["ErrorResponse"];
1717
+ };
1718
+ };
1719
+ };
1720
+ };
2544
1721
  searchCompanies: {
2545
1722
  parameters: {
2546
1723
  query: {
@@ -2888,7 +2065,9 @@ interface operations {
2888
2065
  from: string;
2889
2066
  /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
2890
2067
  until?: string;
2891
- /** @description Optional comma-separated US listed ticker filter. */
2068
+ /** @description Optional filing entity CIKs. Mutually exclusive with tickers; reference rows are not required. */
2069
+ ciks?: string;
2070
+ /** @description Optional comma-separated ticker filter. Mutually exclusive with ciks. */
2892
2071
  tickers?: string;
2893
2072
  };
2894
2073
  header?: never;
@@ -3066,6 +2245,24 @@ interface operations {
3066
2245
  "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3067
2246
  };
3068
2247
  };
2248
+ /** @description A ticker was not found */
2249
+ 404: {
2250
+ headers: {
2251
+ [name: string]: unknown;
2252
+ };
2253
+ content: {
2254
+ "application/json": components["schemas"]["ErrorResponse"];
2255
+ };
2256
+ };
2257
+ /** @description A ticker resolves to multiple companies */
2258
+ 409: {
2259
+ headers: {
2260
+ [name: string]: unknown;
2261
+ };
2262
+ content: {
2263
+ "application/json": components["schemas"]["ErrorResponse"];
2264
+ };
2265
+ };
3069
2266
  /** @description The request exceeded a rate limit. */
3070
2267
  429: {
3071
2268
  headers: {
@@ -3970,13 +3167,16 @@ interface operations {
3970
3167
  listProposedSales: {
3971
3168
  parameters: {
3972
3169
  query: {
3973
- /** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
3170
+ /** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. Old cursors or changed ticker resolution return invalid_cursor; restart from the first page. */
3974
3171
  cursor?: string;
3975
3172
  /** @description Rows per page from 1 through 1000. Defaults to 1000. */
3976
3173
  limit?: string;
3977
3174
  from: string;
3978
3175
  until?: string;
3176
+ /** @description Company tickers; mutually exclusive with ciks. */
3979
3177
  tickers?: string;
3178
+ /** @description Filing entity CIKs; mutually exclusive with tickers. Reference rows are not required. */
3179
+ ciks?: string;
3980
3180
  };
3981
3181
  header?: never;
3982
3182
  path?: never;
@@ -4035,7 +3235,7 @@ interface operations {
4035
3235
  content: {
4036
3236
  "application/json": {
4037
3237
  /** @enum {string} */
4038
- error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_tickers" | "unsupported_cursor";
3238
+ error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_query_parameters";
4039
3239
  };
4040
3240
  };
4041
3241
  };
@@ -4057,6 +3257,24 @@ interface operations {
4057
3257
  "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
4058
3258
  };
4059
3259
  };
3260
+ /** @description A ticker was not found */
3261
+ 404: {
3262
+ headers: {
3263
+ [name: string]: unknown;
3264
+ };
3265
+ content: {
3266
+ "application/json": components["schemas"]["ErrorResponse"];
3267
+ };
3268
+ };
3269
+ /** @description A ticker resolves to multiple companies */
3270
+ 409: {
3271
+ headers: {
3272
+ [name: string]: unknown;
3273
+ };
3274
+ content: {
3275
+ "application/json": components["schemas"]["ErrorResponse"];
3276
+ };
3277
+ };
4060
3278
  /** @description The request exceeded a rate limit. */
4061
3279
  429: {
4062
3280
  headers: {
@@ -4900,7 +4118,7 @@ interface operations {
4900
4118
  }
4901
4119
 
4902
4120
  type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
4903
- type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
4121
+ type CompanyReportFiscalPeriod = "FY" | "Q1" | "Q2" | "Q3";
4904
4122
  type CompanySelector = {
4905
4123
  ticker: string;
4906
4124
  cik?: never;
@@ -5040,18 +4258,13 @@ declare class Companies {
5040
4258
  declare class CompanyReports {
5041
4259
  private readonly transport;
5042
4260
  constructor(transport: HttpTransport);
5043
- get({ accessionNumber, }: {
4261
+ getByAccession({ accessionNumber, }: {
5044
4262
  accessionNumber: string;
5045
4263
  }): PromiseWithResponse<JsonResponse<"getSecCompanyReport">>;
5046
- getByFiscalYear({ ticker, fiscalYear, }: {
5047
- ticker: string;
5048
- fiscalYear: number;
5049
- }): PromiseWithResponse<JsonResponse<"getCompanyReport">>;
5050
- getByFiscalPeriod({ ticker, fiscalYear, fiscalPeriod, }: {
5051
- ticker: string;
4264
+ get({ ticker, cik, fiscalYear, fiscalPeriod }: CompanySelector & {
5052
4265
  fiscalYear: number;
5053
4266
  fiscalPeriod: CompanyReportFiscalPeriod;
5054
- }): PromiseWithResponse<JsonResponse<"getCompanyReportForFiscalPeriod">>;
4267
+ }): PromiseWithResponse<JsonResponse<"getCompanyReportsForPeriod">>;
5055
4268
  getHtml({ accessionNumber, }: {
5056
4269
  accessionNumber: string;
5057
4270
  }): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
@@ -5064,36 +4277,23 @@ declare class FinancialStatements {
5064
4277
  declare class InsiderTransactions {
5065
4278
  private readonly transport;
5066
4279
  constructor(transport: HttpTransport);
5067
- list({ cursor, from, limit, until, tickers, transactionCodes, }: {
4280
+ list({ cursor, from, limit, until, tickers, ciks, transactionCodes, }: {
5068
4281
  cursor?: string;
5069
4282
  from: string;
5070
4283
  limit?: number;
5071
4284
  until?: string;
5072
4285
  tickers?: string[];
4286
+ ciks?: string[];
5073
4287
  transactionCodes?: InsiderTransactionCode[];
5074
4288
  }): PromiseWithResponse<JsonResponse<"listInsiderTransactions">>;
5075
- listForCompany({ cursor, ticker, from, limit, until, transactionCodes, }: {
5076
- cursor?: string;
5077
- ticker: string;
5078
- from: string;
5079
- limit?: number;
5080
- until?: string;
5081
- transactionCodes?: InsiderTransactionCode[];
5082
- }): PromiseWithResponse<JsonResponse<"listCompanyInsiderTransactions">>;
5083
- iterate({ from, until, tickers, transactionCodes, limit, }: {
4289
+ iterate({ from, until, tickers, ciks, transactionCodes, limit, }: {
5084
4290
  from: string;
5085
4291
  until?: string;
5086
4292
  tickers?: string[];
4293
+ ciks?: string[];
5087
4294
  transactionCodes?: InsiderTransactionCode[];
5088
4295
  limit?: number;
5089
4296
  }): AsyncGenerator<JsonResponse<"listInsiderTransactions">["transactions"][number]>;
5090
- iterateForCompany({ ticker, from, until, transactionCodes, limit, }: {
5091
- ticker: string;
5092
- from: string;
5093
- until?: string;
5094
- transactionCodes?: InsiderTransactionCode[];
5095
- limit?: number;
5096
- }): AsyncGenerator<JsonResponse<"listCompanyInsiderTransactions">["transactions"][number]>;
5097
4297
  }
5098
4298
  declare class InsiderFilings {
5099
4299
  private readonly transport;
@@ -5105,32 +4305,21 @@ declare class InsiderFilings {
5105
4305
  declare class ProposedSales {
5106
4306
  private readonly transport;
5107
4307
  constructor(transport: HttpTransport);
5108
- list({ cursor, from, limit, until, tickers, }: {
4308
+ list({ cursor, from, limit, until, tickers, ciks, }: {
5109
4309
  cursor?: string;
5110
4310
  from: string;
5111
4311
  limit?: number;
5112
4312
  until?: string;
5113
4313
  tickers?: string[];
4314
+ ciks?: string[];
5114
4315
  }): PromiseWithResponse<JsonResponse<"listProposedSales">>;
5115
- listForCompany({ cursor, ticker, from, limit, until, }: {
5116
- cursor?: string;
5117
- ticker: string;
5118
- from: string;
5119
- limit?: number;
5120
- until?: string;
5121
- }): PromiseWithResponse<JsonResponse<"listCompanyProposedSales">>;
5122
- iterate({ from, until, tickers, limit, }: {
4316
+ iterate({ from, until, tickers, ciks, limit, }: {
5123
4317
  from: string;
5124
4318
  until?: string;
5125
4319
  tickers?: string[];
4320
+ ciks?: string[];
5126
4321
  limit?: number;
5127
4322
  }): AsyncGenerator<JsonResponse<"listProposedSales">["proposed_sales"][number]>;
5128
- iterateForCompany({ ticker, from, until, limit, }: {
5129
- ticker: string;
5130
- from: string;
5131
- until?: string;
5132
- limit?: number;
5133
- }): AsyncGenerator<JsonResponse<"listCompanyProposedSales">["proposed_sales"][number]>;
5134
4323
  getFiling({ accessionNumber, }: {
5135
4324
  accessionNumber: string;
5136
4325
  }): PromiseWithResponse<JsonResponse<"getSecProposedSaleFiling">>;