@chadwin/sdk 0.9.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.
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;
@@ -1284,487 +1153,128 @@ interface components {
1284
1153
  amount: string;
1285
1154
  amount_outstanding: string;
1286
1155
  approximate_sale_date: string;
1287
- broker_or_market_maker: string;
1288
- intended_sale_exchange: string;
1289
- market_value: string;
1290
- security: string;
1291
- source_row_index: number;
1292
- }[];
1293
- remarks: string | null;
1294
- reporting_person: {
1295
- cik: string;
1296
- name: string;
1297
- relationships: string[];
1298
- };
1299
- sec_url: string;
1300
- securities_to_be_sold: {
1301
- acquired_from: string | null;
1302
- acquisition_date: string;
1303
- acquisition_method: string;
1304
- amount: string;
1305
- donor_acquisition_date: string | null;
1306
- is_gift: boolean;
1307
- payment_date: string | null;
1308
- payment_method: string;
1309
- security: string;
1310
- source_row_index: number;
1311
- }[];
1312
- };
1313
- ProposedSaleNoticeActivity: {
1314
- /**
1315
- * Format: date-time
1316
- * @example 2026-07-31T14:06:12.000Z
1317
- */
1318
- accepted_at: string;
1319
- /** @example 0001140361-26-030001 */
1320
- accession_number: string;
1321
- /** @example 100 */
1322
- amount: string;
1323
- /** @example 2026-08-03 */
1324
- approximate_sale_date: string;
1325
- /**
1326
- * @description Stable idempotency key for this proposed-sale activity.
1327
- * @example pse_000000000203
1328
- */
1329
- feed_event_id: string;
1330
- /**
1331
- * @example 144
1332
- * @enum {string}
1333
- */
1334
- form: "144" | "144/A";
1335
- issuer: components["schemas"]["InsiderIssuer"];
1336
- /** @example 20000.00 */
1337
- market_value: string;
1338
- /**
1339
- * Format: date-time
1340
- * @example 2026-07-31T14:07:00.000Z
1341
- */
1342
- published_at: string;
1343
- reporting_person: {
1344
- /** @example 0002100523 */
1345
- cik: string;
1346
- /** @example Example Reporting Person */
1347
- name: string;
1348
- /**
1349
- * @example [
1350
- * "Officer"
1351
- * ]
1352
- */
1353
- relationships: string[];
1354
- };
1355
- /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm */
1356
- sec_url: string;
1357
- /** @example Common Stock */
1358
- security: string;
1359
- /** @example 1 */
1360
- source_row_index: number;
1361
- };
1362
- ProposedSalesResponse: {
1363
- has_more: boolean;
1364
- next_cursor: string | null;
1365
- proposed_sales: {
1366
- accepted_at: string;
1367
- accession_number: string;
1368
- amount: string;
1369
- approximate_sale_date: string;
1370
- issuer: {
1371
- cik: string;
1372
- name: string;
1373
- ticker: string | null;
1374
- };
1375
- market_value: string;
1376
- reporting_person: {
1377
- cik: string;
1378
- name: string;
1379
- relationships: string[];
1380
- };
1381
- sec_url: string;
1382
- security: string;
1383
- source_row_index: number;
1384
- }[];
1385
- };
1386
- };
1387
- responses: never;
1388
- parameters: never;
1389
- requestBodies: never;
1390
- headers: never;
1391
- pathItems: never;
1392
- }
1393
- interface operations {
1394
- getCompany: {
1395
- parameters: {
1396
- 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
- };
1156
+ broker_or_market_maker: string;
1157
+ intended_sale_exchange: string;
1158
+ market_value: string;
1159
+ security: string;
1160
+ source_row_index: number;
1161
+ }[];
1162
+ remarks: string | null;
1163
+ reporting_person: {
1164
+ cik: string;
1165
+ name: string;
1166
+ relationships: string[];
1736
1167
  };
1737
- /** @description The database is unavailable. */
1738
- 503: {
1739
- headers: {
1740
- [name: string]: unknown;
1168
+ sec_url: string;
1169
+ securities_to_be_sold: {
1170
+ acquired_from: string | null;
1171
+ acquisition_date: string;
1172
+ acquisition_method: string;
1173
+ amount: string;
1174
+ donor_acquisition_date: string | null;
1175
+ is_gift: boolean;
1176
+ payment_date: string | null;
1177
+ payment_method: string;
1178
+ security: string;
1179
+ source_row_index: number;
1180
+ }[];
1181
+ };
1182
+ ProposedSaleNoticeActivity: {
1183
+ /**
1184
+ * Format: date-time
1185
+ * @example 2026-07-31T14:06:12.000Z
1186
+ */
1187
+ accepted_at: string;
1188
+ /** @example 0001140361-26-030001 */
1189
+ accession_number: string;
1190
+ /** @example 100 */
1191
+ amount: string;
1192
+ /** @example 2026-08-03 */
1193
+ approximate_sale_date: string;
1194
+ /**
1195
+ * @description Stable idempotency key for this proposed-sale activity.
1196
+ * @example pse_000000000203
1197
+ */
1198
+ feed_event_id: string;
1199
+ /**
1200
+ * @example 144
1201
+ * @enum {string}
1202
+ */
1203
+ form: "144" | "144/A";
1204
+ issuer: components["schemas"]["InsiderIssuer"];
1205
+ /** @example 20000.00 */
1206
+ market_value: string;
1207
+ /**
1208
+ * Format: date-time
1209
+ * @example 2026-07-31T14:07:00.000Z
1210
+ */
1211
+ published_at: string;
1212
+ reporting_person: {
1213
+ /** @example 0002100523 */
1214
+ cik: string;
1215
+ /** @example Example Reporting Person */
1216
+ name: string;
1217
+ /**
1218
+ * @example [
1219
+ * "Officer"
1220
+ * ]
1221
+ */
1222
+ relationships: string[];
1223
+ };
1224
+ /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm */
1225
+ sec_url: string;
1226
+ /** @example Common Stock */
1227
+ security: string;
1228
+ /** @example 1 */
1229
+ source_row_index: number;
1230
+ };
1231
+ ProposedSalesResponse: {
1232
+ has_more: boolean;
1233
+ next_cursor: string | null;
1234
+ proposed_sales: {
1235
+ accepted_at: string;
1236
+ accession_number: string;
1237
+ amount: string;
1238
+ approximate_sale_date: string;
1239
+ issuer: {
1240
+ cik: string;
1241
+ name: string | null;
1242
+ ticker: string | null;
1741
1243
  };
1742
- content: {
1743
- "application/json": components["schemas"]["ErrorResponse"];
1244
+ market_value: string;
1245
+ reporting_person: {
1246
+ cik: string;
1247
+ name: string;
1248
+ relationships: string[];
1744
1249
  };
1745
- };
1250
+ sec_url: string;
1251
+ security: string;
1252
+ source_row_index: number;
1253
+ }[];
1746
1254
  };
1747
1255
  };
1748
- listCompanyProposedSales: {
1256
+ responses: never;
1257
+ parameters: never;
1258
+ requestBodies: never;
1259
+ headers: never;
1260
+ pathItems: never;
1261
+ }
1262
+ interface operations {
1263
+ getCompany: {
1749
1264
  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;
1265
+ query?: {
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;
1757
1270
  };
1758
1271
  header?: never;
1759
- path: {
1760
- /** @description US listed company ticker */
1761
- ticker: string;
1762
- };
1272
+ path?: never;
1763
1273
  cookie?: never;
1764
1274
  };
1765
1275
  requestBody?: never;
1766
1276
  responses: {
1767
- /** @description Form 144 proposed-sale rows */
1277
+ /** @description Company reference details. */
1768
1278
  200: {
1769
1279
  headers: {
1770
1280
  "Cache-Control"?: string;
@@ -1776,38 +1286,30 @@ interface operations {
1776
1286
  content: {
1777
1287
  /**
1778
1288
  * @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
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"
1803
1305
  * }
1804
- * ]
1306
+ * }
1805
1307
  * }
1806
1308
  */
1807
- "application/json": components["schemas"]["CompanyProposedSalesResponse"];
1309
+ "application/json": components["schemas"]["CompanyReferenceResponse"];
1808
1310
  };
1809
1311
  };
1810
- /** @description The query parameters or pagination cursor are invalid */
1312
+ /** @description Supply exactly one valid ticker or CIK and no other query keys. */
1811
1313
  400: {
1812
1314
  headers: {
1813
1315
  [name: string]: unknown;
@@ -1815,7 +1317,7 @@ interface operations {
1815
1317
  content: {
1816
1318
  "application/json": {
1817
1319
  /** @enum {string} */
1818
- error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_tickers" | "unsupported_cursor";
1320
+ error: "invalid_query_parameters";
1819
1321
  };
1820
1322
  };
1821
1323
  };
@@ -1828,22 +1330,30 @@ interface operations {
1828
1330
  "application/json": components["schemas"]["ErrorResponse"];
1829
1331
  };
1830
1332
  };
1831
- /** @description The subscription does not include this dataset. */
1832
- 403: {
1333
+ /** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
1334
+ 404: {
1833
1335
  headers: {
1834
1336
  [name: string]: unknown;
1835
1337
  };
1836
1338
  content: {
1837
- "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1339
+ /**
1340
+ * @example {
1341
+ * "error": "company_not_found"
1342
+ * }
1343
+ */
1344
+ "application/json": components["schemas"]["ErrorResponse"];
1838
1345
  };
1839
1346
  };
1840
- /** @description The requested company was not found */
1841
- 404: {
1347
+ /** @description The ticker matches multiple CIKs. */
1348
+ 409: {
1842
1349
  headers: {
1843
1350
  [name: string]: unknown;
1844
1351
  };
1845
1352
  content: {
1846
- "application/json": components["schemas"]["ErrorResponse"];
1353
+ "application/json": {
1354
+ /** @enum {string} */
1355
+ error: "company_ambiguous";
1356
+ };
1847
1357
  };
1848
1358
  };
1849
1359
  /** @description The request exceeded a rate limit. */
@@ -1858,15 +1368,25 @@ interface operations {
1858
1368
  [name: string]: unknown;
1859
1369
  };
1860
1370
  content: {
1861
- "application/json": components["schemas"]["ErrorResponse"];
1371
+ /**
1372
+ * @example {
1373
+ * "error": "rate_limited"
1374
+ * }
1375
+ */
1376
+ "application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
1862
1377
  };
1863
1378
  };
1864
- /** @description The database is unavailable */
1379
+ /** @description The database is unavailable. */
1865
1380
  503: {
1866
1381
  headers: {
1867
1382
  [name: string]: unknown;
1868
1383
  };
1869
1384
  content: {
1385
+ /**
1386
+ * @example {
1387
+ * "error": "database_unavailable"
1388
+ * }
1389
+ */
1870
1390
  "application/json": components["schemas"]["ErrorResponse"];
1871
1391
  };
1872
1392
  };
@@ -2545,7 +2065,9 @@ interface operations {
2545
2065
  from: string;
2546
2066
  /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
2547
2067
  until?: string;
2548
- /** @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. */
2549
2071
  tickers?: string;
2550
2072
  };
2551
2073
  header?: never;
@@ -2723,6 +2245,24 @@ interface operations {
2723
2245
  "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2724
2246
  };
2725
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
+ };
2726
2266
  /** @description The request exceeded a rate limit. */
2727
2267
  429: {
2728
2268
  headers: {
@@ -3627,13 +3167,16 @@ interface operations {
3627
3167
  listProposedSales: {
3628
3168
  parameters: {
3629
3169
  query: {
3630
- /** @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. */
3631
3171
  cursor?: string;
3632
3172
  /** @description Rows per page from 1 through 1000. Defaults to 1000. */
3633
3173
  limit?: string;
3634
3174
  from: string;
3635
3175
  until?: string;
3176
+ /** @description Company tickers; mutually exclusive with ciks. */
3636
3177
  tickers?: string;
3178
+ /** @description Filing entity CIKs; mutually exclusive with tickers. Reference rows are not required. */
3179
+ ciks?: string;
3637
3180
  };
3638
3181
  header?: never;
3639
3182
  path?: never;
@@ -3692,7 +3235,7 @@ interface operations {
3692
3235
  content: {
3693
3236
  "application/json": {
3694
3237
  /** @enum {string} */
3695
- error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_tickers" | "unsupported_cursor";
3238
+ error: "invalid_cursor" | "invalid_date_window" | "invalid_limit" | "invalid_query_parameters";
3696
3239
  };
3697
3240
  };
3698
3241
  };
@@ -3714,6 +3257,24 @@ interface operations {
3714
3257
  "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3715
3258
  };
3716
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
+ };
3717
3278
  /** @description The request exceeded a rate limit. */
3718
3279
  429: {
3719
3280
  headers: {
@@ -4697,10 +4258,10 @@ declare class Companies {
4697
4258
  declare class CompanyReports {
4698
4259
  private readonly transport;
4699
4260
  constructor(transport: HttpTransport);
4700
- get({ accessionNumber, }: {
4261
+ getByAccession({ accessionNumber, }: {
4701
4262
  accessionNumber: string;
4702
4263
  }): PromiseWithResponse<JsonResponse<"getSecCompanyReport">>;
4703
- getForPeriod({ ticker, cik, fiscalYear, fiscalPeriod }: CompanySelector & {
4264
+ get({ ticker, cik, fiscalYear, fiscalPeriod }: CompanySelector & {
4704
4265
  fiscalYear: number;
4705
4266
  fiscalPeriod: CompanyReportFiscalPeriod;
4706
4267
  }): PromiseWithResponse<JsonResponse<"getCompanyReportsForPeriod">>;
@@ -4716,36 +4277,23 @@ declare class FinancialStatements {
4716
4277
  declare class InsiderTransactions {
4717
4278
  private readonly transport;
4718
4279
  constructor(transport: HttpTransport);
4719
- list({ cursor, from, limit, until, tickers, transactionCodes, }: {
4280
+ list({ cursor, from, limit, until, tickers, ciks, transactionCodes, }: {
4720
4281
  cursor?: string;
4721
4282
  from: string;
4722
4283
  limit?: number;
4723
4284
  until?: string;
4724
4285
  tickers?: string[];
4286
+ ciks?: string[];
4725
4287
  transactionCodes?: InsiderTransactionCode[];
4726
4288
  }): PromiseWithResponse<JsonResponse<"listInsiderTransactions">>;
4727
- listForCompany({ cursor, ticker, from, limit, until, transactionCodes, }: {
4728
- cursor?: string;
4729
- ticker: string;
4730
- from: string;
4731
- limit?: number;
4732
- until?: string;
4733
- transactionCodes?: InsiderTransactionCode[];
4734
- }): PromiseWithResponse<JsonResponse<"listCompanyInsiderTransactions">>;
4735
- iterate({ from, until, tickers, transactionCodes, limit, }: {
4289
+ iterate({ from, until, tickers, ciks, transactionCodes, limit, }: {
4736
4290
  from: string;
4737
4291
  until?: string;
4738
4292
  tickers?: string[];
4293
+ ciks?: string[];
4739
4294
  transactionCodes?: InsiderTransactionCode[];
4740
4295
  limit?: number;
4741
4296
  }): AsyncGenerator<JsonResponse<"listInsiderTransactions">["transactions"][number]>;
4742
- iterateForCompany({ ticker, from, until, transactionCodes, limit, }: {
4743
- ticker: string;
4744
- from: string;
4745
- until?: string;
4746
- transactionCodes?: InsiderTransactionCode[];
4747
- limit?: number;
4748
- }): AsyncGenerator<JsonResponse<"listCompanyInsiderTransactions">["transactions"][number]>;
4749
4297
  }
4750
4298
  declare class InsiderFilings {
4751
4299
  private readonly transport;
@@ -4757,32 +4305,21 @@ declare class InsiderFilings {
4757
4305
  declare class ProposedSales {
4758
4306
  private readonly transport;
4759
4307
  constructor(transport: HttpTransport);
4760
- list({ cursor, from, limit, until, tickers, }: {
4308
+ list({ cursor, from, limit, until, tickers, ciks, }: {
4761
4309
  cursor?: string;
4762
4310
  from: string;
4763
4311
  limit?: number;
4764
4312
  until?: string;
4765
4313
  tickers?: string[];
4314
+ ciks?: string[];
4766
4315
  }): PromiseWithResponse<JsonResponse<"listProposedSales">>;
4767
- listForCompany({ cursor, ticker, from, limit, until, }: {
4768
- cursor?: string;
4769
- ticker: string;
4770
- from: string;
4771
- limit?: number;
4772
- until?: string;
4773
- }): PromiseWithResponse<JsonResponse<"listCompanyProposedSales">>;
4774
- iterate({ from, until, tickers, limit, }: {
4316
+ iterate({ from, until, tickers, ciks, limit, }: {
4775
4317
  from: string;
4776
4318
  until?: string;
4777
4319
  tickers?: string[];
4320
+ ciks?: string[];
4778
4321
  limit?: number;
4779
4322
  }): AsyncGenerator<JsonResponse<"listProposedSales">["proposed_sales"][number]>;
4780
- iterateForCompany({ ticker, from, until, limit, }: {
4781
- ticker: string;
4782
- from: string;
4783
- until?: string;
4784
- limit?: number;
4785
- }): AsyncGenerator<JsonResponse<"listCompanyProposedSales">["proposed_sales"][number]>;
4786
4323
  getFiling({ accessionNumber, }: {
4787
4324
  accessionNumber: string;
4788
4325
  }): PromiseWithResponse<JsonResponse<"getSecProposedSaleFiling">>;