@chadwin/sdk 0.1.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.
@@ -0,0 +1,4261 @@
1
+ interface PromiseWithResponse<T> extends Promise<T> {
2
+ withResponse(): Promise<{
3
+ data: T;
4
+ response: Response;
5
+ }>;
6
+ }
7
+
8
+ interface components {
9
+ schemas: {
10
+ CompanyInsiderTransactionListItem: {
11
+ /**
12
+ * Format: date-time
13
+ * @description SEC acceptance timestamp for the containing filing.
14
+ * @example 2026-05-29T22:30:27.000Z
15
+ */
16
+ accepted_at: string;
17
+ /** @example 0001140361-26-023363 */
18
+ accession_number: string;
19
+ /**
20
+ * @description A when securities were acquired, D when disposed, or null when not stated.
21
+ * @example D
22
+ */
23
+ acquired_disposed_code: string | null;
24
+ /** @example null */
25
+ conversion_or_exercise_price: string | null;
26
+ /**
27
+ * @description Deemed execution date reported for the transaction, or null when not applicable or absent.
28
+ * @example null
29
+ */
30
+ deemed_execution_date: string | null;
31
+ /** @example false */
32
+ equity_swap_involved: boolean | null;
33
+ /** @example null */
34
+ exercise_date: string | null;
35
+ /** @example null */
36
+ expiration_date: string | null;
37
+ field_footnote_ids: components["schemas"]["InsiderFieldFootnoteIds"];
38
+ /**
39
+ * @description All document-level footnote IDs referenced by fields on this row.
40
+ * @example [
41
+ * "F1"
42
+ * ]
43
+ */
44
+ footnote_ids: string[];
45
+ footnotes: components["schemas"]["InsiderTransactionFootnote"][];
46
+ /** @example null */
47
+ nature_of_ownership: string | null;
48
+ /**
49
+ * @description Normalized ownership value: direct for direct beneficial ownership, indirect for ownership through another person or entity, or null when not stated.
50
+ * @example direct
51
+ */
52
+ ownership_type: string | null;
53
+ /** @example 311.02 */
54
+ price: string | null;
55
+ /** @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. */
56
+ reporting_owners: components["schemas"]["InsiderTransactionReportingOwner"][];
57
+ /**
58
+ * @description SEC ownership table containing the transaction row.
59
+ * @example nonderivative_transaction
60
+ * @enum {string}
61
+ */
62
+ row_kind: "nonderivative_transaction" | "derivative_transaction";
63
+ /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm */
64
+ sec_url: string;
65
+ /** @example Common Stock */
66
+ security: string | null;
67
+ /** @example 50000 */
68
+ shares: string | null;
69
+ /** @example 3764576 */
70
+ shares_owned_after: string | null;
71
+ /**
72
+ * @description One-based row position within the filing's derivative or non-derivative transaction table.
73
+ * @example 1
74
+ */
75
+ source_row_index: number;
76
+ /**
77
+ * @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.
78
+ * @example S
79
+ * @enum {string}
80
+ */
81
+ transaction_code: "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
82
+ /**
83
+ * @description Transaction date reported in the filing, or null when absent.
84
+ * @example 2026-05-27
85
+ */
86
+ transaction_date: string | null;
87
+ /**
88
+ * @description Row-level SEC form timing code, or null when not stated. This can differ from the containing document form.
89
+ * @example 4
90
+ */
91
+ transaction_form_type: string | null;
92
+ /**
93
+ * @description E for early, L for late, or null when the filing does not state transaction timeliness.
94
+ * @example null
95
+ */
96
+ transaction_timeliness: string | null;
97
+ /**
98
+ * @description SEC transactionTotalValue when present. This value is not computed by the API.
99
+ * @example null
100
+ */
101
+ transaction_total_value: string | null;
102
+ underlying_security: components["schemas"]["InsiderUnderlyingSecurity"];
103
+ };
104
+ CompanyInsiderTransactionsBadRequestResponse: {
105
+ /**
106
+ * @description Machine-readable error code. date_window_too_large means the requested filing-date window matched more than 1000 rows and should be narrowed.
107
+ * @example date_window_too_large
108
+ * @enum {string}
109
+ */
110
+ error: "invalid_transaction_codes" | "invalid_limit" | "invalid_since" | "invalid_date_window" | "date_window_too_large";
111
+ };
112
+ CompanyInsiderTransactionsResponse: {
113
+ issuer: components["schemas"]["InsiderIssuer"];
114
+ transactions: components["schemas"]["CompanyInsiderTransactionListItem"][];
115
+ };
116
+ CompanyProposedSalesResponse: {
117
+ issuer: {
118
+ cik: string;
119
+ name: string;
120
+ ticker: string;
121
+ };
122
+ proposed_sales: {
123
+ accepted_at: string;
124
+ accession_number: string;
125
+ amount: string;
126
+ approximate_sale_date: string;
127
+ market_value: string;
128
+ reporting_person: {
129
+ cik: string;
130
+ name: string;
131
+ relationships: string[];
132
+ };
133
+ sec_url: string;
134
+ security: string;
135
+ source_row_index: number;
136
+ }[];
137
+ };
138
+ CompanyReference: {
139
+ /**
140
+ * @description Zero-padded SEC Central Index Key.
141
+ * @example 0000051143
142
+ */
143
+ cik: string;
144
+ /**
145
+ * @description Stored fiscal year end in MMDD form, or null.
146
+ * @example 1231
147
+ */
148
+ fiscal_year_end: string | null;
149
+ listings: {
150
+ /** @description Source exchange label. */
151
+ exchange: string;
152
+ /** @enum {boolean} */
153
+ is_current: true;
154
+ share_class_figi: string | null;
155
+ ticker: string;
156
+ }[];
157
+ /**
158
+ * @description Company display name.
159
+ * @example INTERNATIONAL BUSINESS MACHINES CORP
160
+ */
161
+ name: string;
162
+ sic: {
163
+ code: string;
164
+ industry_title: string;
165
+ office: string;
166
+ } | null;
167
+ };
168
+ CompanyReferenceResponse: {
169
+ company: components["schemas"]["CompanyReference"];
170
+ };
171
+ CompanyReferenceTooManyRequestsResponse: {
172
+ /** @enum {string} */
173
+ error: "rate_limited" | "billing_period_quota_exceeded";
174
+ };
175
+ CompanyReportFamilyResponse: {
176
+ filings: {
177
+ /**
178
+ * Format: date-time
179
+ * @description SEC acceptance timestamp normalized to UTC.
180
+ */
181
+ accepted_at: string;
182
+ accession_number: string;
183
+ /**
184
+ * @description Relative authenticated API URL for the cleaned report HTML. Send the same bearer token when requesting it.
185
+ * @example /v1/sec/company-reports/0000320193-24-000123/content.html
186
+ */
187
+ content_url: string;
188
+ /** @enum {string} */
189
+ form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
190
+ /**
191
+ * Format: date
192
+ * @description End date of the fiscal period covered by this filing, or null when the SEC filing does not provide one.
193
+ */
194
+ period_end_date: string | null;
195
+ /** Format: uri */
196
+ sec_url: string;
197
+ }[];
198
+ /** @enum {string} */
199
+ fiscal_period: "FY";
200
+ fiscal_year: number;
201
+ issuer: {
202
+ cik: string;
203
+ name: string | null;
204
+ ticker: string | null;
205
+ };
206
+ };
207
+ CompanyReportResponse: {
208
+ /**
209
+ * Format: date-time
210
+ * @description SEC acceptance timestamp normalized to UTC.
211
+ */
212
+ accepted_at: string;
213
+ accession_number: string;
214
+ /**
215
+ * @description Relative authenticated API URL for the cleaned report HTML. Send the same bearer token when requesting it.
216
+ * @example /v1/sec/company-reports/0000320193-24-000123/content.html
217
+ */
218
+ content_url: string;
219
+ /** @enum {string|null} */
220
+ fiscal_period: "FY" | null;
221
+ fiscal_year: number | null;
222
+ /** @enum {string} */
223
+ form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
224
+ issuer: {
225
+ cik: string;
226
+ name: string | null;
227
+ ticker: string | null;
228
+ };
229
+ /**
230
+ * Format: date
231
+ * @description End date of the fiscal period covered by the report, or null when the SEC filing does not provide one.
232
+ */
233
+ period_end_date: string | null;
234
+ /** Format: uri */
235
+ sec_url: string;
236
+ };
237
+ CompanySearchBadRequestResponse: {
238
+ /** @enum {string} */
239
+ error: "invalid_query" | "invalid_query_parameters";
240
+ };
241
+ CompanySearchResponse: {
242
+ companies: components["schemas"]["CompanyReference"][];
243
+ };
244
+ DatasetNotEntitledErrorResponse: {
245
+ /** @enum {string} */
246
+ error: "dataset_not_entitled";
247
+ };
248
+ ErrorResponse: {
249
+ /** @example unauthorized */
250
+ error: string;
251
+ };
252
+ InitialOwnershipActivity: {
253
+ /**
254
+ * Format: date-time
255
+ * @description SEC acceptance timestamp for the filing.
256
+ * @example 2026-07-31T14:03:12.000Z
257
+ */
258
+ accepted_at: string;
259
+ /** @example 0001214128-26-000003 */
260
+ accession_number: string;
261
+ /** @example 0 */
262
+ derivative_holding_count: number;
263
+ /**
264
+ * @description Source event date reported by the initial ownership statement. It does not state when a holding was acquired.
265
+ * @example 2026-07-30
266
+ */
267
+ event_date: string | null;
268
+ /**
269
+ * @description Stable idempotency key for this initial ownership statement event.
270
+ * @example iae_000000000201
271
+ */
272
+ feed_event_id: string;
273
+ /**
274
+ * @example 3
275
+ * @enum {string}
276
+ */
277
+ form: "3" | "3/A";
278
+ issuer: components["schemas"]["InsiderIssuer"];
279
+ /**
280
+ * @description Source statement that the reporting owner held no securities, or null when not stated.
281
+ * @example false
282
+ */
283
+ no_securities_owned: boolean | null;
284
+ /** @example 1 */
285
+ non_derivative_holding_count: number;
286
+ /**
287
+ * Format: date-time
288
+ * @description Timestamp assigned to the database transaction that published this activity.
289
+ * @example 2026-07-31T14:05:00.000Z
290
+ */
291
+ published_at: string;
292
+ reporting_owners: components["schemas"]["InsiderTransactionReportingOwner"][];
293
+ /** @example https://www.sec.gov/Archives/edgar/data/320193/000121412826000003/0001214128-26-000003-index.htm */
294
+ sec_url: string;
295
+ };
296
+ InsiderActivity: components["schemas"]["InitialOwnershipActivity"] | components["schemas"]["OwnershipTransactionActivity"] | components["schemas"]["ProposedSaleNoticeActivity"];
297
+ InsiderActivityFeedBadRequestResponse: {
298
+ /**
299
+ * @example invalid_forms
300
+ * @enum {string}
301
+ */
302
+ error: "invalid_forms" | "invalid_cursor" | "invalid_limit" | "invalid_start" | "unsupported_cursor";
303
+ };
304
+ InsiderActivityFeedResponse: {
305
+ activities: components["schemas"]["InsiderActivity"][];
306
+ /**
307
+ * @description Whether another matching page is already available after next_cursor.
308
+ * @example false
309
+ */
310
+ has_more: boolean;
311
+ /**
312
+ * @description Cursor to send after the current page has been processed successfully.
313
+ * @example cur_eyJ2IjoxLCJhZnRlciI6MjAzfQ
314
+ */
315
+ next_cursor: string;
316
+ };
317
+ /** @description Map from API field name to the document-level footnote IDs that qualify that field. An absent key means the field has no filed footnote reference. */
318
+ InsiderFieldFootnoteIds: {
319
+ [key: string]: string[];
320
+ };
321
+ InsiderFilingDocument: {
322
+ /** Format: date-time */
323
+ accepted_at: string;
324
+ accession_number: string;
325
+ date_of_original_submission: string | null;
326
+ derivative_holdings: components["schemas"]["InsiderOwnershipHoldingRow"][];
327
+ derivative_transactions: components["schemas"]["InsiderFilingTransactionRow"][];
328
+ footnotes: components["schemas"]["InsiderTransactionFootnote"][];
329
+ /** @enum {string} */
330
+ form: "3" | "4" | "5" | "3/A" | "4/A" | "5/A";
331
+ issuer: components["schemas"]["InsiderIssuer"];
332
+ non_derivative_holdings: components["schemas"]["InsiderOwnershipHoldingRow"][];
333
+ non_derivative_transactions: components["schemas"]["InsiderFilingTransactionRow"][];
334
+ not_subject_to_section_16: boolean | null;
335
+ owner_signatures: {
336
+ date: string | null;
337
+ name: string | null;
338
+ }[];
339
+ period_of_report: string | null;
340
+ remarks: string | null;
341
+ reporting_owners: components["schemas"]["InsiderTransactionReportingOwner"][];
342
+ rule_10b5_1: boolean | null;
343
+ sec_url: string;
344
+ };
345
+ InsiderFilingTransactionRow: {
346
+ /**
347
+ * @description A when securities were acquired, D when disposed, or null when not stated.
348
+ * @example D
349
+ */
350
+ acquired_disposed_code: string | null;
351
+ /** @example null */
352
+ conversion_or_exercise_price: string | null;
353
+ /**
354
+ * @description Deemed execution date reported for the transaction, or null when not applicable or absent.
355
+ * @example null
356
+ */
357
+ deemed_execution_date: string | null;
358
+ /** @example false */
359
+ equity_swap_involved: boolean | null;
360
+ /** @example null */
361
+ exercise_date: string | null;
362
+ /** @example null */
363
+ expiration_date: string | null;
364
+ field_footnote_ids: components["schemas"]["InsiderFieldFootnoteIds"];
365
+ /**
366
+ * @description All document-level footnote IDs referenced by fields on this row.
367
+ * @example [
368
+ * "F1"
369
+ * ]
370
+ */
371
+ footnote_ids: string[];
372
+ /** @example null */
373
+ nature_of_ownership: string | null;
374
+ /**
375
+ * @description Normalized ownership value: direct for direct beneficial ownership, indirect for ownership through another person or entity, or null when not stated.
376
+ * @example direct
377
+ */
378
+ ownership_type: string | null;
379
+ /** @example 311.02 */
380
+ price: string | null;
381
+ /** @example Common Stock */
382
+ security: string | null;
383
+ /** @example 50000 */
384
+ shares: string | null;
385
+ /** @example 3764576 */
386
+ shares_owned_after: string | null;
387
+ /**
388
+ * @description One-based row position within the filing's derivative or non-derivative transaction table.
389
+ * @example 1
390
+ */
391
+ source_row_index: number;
392
+ /**
393
+ * @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.
394
+ * @example S
395
+ * @enum {string}
396
+ */
397
+ transaction_code: "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
398
+ /**
399
+ * @description Transaction date reported in the filing, or null when absent.
400
+ * @example 2026-05-27
401
+ */
402
+ transaction_date: string | null;
403
+ /**
404
+ * @description Row-level SEC form timing code, or null when not stated. This can differ from the containing document form.
405
+ * @example 4
406
+ */
407
+ transaction_form_type: string | null;
408
+ /**
409
+ * @description E for early, L for late, or null when the filing does not state transaction timeliness.
410
+ * @example null
411
+ */
412
+ transaction_timeliness: string | null;
413
+ /**
414
+ * @description SEC transactionTotalValue when present. This value is not computed by the API.
415
+ * @example null
416
+ */
417
+ transaction_total_value: string | null;
418
+ underlying_security: components["schemas"]["InsiderUnderlyingSecurity"];
419
+ };
420
+ InsiderIssuer: {
421
+ /**
422
+ * @description SEC CIK of the issuer whose securities are reported.
423
+ * @example 0000320193
424
+ */
425
+ cik: string;
426
+ /**
427
+ * @description Issuer name reported in the filing, or null when absent.
428
+ * @example Apple Inc.
429
+ */
430
+ name: string | null;
431
+ /**
432
+ * @description Issuer trading symbol reported in the filing, or null.
433
+ * @example AAPL
434
+ */
435
+ ticker: string | null;
436
+ };
437
+ InsiderOwnershipHoldingRow: {
438
+ conversion_or_exercise_price?: string | null;
439
+ exercise_date?: string | null;
440
+ expiration_date?: string | null;
441
+ field_footnote_ids: components["schemas"]["InsiderFieldFootnoteIds"];
442
+ footnote_ids: string[];
443
+ late_holding_form_type: string | null;
444
+ nature_of_ownership: string | null;
445
+ ownership_type: string | null;
446
+ security: string | null;
447
+ shares_owned_after: string | null;
448
+ source_row_index: number;
449
+ underlying_security?: components["schemas"]["InsiderUnderlyingSecurity"];
450
+ value_owned_after: string | null;
451
+ };
452
+ InsiderReportingOwnerAddress: {
453
+ /** @example CUPERTINO */
454
+ city: string | null;
455
+ /** @example null */
456
+ country: string | null;
457
+ /** @example CA */
458
+ state: string | null;
459
+ /** @example ONE APPLE PARK WAY */
460
+ street1: string | null;
461
+ /** @example null */
462
+ street2: string | null;
463
+ /** @example 95014 */
464
+ zip_code: string | null;
465
+ };
466
+ InsiderReportingOwnerRelationship: {
467
+ /**
468
+ * @description Whether the filing identifies the owner as a director, or null when not stated.
469
+ * @example true
470
+ */
471
+ is_director: boolean | null;
472
+ /**
473
+ * @description Whether the filing identifies the owner as an officer, or null when not stated.
474
+ * @example null
475
+ */
476
+ is_officer: boolean | null;
477
+ /**
478
+ * @description Whether the filing identifies another Section 16 relationship, or null when not stated.
479
+ * @example null
480
+ */
481
+ is_other: boolean | null;
482
+ /**
483
+ * @description Whether the filing identifies the owner as a ten-percent owner, or null when not stated.
484
+ * @example null
485
+ */
486
+ is_ten_percent_owner: boolean | null;
487
+ /** @example null */
488
+ officer_title: string | null;
489
+ /** @example null */
490
+ other_text: string | null;
491
+ };
492
+ InsiderTransactionFeedBadRequestResponse: {
493
+ /**
494
+ * @example invalid_cursor
495
+ * @enum {string}
496
+ */
497
+ error: "invalid_cursor" | "invalid_limit" | "invalid_start" | "invalid_transaction_codes" | "unsupported_cursor";
498
+ };
499
+ InsiderTransactionFeedEvent: components["schemas"]["InsiderTransactionListItem"] & {
500
+ /**
501
+ * @description Stable idempotency key for this published transaction event.
502
+ * @example ite_000000000129
503
+ */
504
+ feed_event_id: string;
505
+ /**
506
+ * @description Filed SEC form that contains the transaction row.
507
+ * @example 4
508
+ * @enum {string}
509
+ */
510
+ form: "4" | "5" | "4/A" | "5/A";
511
+ /**
512
+ * @description Timestamp assigned to the database transaction that published this event to the feed.
513
+ * @example 2026-06-18T13:49:12.000Z
514
+ */
515
+ published_at: string;
516
+ };
517
+ InsiderTransactionFeedResponse: {
518
+ /**
519
+ * @description Whether another page is already available after next_cursor.
520
+ * @example false
521
+ */
522
+ has_more: boolean;
523
+ /**
524
+ * @description Cursor to send after the current page has been processed successfully.
525
+ * @example cur_eyJ2IjoxLCJhZnRlciI6MTI5fQ
526
+ */
527
+ next_cursor: string;
528
+ transactions: components["schemas"]["InsiderTransactionFeedEvent"][];
529
+ };
530
+ InsiderTransactionFootnote: {
531
+ /**
532
+ * @description Document-level footnote identifier.
533
+ * @example F1
534
+ */
535
+ id: string;
536
+ /**
537
+ * @description Filed footnote text, or null when the referenced text is absent.
538
+ * @example 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.
539
+ */
540
+ text: string | null;
541
+ };
542
+ InsiderTransactionListItem: {
543
+ /**
544
+ * Format: date-time
545
+ * @description SEC acceptance timestamp for the containing filing.
546
+ * @example 2026-05-29T22:30:27.000Z
547
+ */
548
+ accepted_at: string;
549
+ /** @example 0001140361-26-023363 */
550
+ accession_number: string;
551
+ /**
552
+ * @description A when securities were acquired, D when disposed, or null when not stated.
553
+ * @example D
554
+ */
555
+ acquired_disposed_code: string | null;
556
+ /** @example null */
557
+ conversion_or_exercise_price: string | null;
558
+ /**
559
+ * @description Deemed execution date reported for the transaction, or null when not applicable or absent.
560
+ * @example null
561
+ */
562
+ deemed_execution_date: string | null;
563
+ /** @example false */
564
+ equity_swap_involved: boolean | null;
565
+ /** @example null */
566
+ exercise_date: string | null;
567
+ /** @example null */
568
+ expiration_date: string | null;
569
+ field_footnote_ids: components["schemas"]["InsiderFieldFootnoteIds"];
570
+ /**
571
+ * @description All document-level footnote IDs referenced by fields on this row.
572
+ * @example [
573
+ * "F1"
574
+ * ]
575
+ */
576
+ footnote_ids: string[];
577
+ footnotes: components["schemas"]["InsiderTransactionFootnote"][];
578
+ issuer: components["schemas"]["InsiderIssuer"];
579
+ /** @example null */
580
+ nature_of_ownership: string | null;
581
+ /**
582
+ * @description Normalized ownership value: direct for direct beneficial ownership, indirect for ownership through another person or entity, or null when not stated.
583
+ * @example direct
584
+ */
585
+ ownership_type: string | null;
586
+ /** @example 311.02 */
587
+ price: string | null;
588
+ /** @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. */
589
+ reporting_owners: components["schemas"]["InsiderTransactionReportingOwner"][];
590
+ /**
591
+ * @description SEC ownership table containing the transaction row.
592
+ * @example nonderivative_transaction
593
+ * @enum {string}
594
+ */
595
+ row_kind: "nonderivative_transaction" | "derivative_transaction";
596
+ /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm */
597
+ sec_url: string;
598
+ /** @example Common Stock */
599
+ security: string | null;
600
+ /** @example 50000 */
601
+ shares: string | null;
602
+ /** @example 3764576 */
603
+ shares_owned_after: string | null;
604
+ /**
605
+ * @description One-based row position within the filing's derivative or non-derivative transaction table.
606
+ * @example 1
607
+ */
608
+ source_row_index: number;
609
+ /**
610
+ * @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.
611
+ * @example S
612
+ * @enum {string}
613
+ */
614
+ transaction_code: "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
615
+ /**
616
+ * @description Transaction date reported in the filing, or null when absent.
617
+ * @example 2026-05-27
618
+ */
619
+ transaction_date: string | null;
620
+ /**
621
+ * @description Row-level SEC form timing code, or null when not stated. This can differ from the containing document form.
622
+ * @example 4
623
+ */
624
+ transaction_form_type: string | null;
625
+ /**
626
+ * @description E for early, L for late, or null when the filing does not state transaction timeliness.
627
+ * @example null
628
+ */
629
+ transaction_timeliness: string | null;
630
+ /**
631
+ * @description SEC transactionTotalValue when present. This value is not computed by the API.
632
+ * @example null
633
+ */
634
+ transaction_total_value: string | null;
635
+ underlying_security: components["schemas"]["InsiderUnderlyingSecurity"];
636
+ };
637
+ InsiderTransactionReportingOwner: {
638
+ address: components["schemas"]["InsiderReportingOwnerAddress"];
639
+ /** @example 0001214128 */
640
+ cik: string;
641
+ /** @example LEVINSON ARTHUR D */
642
+ name: string | null;
643
+ relationship: components["schemas"]["InsiderReportingOwnerRelationship"];
644
+ };
645
+ InsiderTransactionsBadRequestResponse: {
646
+ /**
647
+ * @description Machine-readable error code. date_window_too_large means the requested filing-date window matched more than 1000 rows and should be narrowed.
648
+ * @example invalid_tickers
649
+ * @enum {string}
650
+ */
651
+ error: "invalid_transaction_codes" | "invalid_tickers" | "invalid_limit" | "invalid_since" | "invalid_date_window" | "date_window_too_large";
652
+ };
653
+ InsiderTransactionsResponse: {
654
+ transactions: components["schemas"]["InsiderTransactionListItem"][];
655
+ };
656
+ InsiderUnderlyingSecurity: {
657
+ /** @example 2500 */
658
+ shares: string | null;
659
+ /** @example Class A Common Stock */
660
+ title: string | null;
661
+ /** @example null */
662
+ value: string | null;
663
+ } | null;
664
+ InstitutionalFilingAmendment: {
665
+ /** @example null */
666
+ confidential_denied_expired: boolean | null;
667
+ /** @example null */
668
+ date_denied_expired: string | null;
669
+ /** @example null */
670
+ date_reported: string | null;
671
+ /**
672
+ * @description Amendment number reported on the cover page, or null.
673
+ * @example 1
674
+ */
675
+ number: string | null;
676
+ /** @example null */
677
+ reason_for_non_confidentiality: string | null;
678
+ /**
679
+ * @description RESTATEMENT when the complete corrected filing supersedes the active set, NEW HOLDINGS when rows supplement it, or null when absent.
680
+ * @example RESTATEMENT
681
+ */
682
+ type: string | null;
683
+ } | null;
684
+ InstitutionalFilingDetailResponse: {
685
+ /** Format: date-time */
686
+ accepted_at: string;
687
+ accession_number: string;
688
+ amendment: components["schemas"]["InstitutionalFilingAmendment"];
689
+ /** @example false */
690
+ confidential_treatment_requested: boolean | null;
691
+ /**
692
+ * @description Filed Form 13F type.
693
+ * @enum {string}
694
+ */
695
+ form: "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
696
+ holdings: components["schemas"]["InstitutionalFilingHoldingsSummary"];
697
+ /** @description Managers whose holdings are included in the information table. */
698
+ included_managers: components["schemas"]["InstitutionalFilingIncludedManager"][];
699
+ manager: components["schemas"]["InstitutionalFilingManager"];
700
+ /** @description Other reporting managers named on the filing. */
701
+ other_reporting_managers: components["schemas"]["InstitutionalFilingOtherManager"][];
702
+ /** @description Quarter-end period described by the filing, or null when absent. */
703
+ period_of_report: string | null;
704
+ /** @example null */
705
+ remarks: string | null;
706
+ /**
707
+ * @description Form 13F cover-page report type: 13F HOLDINGS REPORT when all holdings are reported in this filing, 13F NOTICE when all holdings are reported by other managers, 13F COMBINATION REPORT when holdings are split between this filing and other managers, or null when absent.
708
+ * @example 13F HOLDINGS REPORT
709
+ */
710
+ report_type: string | null;
711
+ signature: components["schemas"]["InstitutionalFilingSignature"];
712
+ };
713
+ InstitutionalFilingHolding: {
714
+ /**
715
+ * @description Filed SEC investment-discretion code: SOLE for sole discretion, DFND for shared-defined discretion, OTR for shared-other discretion, or null when absent.
716
+ * @example SOLE
717
+ */
718
+ investment_discretion: string | null;
719
+ /** @description Other managers associated with the filed investment discretion, in SEC source order. */
720
+ other_managers: components["schemas"]["InstitutionalFilingOtherManager"][];
721
+ position: components["schemas"]["InstitutionalHoldingPosition"];
722
+ security: components["schemas"]["InstitutionalHoldingSecurity"];
723
+ voting_authority: components["schemas"]["InstitutionalHoldingVotingAuthority"];
724
+ };
725
+ InstitutionalFilingHoldingsResponse: {
726
+ accession_number: string;
727
+ /** @enum {string} */
728
+ form: "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
729
+ has_more: boolean;
730
+ holdings: components["schemas"]["InstitutionalFilingHolding"][];
731
+ next_cursor: string | null;
732
+ period_of_report: string | null;
733
+ /**
734
+ * @description Form 13F cover-page report type: 13F HOLDINGS REPORT when all holdings are reported in this filing, 13F NOTICE when all holdings are reported by other managers, 13F COMBINATION REPORT when holdings are split between this filing and other managers, or null when absent.
735
+ * @example 13F HOLDINGS REPORT
736
+ */
737
+ report_type: string | null;
738
+ };
739
+ InstitutionalFilingHoldingsSummary: {
740
+ /** @description Number of information-table rows reported by the filing. */
741
+ total_count: number;
742
+ /** @example 4312516304 */
743
+ total_value_usd: string | null;
744
+ /** @description Relative URL for paginated as-filed holdings, or null when the filing has no information table. */
745
+ url: string | null;
746
+ } | null;
747
+ /** @description Manager whose holdings are included in the filing's information table. */
748
+ InstitutionalFilingIncludedManager: {
749
+ /** @example 0001911876 */
750
+ cik: string | null;
751
+ /** @example null */
752
+ crd_number: string | null;
753
+ /** @example 028-22280 */
754
+ form_13f_file_number: string | null;
755
+ /** @example Example Reporting Manager LLC */
756
+ name: string | null;
757
+ };
758
+ InstitutionalFilingManager: components["schemas"]["InstitutionalManagerSourceIdentity"] & {
759
+ address: components["schemas"]["InstitutionalFilingManagerAddress"];
760
+ /** @example 000105503 */
761
+ crd_number: string | null;
762
+ };
763
+ InstitutionalFilingManagerAddress: {
764
+ /** @example NEW YORK */
765
+ city: string | null;
766
+ /** @example NY */
767
+ state_or_country: string | null;
768
+ /** @example 50 HUDSON YARDS */
769
+ street1: string | null;
770
+ /** @example null */
771
+ street2: string | null;
772
+ /** @example 10001 */
773
+ zip_code: string | null;
774
+ } | null;
775
+ InstitutionalFilingOtherManager: {
776
+ /** @example 0001911876 */
777
+ cik: string | null;
778
+ /** @example null */
779
+ crd_number: string | null;
780
+ /** @example 028-22280 */
781
+ form_13f_file_number: string | null;
782
+ /** @example Example Reporting Manager LLC */
783
+ name: string | null;
784
+ };
785
+ InstitutionalFilingSignature: {
786
+ /** @example New York */
787
+ city: string | null;
788
+ /** @example Authorized Signatory */
789
+ name: string | null;
790
+ /** @example 212-810-5300 */
791
+ phone: string | null;
792
+ /** @example Authorized Signatory */
793
+ signature: string | null;
794
+ /** @example 2024-08-13 */
795
+ signature_date: string | null;
796
+ /** @example NY */
797
+ state_or_country: string | null;
798
+ /** @example Authorized Signatory */
799
+ title: string | null;
800
+ } | null;
801
+ /** @description Matched listed company, or null when the reported security cannot be mapped confidently. */
802
+ InstitutionalHoldingCompany: {
803
+ /** @example 0000320193 */
804
+ cik: string;
805
+ /** @example NASDAQ */
806
+ exchange: string;
807
+ /** @example Apple Inc. */
808
+ name: string;
809
+ /** @example AAPL */
810
+ ticker: string;
811
+ } | null;
812
+ InstitutionalHoldingFeedBadRequestResponse: {
813
+ /**
814
+ * @example invalid_forms
815
+ * @enum {string}
816
+ */
817
+ error: "invalid_cursor" | "invalid_forms" | "invalid_limit" | "invalid_start" | "unsupported_cursor";
818
+ };
819
+ InstitutionalHoldingFeedResponse: {
820
+ /**
821
+ * @description Whether another filing-event page is already available.
822
+ * @example false
823
+ */
824
+ has_more: boolean;
825
+ /**
826
+ * @description Cursor to send after the current page has been processed successfully.
827
+ * @example cur_eyJ2IjoxLCJhZnRlciI6MTIzfQ
828
+ */
829
+ next_cursor: string;
830
+ updates: components["schemas"]["InstitutionalHoldingFeedUpdate"][];
831
+ };
832
+ InstitutionalHoldingFeedUpdate: {
833
+ /**
834
+ * @description SEC acceptance timestamp, or null when source metadata is unavailable.
835
+ * @example 2026-07-20T17:56:51.000Z
836
+ */
837
+ accepted_at: string | null;
838
+ /** @example 0001214659-26-008712 */
839
+ accession_number: string;
840
+ /**
841
+ * @description Stable idempotency key for this processed filing event.
842
+ * @example ihfe_000000000787
843
+ */
844
+ feed_event_id: string;
845
+ /**
846
+ * @description Filed Form 13F type, including amendments and notice reports.
847
+ * @example 13F-HR
848
+ * @enum {string}
849
+ */
850
+ form: "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
851
+ manager: {
852
+ /** @example 0001998033 */
853
+ cik: string;
854
+ /** @example 028-23431 */
855
+ form_13f_file_number: string;
856
+ /** @example Envestnet Portfolio Solutions, Inc. */
857
+ name: string;
858
+ };
859
+ /**
860
+ * @description Quarter-end period described by the filing, or null for a filing without a report period.
861
+ * @example 2026-06-30
862
+ */
863
+ period_of_report: string | null;
864
+ /**
865
+ * @description Timestamp assigned to the database transaction that published this event to the feed.
866
+ * @example 2026-07-20T19:10:06.976Z
867
+ */
868
+ published_at: string;
869
+ /**
870
+ * @description Form 13F cover-page report type: 13F HOLDINGS REPORT when all holdings are reported in this filing, 13F NOTICE when all holdings are reported by other managers, 13F COMBINATION REPORT when holdings are split between this filing and other managers, or null when absent.
871
+ * @example 13F HOLDINGS REPORT
872
+ */
873
+ report_type: string | null;
874
+ /**
875
+ * @description SEC filing index URL for this accession.
876
+ * @example https://www.sec.gov/Archives/edgar/data/1998033/000121465926008712/0001214659-26-008712-index.htm
877
+ */
878
+ sec_url: string;
879
+ };
880
+ InstitutionalHoldingPosition: {
881
+ /**
882
+ * @description Reported position quantity as an exact decimal string, or null.
883
+ * @example 1245000
884
+ */
885
+ amount: string | null;
886
+ /**
887
+ * @description Reported market value in whole US dollars as an exact decimal string. Values from filings submitted before January 3, 2023 are normalized from the SEC's former thousands-of-dollars unit, or null when absent.
888
+ * @example 221563000
889
+ */
890
+ market_value_usd: string | null;
891
+ /**
892
+ * @description shares for a share quantity, principal_amount for the principal amount of a debt position, or null when absent.
893
+ * @enum {string|null}
894
+ */
895
+ type: "shares" | "principal_amount" | null;
896
+ };
897
+ InstitutionalHoldingSecurity: {
898
+ company: components["schemas"]["InstitutionalHoldingCompany"];
899
+ /**
900
+ * @description Issuer name reported in the information table.
901
+ * @example APPLE INC
902
+ */
903
+ issuer: string;
904
+ /**
905
+ * @description put or call for an option position, otherwise null.
906
+ * @enum {string|null}
907
+ */
908
+ option_type: "put" | "call" | null;
909
+ /**
910
+ * @description Security class title reported in the information table.
911
+ * @example COM
912
+ */
913
+ title_of_class: string;
914
+ };
915
+ InstitutionalHoldingVotingAuthority: {
916
+ /**
917
+ * @description Quantity over which the manager reports no voting authority, or null.
918
+ * @example 0
919
+ */
920
+ none: string | null;
921
+ /**
922
+ * @description Quantity over which the manager reports shared voting authority, or null.
923
+ * @example 0
924
+ */
925
+ shared: string | null;
926
+ /**
927
+ * @description Quantity over which the manager reports sole voting authority, or null.
928
+ * @example 1245000
929
+ */
930
+ sole: string | null;
931
+ };
932
+ InstitutionalHoldingsBadRequestResponse: {
933
+ /**
934
+ * @example invalid_cursor
935
+ * @enum {string}
936
+ */
937
+ error: "invalid_accession" | "invalid_cik" | "invalid_cursor" | "invalid_form_13f_file_number" | "invalid_limit" | "invalid_period" | "unsupported_cursor";
938
+ };
939
+ InstitutionalManagerDetail: {
940
+ /** @example 0001067983 */
941
+ cik: string;
942
+ /** @example 028-04545 */
943
+ form_13f_file_number: string;
944
+ /** @example Berkshire Hathaway Inc. */
945
+ name: string;
946
+ };
947
+ InstitutionalManagerDetailResponse: {
948
+ latest_period: components["schemas"]["InstitutionalManagerLatestPeriod"];
949
+ manager: components["schemas"]["InstitutionalManagerDetail"];
950
+ };
951
+ InstitutionalManagerHolding: components["schemas"]["InstitutionalFilingHolding"] & {
952
+ source: {
953
+ /** @example 0000950123-26-004321 */
954
+ accession_number: string;
955
+ };
956
+ };
957
+ InstitutionalManagerHoldingsResponse: {
958
+ has_more: boolean;
959
+ holdings: components["schemas"]["InstitutionalManagerHolding"][];
960
+ manager: components["schemas"]["InstitutionalManagerDetail"];
961
+ next_cursor: string | null;
962
+ period: {
963
+ accepted_at: string | null;
964
+ period_of_report: string;
965
+ };
966
+ };
967
+ InstitutionalManagerLatestPeriod: {
968
+ /** @example 2026-05-15T20:12:34.000Z */
969
+ accepted_at: string | null;
970
+ holdings: {
971
+ /** @example 124 */
972
+ total_count: number;
973
+ /** @example 267891234567 */
974
+ total_value_usd: string | null;
975
+ /** @example /v1/institutional-holdings/managers/028-04545/holdings?period=2026-03-31 */
976
+ url: string;
977
+ };
978
+ /** @example 2026-03-31 */
979
+ period_of_report: string;
980
+ } | null;
981
+ InstitutionalManagerListItem: {
982
+ /** @example 0001067983 */
983
+ cik: string;
984
+ /** @example 028-04545 */
985
+ form_13f_file_number: string;
986
+ /** @example 124 */
987
+ holding_count: number | null;
988
+ /** @example 2026-05-15T20:12:34.000Z */
989
+ latest_accepted_at: string | null;
990
+ /** @example 2026-03-31 */
991
+ latest_period_of_report: string | null;
992
+ /** @example Berkshire Hathaway Inc. */
993
+ name: string;
994
+ /** @example 267891234567 */
995
+ total_value_usd: string | null;
996
+ };
997
+ InstitutionalManagerPeriodSummary: {
998
+ /** @example 2026-05-15T20:12:34.000Z */
999
+ accepted_at: string | null;
1000
+ holdings: {
1001
+ /** @example 124 */
1002
+ total_count: number;
1003
+ /** @example 267891234567 */
1004
+ total_value_usd: string | null;
1005
+ /** @example /v1/institutional-holdings/managers/028-04545/holdings?period=2026-03-31 */
1006
+ url: string;
1007
+ };
1008
+ /** @example 2026-03-31 */
1009
+ period_of_report: string;
1010
+ };
1011
+ InstitutionalManagerPeriodsResponse: {
1012
+ manager: components["schemas"]["InstitutionalManagerDetail"];
1013
+ periods: components["schemas"]["InstitutionalManagerPeriodSummary"][];
1014
+ };
1015
+ InstitutionalManagerPosition: {
1016
+ position: components["schemas"]["InstitutionalHoldingPosition"];
1017
+ /**
1018
+ * @description Number of effective reported holdings combined into this position.
1019
+ * @example 3
1020
+ */
1021
+ reported_holding_count: number;
1022
+ security: components["schemas"]["InstitutionalHoldingSecurity"];
1023
+ voting_authority: components["schemas"]["InstitutionalHoldingVotingAuthority"];
1024
+ };
1025
+ InstitutionalManagerPositionsResponse: {
1026
+ has_more: boolean;
1027
+ manager: components["schemas"]["InstitutionalManagerDetail"];
1028
+ next_cursor: string | null;
1029
+ period: {
1030
+ accepted_at: string | null;
1031
+ period_of_report: string;
1032
+ };
1033
+ positions: components["schemas"]["InstitutionalManagerPosition"][];
1034
+ };
1035
+ InstitutionalManagerSourceIdentity: {
1036
+ /**
1037
+ * @description SEC CIK of the reporting manager's source filer.
1038
+ * @example 0001067983
1039
+ */
1040
+ cik: string;
1041
+ /**
1042
+ * @description SEC Form 13F file number used as the manager endpoint identifier.
1043
+ * @example 028-04545
1044
+ */
1045
+ form_13f_file_number: string;
1046
+ /** @example Berkshire Hathaway Inc. */
1047
+ name: string;
1048
+ };
1049
+ InstitutionalManagersResponse: {
1050
+ has_more: boolean;
1051
+ managers: components["schemas"]["InstitutionalManagerListItem"][];
1052
+ next_cursor: string | null;
1053
+ };
1054
+ OwnershipTransactionActivity: components["schemas"]["InsiderTransactionListItem"] & {
1055
+ /**
1056
+ * @description Stable idempotency key for this published transaction event.
1057
+ * @example ite_000000000129
1058
+ */
1059
+ feed_event_id: string;
1060
+ /**
1061
+ * @description Filed SEC form that contains the transaction row.
1062
+ * @example 4
1063
+ * @enum {string}
1064
+ */
1065
+ form: "4" | "5" | "4/A" | "5/A";
1066
+ /**
1067
+ * @description Timestamp assigned to the database transaction that published this event to the feed.
1068
+ * @example 2026-06-18T13:49:12.000Z
1069
+ */
1070
+ published_at: string;
1071
+ };
1072
+ ProposedSaleFilingDetail: {
1073
+ accepted_at: string;
1074
+ accession_number: string;
1075
+ /** @enum {string} */
1076
+ form: "144" | "144/A";
1077
+ issuer: {
1078
+ cik: string;
1079
+ name: string;
1080
+ ticker: string | null;
1081
+ };
1082
+ nothing_to_report: boolean;
1083
+ notice: {
1084
+ date: string;
1085
+ plan_adoption_dates: string[];
1086
+ signature: string;
1087
+ };
1088
+ past_three_month_sales: {
1089
+ amount: string;
1090
+ gross_proceeds: string;
1091
+ sale_date: string;
1092
+ security: string;
1093
+ seller: string;
1094
+ source_row_index: number;
1095
+ }[];
1096
+ previous_accession_number: string | null;
1097
+ proposed_sales: {
1098
+ amount: string;
1099
+ amount_outstanding: string;
1100
+ approximate_sale_date: string;
1101
+ broker_or_market_maker: string;
1102
+ intended_sale_exchange: string;
1103
+ market_value: string;
1104
+ security: string;
1105
+ source_row_index: number;
1106
+ }[];
1107
+ remarks: string | null;
1108
+ reporting_person: {
1109
+ cik: string;
1110
+ name: string;
1111
+ relationships: string[];
1112
+ };
1113
+ sec_url: string;
1114
+ securities_to_be_sold: {
1115
+ acquired_from: string | null;
1116
+ acquisition_date: string;
1117
+ acquisition_method: string;
1118
+ amount: string;
1119
+ donor_acquisition_date: string | null;
1120
+ is_gift: boolean;
1121
+ payment_date: string | null;
1122
+ payment_method: string;
1123
+ security: string;
1124
+ source_row_index: number;
1125
+ }[];
1126
+ };
1127
+ ProposedSaleNoticeActivity: {
1128
+ /**
1129
+ * Format: date-time
1130
+ * @example 2026-07-31T14:06:12.000Z
1131
+ */
1132
+ accepted_at: string;
1133
+ /** @example 0001140361-26-030001 */
1134
+ accession_number: string;
1135
+ /** @example 100 */
1136
+ amount: string;
1137
+ /** @example 2026-08-03 */
1138
+ approximate_sale_date: string;
1139
+ /**
1140
+ * @description Stable idempotency key for this proposed-sale activity.
1141
+ * @example pse_000000000203
1142
+ */
1143
+ feed_event_id: string;
1144
+ /**
1145
+ * @example 144
1146
+ * @enum {string}
1147
+ */
1148
+ form: "144" | "144/A";
1149
+ issuer: components["schemas"]["InsiderIssuer"];
1150
+ /** @example 20000.00 */
1151
+ market_value: string;
1152
+ /**
1153
+ * Format: date-time
1154
+ * @example 2026-07-31T14:07:00.000Z
1155
+ */
1156
+ published_at: string;
1157
+ reporting_person: {
1158
+ /** @example 0002100523 */
1159
+ cik: string;
1160
+ /** @example Example Reporting Person */
1161
+ name: string;
1162
+ /**
1163
+ * @example [
1164
+ * "Officer"
1165
+ * ]
1166
+ */
1167
+ relationships: string[];
1168
+ };
1169
+ /** @example https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm */
1170
+ sec_url: string;
1171
+ /** @example Common Stock */
1172
+ security: string;
1173
+ /** @example 1 */
1174
+ source_row_index: number;
1175
+ };
1176
+ ProposedSalesResponse: {
1177
+ proposed_sales: {
1178
+ accepted_at: string;
1179
+ accession_number: string;
1180
+ amount: string;
1181
+ approximate_sale_date: string;
1182
+ issuer: {
1183
+ cik: string;
1184
+ name: string;
1185
+ ticker: string | null;
1186
+ };
1187
+ market_value: string;
1188
+ reporting_person: {
1189
+ cik: string;
1190
+ name: string;
1191
+ relationships: string[];
1192
+ };
1193
+ sec_url: string;
1194
+ security: string;
1195
+ source_row_index: number;
1196
+ }[];
1197
+ };
1198
+ };
1199
+ responses: never;
1200
+ parameters: never;
1201
+ requestBodies: never;
1202
+ headers: never;
1203
+ pathItems: never;
1204
+ }
1205
+ interface operations {
1206
+ searchCompanies: {
1207
+ parameters: {
1208
+ query: {
1209
+ /** @description Company name, current ticker, or padded or unpadded CIK. */
1210
+ query: string;
1211
+ };
1212
+ header?: never;
1213
+ path?: never;
1214
+ cookie?: never;
1215
+ };
1216
+ requestBody?: never;
1217
+ responses: {
1218
+ /** @description Ranked company matches. */
1219
+ 200: {
1220
+ headers: {
1221
+ "Cache-Control"?: string;
1222
+ "X-Billing-Period-Quota-Limit"?: string;
1223
+ "X-Billing-Period-Quota-Remaining"?: string;
1224
+ "X-Billing-Period-Quota-Reset"?: string;
1225
+ [name: string]: unknown;
1226
+ };
1227
+ content: {
1228
+ /**
1229
+ * @example {
1230
+ * "companies": [
1231
+ * {
1232
+ * "cik": "0000051143",
1233
+ * "fiscal_year_end": "1231",
1234
+ * "listings": [
1235
+ * {
1236
+ * "exchange": "NYSE",
1237
+ * "is_current": true,
1238
+ * "share_class_figi": "BBG001S5S399",
1239
+ * "ticker": "IBM"
1240
+ * }
1241
+ * ],
1242
+ * "name": "INTERNATIONAL BUSINESS MACHINES CORP",
1243
+ * "sic": {
1244
+ * "code": "3570",
1245
+ * "industry_title": "COMPUTER & OFFICE EQUIPMENT",
1246
+ * "office": "Office of Technology"
1247
+ * }
1248
+ * }
1249
+ * ]
1250
+ * }
1251
+ */
1252
+ "application/json": components["schemas"]["CompanySearchResponse"];
1253
+ };
1254
+ };
1255
+ /** @description The query is missing, invalid, or has unsupported keys. */
1256
+ 400: {
1257
+ headers: {
1258
+ [name: string]: unknown;
1259
+ };
1260
+ content: {
1261
+ /**
1262
+ * @example {
1263
+ * "error": "invalid_query"
1264
+ * }
1265
+ */
1266
+ "application/json": components["schemas"]["CompanySearchBadRequestResponse"];
1267
+ };
1268
+ };
1269
+ /** @description The request is missing a valid Chadwin API key. */
1270
+ 401: {
1271
+ headers: {
1272
+ [name: string]: unknown;
1273
+ };
1274
+ content: {
1275
+ "application/json": components["schemas"]["ErrorResponse"];
1276
+ };
1277
+ };
1278
+ /** @description The request exceeded a rate limit. */
1279
+ 429: {
1280
+ headers: {
1281
+ "RateLimit-Limit"?: string;
1282
+ "RateLimit-Reset"?: string;
1283
+ "Retry-After"?: string;
1284
+ "X-Billing-Period-Quota-Limit"?: string;
1285
+ "X-Billing-Period-Quota-Remaining"?: string;
1286
+ "X-Billing-Period-Quota-Reset"?: string;
1287
+ [name: string]: unknown;
1288
+ };
1289
+ content: {
1290
+ /**
1291
+ * @example {
1292
+ * "error": "rate_limited"
1293
+ * }
1294
+ */
1295
+ "application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
1296
+ };
1297
+ };
1298
+ /** @description The database is unavailable. */
1299
+ 503: {
1300
+ headers: {
1301
+ [name: string]: unknown;
1302
+ };
1303
+ content: {
1304
+ /**
1305
+ * @example {
1306
+ * "error": "database_unavailable"
1307
+ * }
1308
+ */
1309
+ "application/json": components["schemas"]["ErrorResponse"];
1310
+ };
1311
+ };
1312
+ };
1313
+ };
1314
+ getCompany: {
1315
+ parameters: {
1316
+ query?: never;
1317
+ header?: never;
1318
+ path: {
1319
+ /** @description US listed company ticker */
1320
+ ticker: string;
1321
+ };
1322
+ cookie?: never;
1323
+ };
1324
+ requestBody?: never;
1325
+ responses: {
1326
+ /** @description Company reference details. */
1327
+ 200: {
1328
+ headers: {
1329
+ "Cache-Control"?: string;
1330
+ "X-Billing-Period-Quota-Limit"?: string;
1331
+ "X-Billing-Period-Quota-Remaining"?: string;
1332
+ "X-Billing-Period-Quota-Reset"?: string;
1333
+ [name: string]: unknown;
1334
+ };
1335
+ content: {
1336
+ /**
1337
+ * @example {
1338
+ * "company": {
1339
+ * "cik": "0000051143",
1340
+ * "fiscal_year_end": "1231",
1341
+ * "listings": [
1342
+ * {
1343
+ * "exchange": "NYSE",
1344
+ * "is_current": true,
1345
+ * "share_class_figi": "BBG001S5S399",
1346
+ * "ticker": "IBM"
1347
+ * }
1348
+ * ],
1349
+ * "name": "INTERNATIONAL BUSINESS MACHINES CORP",
1350
+ * "sic": {
1351
+ * "code": "3570",
1352
+ * "industry_title": "COMPUTER & OFFICE EQUIPMENT",
1353
+ * "office": "Office of Technology"
1354
+ * }
1355
+ * }
1356
+ * }
1357
+ */
1358
+ "application/json": components["schemas"]["CompanyReferenceResponse"];
1359
+ };
1360
+ };
1361
+ /** @description The request is missing a valid Chadwin API key. */
1362
+ 401: {
1363
+ headers: {
1364
+ [name: string]: unknown;
1365
+ };
1366
+ content: {
1367
+ "application/json": components["schemas"]["ErrorResponse"];
1368
+ };
1369
+ };
1370
+ /** @description The ticker does not resolve to exactly one current company. */
1371
+ 404: {
1372
+ headers: {
1373
+ [name: string]: unknown;
1374
+ };
1375
+ content: {
1376
+ /**
1377
+ * @example {
1378
+ * "error": "company_not_found"
1379
+ * }
1380
+ */
1381
+ "application/json": components["schemas"]["ErrorResponse"];
1382
+ };
1383
+ };
1384
+ /** @description The request exceeded a rate limit. */
1385
+ 429: {
1386
+ headers: {
1387
+ "RateLimit-Limit"?: string;
1388
+ "RateLimit-Reset"?: string;
1389
+ "Retry-After"?: string;
1390
+ "X-Billing-Period-Quota-Limit"?: string;
1391
+ "X-Billing-Period-Quota-Remaining"?: string;
1392
+ "X-Billing-Period-Quota-Reset"?: string;
1393
+ [name: string]: unknown;
1394
+ };
1395
+ content: {
1396
+ /**
1397
+ * @example {
1398
+ * "error": "rate_limited"
1399
+ * }
1400
+ */
1401
+ "application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
1402
+ };
1403
+ };
1404
+ /** @description The database is unavailable. */
1405
+ 503: {
1406
+ headers: {
1407
+ [name: string]: unknown;
1408
+ };
1409
+ content: {
1410
+ /**
1411
+ * @example {
1412
+ * "error": "database_unavailable"
1413
+ * }
1414
+ */
1415
+ "application/json": components["schemas"]["ErrorResponse"];
1416
+ };
1417
+ };
1418
+ };
1419
+ };
1420
+ listCompanyInsiderTransactions: {
1421
+ parameters: {
1422
+ query: {
1423
+ /** @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. */
1424
+ transaction_codes?: string;
1425
+ /** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. If the filing-date window matches more than 1000 rows, narrow the window. */
1426
+ from: string;
1427
+ /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. If the filing-date window matches more than 1000 rows, narrow the window. */
1428
+ until?: string;
1429
+ };
1430
+ header?: never;
1431
+ path: {
1432
+ /** @description US listed company ticker */
1433
+ ticker: string;
1434
+ };
1435
+ cookie?: never;
1436
+ };
1437
+ requestBody?: never;
1438
+ responses: {
1439
+ /** @description Company insider transactions filed during the requested coverage window. */
1440
+ 200: {
1441
+ headers: {
1442
+ "Cache-Control"?: string;
1443
+ "X-Billing-Period-Quota-Limit"?: string;
1444
+ "X-Billing-Period-Quota-Remaining"?: string;
1445
+ "X-Billing-Period-Quota-Reset"?: string;
1446
+ [name: string]: unknown;
1447
+ };
1448
+ content: {
1449
+ /**
1450
+ * @example {
1451
+ * "issuer": {
1452
+ * "cik": "0000320193",
1453
+ * "name": "Apple Inc.",
1454
+ * "ticker": "AAPL"
1455
+ * },
1456
+ * "transactions": [
1457
+ * {
1458
+ * "accepted_at": "2026-05-29T22:30:27.000Z",
1459
+ * "accession_number": "0001140361-26-023363",
1460
+ * "acquired_disposed_code": "D",
1461
+ * "conversion_or_exercise_price": null,
1462
+ * "deemed_execution_date": null,
1463
+ * "equity_swap_involved": false,
1464
+ * "exercise_date": null,
1465
+ * "expiration_date": null,
1466
+ * "field_footnote_ids": {
1467
+ * "price": [
1468
+ * "F1"
1469
+ * ]
1470
+ * },
1471
+ * "footnote_ids": [
1472
+ * "F1"
1473
+ * ],
1474
+ * "footnotes": [
1475
+ * {
1476
+ * "id": "F1",
1477
+ * "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."
1478
+ * }
1479
+ * ],
1480
+ * "nature_of_ownership": null,
1481
+ * "ownership_type": "direct",
1482
+ * "price": "311.02",
1483
+ * "reporting_owners": [
1484
+ * {
1485
+ * "address": {
1486
+ * "city": "CUPERTINO",
1487
+ * "country": null,
1488
+ * "state": "CA",
1489
+ * "street1": "ONE APPLE PARK WAY",
1490
+ * "street2": null,
1491
+ * "zip_code": "95014"
1492
+ * },
1493
+ * "cik": "0001214128",
1494
+ * "name": "LEVINSON ARTHUR D",
1495
+ * "relationship": {
1496
+ * "is_director": true,
1497
+ * "is_officer": null,
1498
+ * "is_other": null,
1499
+ * "is_ten_percent_owner": null,
1500
+ * "officer_title": null,
1501
+ * "other_text": null
1502
+ * }
1503
+ * }
1504
+ * ],
1505
+ * "row_kind": "nonderivative_transaction",
1506
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
1507
+ * "security": "Common Stock",
1508
+ * "shares": "50000",
1509
+ * "shares_owned_after": "3764576",
1510
+ * "source_row_index": 1,
1511
+ * "transaction_code": "S",
1512
+ * "transaction_date": "2026-05-27",
1513
+ * "transaction_form_type": "4",
1514
+ * "transaction_timeliness": null,
1515
+ * "transaction_total_value": null,
1516
+ * "underlying_security": null
1517
+ * },
1518
+ * {
1519
+ * "accepted_at": "2026-05-29T22:30:27.000Z",
1520
+ * "accession_number": "0001140361-26-023363",
1521
+ * "acquired_disposed_code": "D",
1522
+ * "conversion_or_exercise_price": null,
1523
+ * "deemed_execution_date": null,
1524
+ * "equity_swap_involved": false,
1525
+ * "exercise_date": null,
1526
+ * "expiration_date": null,
1527
+ * "field_footnote_ids": {},
1528
+ * "footnote_ids": [],
1529
+ * "footnotes": [],
1530
+ * "nature_of_ownership": null,
1531
+ * "ownership_type": "direct",
1532
+ * "price": "0",
1533
+ * "reporting_owners": [
1534
+ * {
1535
+ * "address": {
1536
+ * "city": "CUPERTINO",
1537
+ * "country": null,
1538
+ * "state": "CA",
1539
+ * "street1": "ONE APPLE PARK WAY",
1540
+ * "street2": null,
1541
+ * "zip_code": "95014"
1542
+ * },
1543
+ * "cik": "0001214128",
1544
+ * "name": "LEVINSON ARTHUR D",
1545
+ * "relationship": {
1546
+ * "is_director": true,
1547
+ * "is_officer": null,
1548
+ * "is_other": null,
1549
+ * "is_ten_percent_owner": null,
1550
+ * "officer_title": null,
1551
+ * "other_text": null
1552
+ * }
1553
+ * }
1554
+ * ],
1555
+ * "row_kind": "nonderivative_transaction",
1556
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
1557
+ * "security": "Common Stock",
1558
+ * "shares": "65000",
1559
+ * "shares_owned_after": "3699576",
1560
+ * "source_row_index": 2,
1561
+ * "transaction_code": "G",
1562
+ * "transaction_date": "2026-05-27",
1563
+ * "transaction_form_type": "4",
1564
+ * "transaction_timeliness": null,
1565
+ * "transaction_total_value": null,
1566
+ * "underlying_security": null
1567
+ * }
1568
+ * ]
1569
+ * }
1570
+ */
1571
+ "application/json": components["schemas"]["CompanyInsiderTransactionsResponse"];
1572
+ };
1573
+ };
1574
+ /** @description The query parameters are invalid, or the requested filing-date window matches more than 1000 rows. */
1575
+ 400: {
1576
+ headers: {
1577
+ [name: string]: unknown;
1578
+ };
1579
+ content: {
1580
+ "application/json": components["schemas"]["CompanyInsiderTransactionsBadRequestResponse"];
1581
+ };
1582
+ };
1583
+ /** @description The request is missing a valid Chadwin API key. */
1584
+ 401: {
1585
+ headers: {
1586
+ [name: string]: unknown;
1587
+ };
1588
+ content: {
1589
+ "application/json": components["schemas"]["ErrorResponse"];
1590
+ };
1591
+ };
1592
+ /** @description The subscription does not include this dataset. */
1593
+ 403: {
1594
+ headers: {
1595
+ [name: string]: unknown;
1596
+ };
1597
+ content: {
1598
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1599
+ };
1600
+ };
1601
+ /** @description The requested company ticker was not found. */
1602
+ 404: {
1603
+ headers: {
1604
+ [name: string]: unknown;
1605
+ };
1606
+ content: {
1607
+ "application/json": components["schemas"]["ErrorResponse"];
1608
+ };
1609
+ };
1610
+ /** @description The request exceeded a rate limit. */
1611
+ 429: {
1612
+ headers: {
1613
+ "RateLimit-Limit"?: string;
1614
+ "RateLimit-Reset"?: string;
1615
+ "Retry-After"?: string;
1616
+ "X-Billing-Period-Quota-Limit"?: string;
1617
+ "X-Billing-Period-Quota-Remaining"?: string;
1618
+ "X-Billing-Period-Quota-Reset"?: string;
1619
+ [name: string]: unknown;
1620
+ };
1621
+ content: {
1622
+ "application/json": components["schemas"]["ErrorResponse"];
1623
+ };
1624
+ };
1625
+ /** @description The database is unavailable. */
1626
+ 503: {
1627
+ headers: {
1628
+ [name: string]: unknown;
1629
+ };
1630
+ content: {
1631
+ "application/json": components["schemas"]["ErrorResponse"];
1632
+ };
1633
+ };
1634
+ };
1635
+ };
1636
+ listCompanyProposedSales: {
1637
+ parameters: {
1638
+ query: {
1639
+ from: string;
1640
+ until?: string;
1641
+ };
1642
+ header?: never;
1643
+ path: {
1644
+ /** @description US listed company ticker */
1645
+ ticker: string;
1646
+ };
1647
+ cookie?: never;
1648
+ };
1649
+ requestBody?: never;
1650
+ responses: {
1651
+ /** @description Form 144 proposed-sale rows */
1652
+ 200: {
1653
+ headers: {
1654
+ "Cache-Control"?: string;
1655
+ "X-Billing-Period-Quota-Limit"?: string;
1656
+ "X-Billing-Period-Quota-Remaining"?: string;
1657
+ "X-Billing-Period-Quota-Reset"?: string;
1658
+ [name: string]: unknown;
1659
+ };
1660
+ content: {
1661
+ /**
1662
+ * @example {
1663
+ * "issuer": {
1664
+ * "cik": "0000320193",
1665
+ * "name": "Apple Inc.",
1666
+ * "ticker": "AAPL"
1667
+ * },
1668
+ * "proposed_sales": [
1669
+ * {
1670
+ * "accepted_at": "2026-07-29T18:04:05.000Z",
1671
+ * "accession_number": "0001140361-26-030001",
1672
+ * "amount": "100",
1673
+ * "approximate_sale_date": "2026-07-30",
1674
+ * "market_value": "20000.00",
1675
+ * "reporting_person": {
1676
+ * "cik": "0002100523",
1677
+ * "name": "Example Reporting Person",
1678
+ * "relationships": [
1679
+ * "Officer"
1680
+ * ]
1681
+ * },
1682
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm",
1683
+ * "security": "Common Stock",
1684
+ * "source_row_index": 1
1685
+ * }
1686
+ * ]
1687
+ * }
1688
+ */
1689
+ "application/json": components["schemas"]["CompanyProposedSalesResponse"];
1690
+ };
1691
+ };
1692
+ /** @description The query is invalid or matches more than 1000 rows */
1693
+ 400: {
1694
+ headers: {
1695
+ [name: string]: unknown;
1696
+ };
1697
+ content: {
1698
+ "application/json": components["schemas"]["ErrorResponse"];
1699
+ };
1700
+ };
1701
+ /** @description The request is missing a valid Chadwin API key. */
1702
+ 401: {
1703
+ headers: {
1704
+ [name: string]: unknown;
1705
+ };
1706
+ content: {
1707
+ "application/json": components["schemas"]["ErrorResponse"];
1708
+ };
1709
+ };
1710
+ /** @description The subscription does not include this dataset. */
1711
+ 403: {
1712
+ headers: {
1713
+ [name: string]: unknown;
1714
+ };
1715
+ content: {
1716
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1717
+ };
1718
+ };
1719
+ /** @description The requested company was not found */
1720
+ 404: {
1721
+ headers: {
1722
+ [name: string]: unknown;
1723
+ };
1724
+ content: {
1725
+ "application/json": components["schemas"]["ErrorResponse"];
1726
+ };
1727
+ };
1728
+ /** @description The request exceeded a rate limit. */
1729
+ 429: {
1730
+ headers: {
1731
+ "RateLimit-Limit"?: string;
1732
+ "RateLimit-Reset"?: string;
1733
+ "Retry-After"?: string;
1734
+ "X-Billing-Period-Quota-Limit"?: string;
1735
+ "X-Billing-Period-Quota-Remaining"?: string;
1736
+ "X-Billing-Period-Quota-Reset"?: string;
1737
+ [name: string]: unknown;
1738
+ };
1739
+ content: {
1740
+ "application/json": components["schemas"]["ErrorResponse"];
1741
+ };
1742
+ };
1743
+ /** @description The database is unavailable */
1744
+ 503: {
1745
+ headers: {
1746
+ [name: string]: unknown;
1747
+ };
1748
+ content: {
1749
+ "application/json": components["schemas"]["ErrorResponse"];
1750
+ };
1751
+ };
1752
+ };
1753
+ };
1754
+ getCompanyReport: {
1755
+ parameters: {
1756
+ query?: never;
1757
+ header?: never;
1758
+ path: {
1759
+ ticker: string;
1760
+ fiscal_year: string;
1761
+ };
1762
+ cookie?: never;
1763
+ };
1764
+ requestBody?: never;
1765
+ responses: {
1766
+ /** @description Annual report filing family */
1767
+ 200: {
1768
+ headers: {
1769
+ "Cache-Control"?: string;
1770
+ ETag?: 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
+ * "filings": [
1780
+ * {
1781
+ * "accepted_at": "2024-11-01T10:00:00.000Z",
1782
+ * "accession_number": "0000320193-24-000123",
1783
+ * "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
1784
+ * "form": "10-K",
1785
+ * "period_end_date": "2024-09-28",
1786
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
1787
+ * }
1788
+ * ],
1789
+ * "fiscal_period": "FY",
1790
+ * "fiscal_year": 2024,
1791
+ * "issuer": {
1792
+ * "cik": "0000320193",
1793
+ * "name": "Apple Inc.",
1794
+ * "ticker": "AAPL"
1795
+ * }
1796
+ * }
1797
+ */
1798
+ "application/json": components["schemas"]["CompanyReportFamilyResponse"];
1799
+ };
1800
+ };
1801
+ /** @description The ticker or fiscal year is invalid */
1802
+ 400: {
1803
+ headers: {
1804
+ [name: string]: unknown;
1805
+ };
1806
+ content: {
1807
+ "application/json": components["schemas"]["ErrorResponse"];
1808
+ };
1809
+ };
1810
+ /** @description The request is missing a valid Chadwin API key. */
1811
+ 401: {
1812
+ headers: {
1813
+ [name: string]: unknown;
1814
+ };
1815
+ content: {
1816
+ "application/json": components["schemas"]["ErrorResponse"];
1817
+ };
1818
+ };
1819
+ /** @description The subscription does not include this dataset. */
1820
+ 403: {
1821
+ headers: {
1822
+ [name: string]: unknown;
1823
+ };
1824
+ content: {
1825
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1826
+ };
1827
+ };
1828
+ /** @description The company or eligible annual report was not found */
1829
+ 404: {
1830
+ headers: {
1831
+ [name: string]: unknown;
1832
+ };
1833
+ content: {
1834
+ "application/json": components["schemas"]["ErrorResponse"];
1835
+ };
1836
+ };
1837
+ /** @description More than one original annual report matches the fiscal year */
1838
+ 409: {
1839
+ headers: {
1840
+ [name: string]: unknown;
1841
+ };
1842
+ content: {
1843
+ "application/json": components["schemas"]["ErrorResponse"];
1844
+ };
1845
+ };
1846
+ /** @description The request exceeded a rate limit. */
1847
+ 429: {
1848
+ headers: {
1849
+ "RateLimit-Limit"?: string;
1850
+ "RateLimit-Reset"?: string;
1851
+ "Retry-After"?: string;
1852
+ "X-Billing-Period-Quota-Limit"?: string;
1853
+ "X-Billing-Period-Quota-Remaining"?: string;
1854
+ "X-Billing-Period-Quota-Reset"?: string;
1855
+ [name: string]: unknown;
1856
+ };
1857
+ content: {
1858
+ "application/json": components["schemas"]["ErrorResponse"];
1859
+ };
1860
+ };
1861
+ /** @description The filing catalog is unavailable */
1862
+ 503: {
1863
+ headers: {
1864
+ [name: string]: unknown;
1865
+ };
1866
+ content: {
1867
+ "application/json": components["schemas"]["ErrorResponse"];
1868
+ };
1869
+ };
1870
+ };
1871
+ };
1872
+ listCompanyReportFeed: {
1873
+ parameters: {
1874
+ query?: {
1875
+ /** @description Use `next_cursor` from the previous response. Keep the same `forms` filter and do not combine this with `start`. */
1876
+ cursor?: string;
1877
+ /** @description Optional comma-separated annual-report families. Supported values are 10-K, 20-F, and 40-F. Each family includes its /A amendments. */
1878
+ forms?: string;
1879
+ /** @description Page size from 1 through 1000. */
1880
+ limit?: string;
1881
+ /** @description Set to `now` to establish a future-only cursor. Do not combine this with `cursor`. */
1882
+ start?: string;
1883
+ };
1884
+ header?: never;
1885
+ path?: never;
1886
+ cookie?: never;
1887
+ };
1888
+ requestBody?: never;
1889
+ responses: {
1890
+ /** @description Published annual report updates. */
1891
+ 200: {
1892
+ headers: {
1893
+ "Cache-Control"?: string;
1894
+ "X-Billing-Period-Quota-Limit"?: string;
1895
+ "X-Billing-Period-Quota-Remaining"?: string;
1896
+ "X-Billing-Period-Quota-Reset"?: string;
1897
+ [name: string]: unknown;
1898
+ };
1899
+ content: {
1900
+ /**
1901
+ * @example {
1902
+ * "has_more": false,
1903
+ * "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
1904
+ * "updates": [
1905
+ * {
1906
+ * "accepted_at": "2026-08-09T14:02:28.000Z",
1907
+ * "accession_number": "0000320193-26-000101",
1908
+ * "content_url": "/v1/sec/company-reports/0000320193-26-000101/content.html",
1909
+ * "feed_event_id": "crfe_000000000001",
1910
+ * "fiscal_period": "FY",
1911
+ * "fiscal_year": 2025,
1912
+ * "form": "10-K",
1913
+ * "issuer": {
1914
+ * "cik": "0000320193",
1915
+ * "name": "Apple Inc.",
1916
+ * "ticker": "AAPL"
1917
+ * },
1918
+ * "period_end_date": "2025-09-27",
1919
+ * "published_at": "2026-08-09T14:04:12.000Z",
1920
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000101/0000320193-26-000101-index.htm"
1921
+ * }
1922
+ * ]
1923
+ * }
1924
+ */
1925
+ "application/json": {
1926
+ has_more: boolean;
1927
+ next_cursor: string;
1928
+ updates: {
1929
+ /**
1930
+ * Format: date-time
1931
+ * @description SEC acceptance timestamp normalized to UTC.
1932
+ */
1933
+ accepted_at: string;
1934
+ accession_number: string;
1935
+ /** @description Relative authenticated API URL for the cleaned report HTML. */
1936
+ content_url: string;
1937
+ /** @description Stable idempotency key for this publication event. */
1938
+ feed_event_id: string;
1939
+ /** @enum {string|null} */
1940
+ fiscal_period: "FY" | null;
1941
+ fiscal_year: number | null;
1942
+ /** @enum {string} */
1943
+ form: "10-K" | "10-K/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A";
1944
+ issuer: {
1945
+ cik: string;
1946
+ name: string | null;
1947
+ ticker: string | null;
1948
+ };
1949
+ /** Format: date */
1950
+ period_end_date: string | null;
1951
+ /**
1952
+ * Format: date-time
1953
+ * @description Time Chadwin first published the prepared report.
1954
+ */
1955
+ published_at: string;
1956
+ /** Format: uri */
1957
+ sec_url: string;
1958
+ }[];
1959
+ };
1960
+ };
1961
+ };
1962
+ /** @description The feed query parameters are invalid. */
1963
+ 400: {
1964
+ headers: {
1965
+ [name: string]: unknown;
1966
+ };
1967
+ content: {
1968
+ "application/json": components["schemas"]["ErrorResponse"];
1969
+ };
1970
+ };
1971
+ /** @description The request is missing a valid Chadwin API key. */
1972
+ 401: {
1973
+ headers: {
1974
+ [name: string]: unknown;
1975
+ };
1976
+ content: {
1977
+ "application/json": components["schemas"]["ErrorResponse"];
1978
+ };
1979
+ };
1980
+ /** @description The subscription does not include this dataset. */
1981
+ 403: {
1982
+ headers: {
1983
+ [name: string]: unknown;
1984
+ };
1985
+ content: {
1986
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
1987
+ };
1988
+ };
1989
+ /** @description The request exceeded a rate limit. */
1990
+ 429: {
1991
+ headers: {
1992
+ "RateLimit-Limit"?: string;
1993
+ "RateLimit-Reset"?: string;
1994
+ "Retry-After"?: string;
1995
+ "X-Billing-Period-Quota-Limit"?: string;
1996
+ "X-Billing-Period-Quota-Remaining"?: string;
1997
+ "X-Billing-Period-Quota-Reset"?: string;
1998
+ [name: string]: unknown;
1999
+ };
2000
+ content: {
2001
+ "application/json": components["schemas"]["ErrorResponse"];
2002
+ };
2003
+ };
2004
+ /** @description The database is unavailable. */
2005
+ 503: {
2006
+ headers: {
2007
+ [name: string]: unknown;
2008
+ };
2009
+ content: {
2010
+ "application/json": components["schemas"]["ErrorResponse"];
2011
+ };
2012
+ };
2013
+ };
2014
+ };
2015
+ listInsiderActivityFeed: {
2016
+ parameters: {
2017
+ query?: {
2018
+ /** @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. */
2019
+ forms?: string;
2020
+ /** @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. */
2021
+ cursor?: string;
2022
+ /** @description Page size from 1 through 1000. */
2023
+ limit?: string;
2024
+ /** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
2025
+ start?: string;
2026
+ };
2027
+ header?: never;
2028
+ path?: never;
2029
+ cookie?: never;
2030
+ };
2031
+ requestBody?: never;
2032
+ responses: {
2033
+ /** @description Published insider activity feed events. */
2034
+ 200: {
2035
+ headers: {
2036
+ "Cache-Control"?: string;
2037
+ "X-Billing-Period-Quota-Limit"?: string;
2038
+ "X-Billing-Period-Quota-Remaining"?: string;
2039
+ "X-Billing-Period-Quota-Reset"?: string;
2040
+ [name: string]: unknown;
2041
+ };
2042
+ content: {
2043
+ "application/json": components["schemas"]["InsiderActivityFeedResponse"];
2044
+ };
2045
+ };
2046
+ /** @description The feed query parameters are invalid. */
2047
+ 400: {
2048
+ headers: {
2049
+ [name: string]: unknown;
2050
+ };
2051
+ content: {
2052
+ "application/json": components["schemas"]["InsiderActivityFeedBadRequestResponse"];
2053
+ };
2054
+ };
2055
+ /** @description The request is missing a valid Chadwin API key. */
2056
+ 401: {
2057
+ headers: {
2058
+ [name: string]: unknown;
2059
+ };
2060
+ content: {
2061
+ "application/json": components["schemas"]["ErrorResponse"];
2062
+ };
2063
+ };
2064
+ /** @description The subscription does not include this dataset. */
2065
+ 403: {
2066
+ headers: {
2067
+ [name: string]: unknown;
2068
+ };
2069
+ content: {
2070
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2071
+ };
2072
+ };
2073
+ /** @description The request exceeded a rate limit. */
2074
+ 429: {
2075
+ headers: {
2076
+ "RateLimit-Limit"?: string;
2077
+ "RateLimit-Reset"?: string;
2078
+ "Retry-After"?: string;
2079
+ "X-Billing-Period-Quota-Limit"?: string;
2080
+ "X-Billing-Period-Quota-Remaining"?: string;
2081
+ "X-Billing-Period-Quota-Reset"?: string;
2082
+ [name: string]: unknown;
2083
+ };
2084
+ content: {
2085
+ "application/json": components["schemas"]["ErrorResponse"];
2086
+ };
2087
+ };
2088
+ /** @description The database is unavailable. */
2089
+ 503: {
2090
+ headers: {
2091
+ [name: string]: unknown;
2092
+ };
2093
+ content: {
2094
+ "application/json": components["schemas"]["ErrorResponse"];
2095
+ };
2096
+ };
2097
+ };
2098
+ };
2099
+ listInsiderTransactions: {
2100
+ parameters: {
2101
+ query: {
2102
+ /** @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. */
2103
+ transaction_codes?: string;
2104
+ /** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. If the filing-date window matches more than 1000 rows, narrow the window. */
2105
+ from: string;
2106
+ /** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. If the filing-date window matches more than 1000 rows, narrow the window. */
2107
+ until?: string;
2108
+ /** @description Optional comma-separated US listed ticker filter. Tickers are resolved against current listed-company reference data before transactions are returned. */
2109
+ tickers?: string;
2110
+ };
2111
+ header?: never;
2112
+ path?: never;
2113
+ cookie?: never;
2114
+ };
2115
+ requestBody?: never;
2116
+ responses: {
2117
+ /** @description Insider transactions filed during the requested coverage window. */
2118
+ 200: {
2119
+ headers: {
2120
+ "Cache-Control"?: string;
2121
+ "X-Billing-Period-Quota-Limit"?: string;
2122
+ "X-Billing-Period-Quota-Remaining"?: string;
2123
+ "X-Billing-Period-Quota-Reset"?: string;
2124
+ [name: string]: unknown;
2125
+ };
2126
+ content: {
2127
+ /**
2128
+ * @example {
2129
+ * "transactions": [
2130
+ * {
2131
+ * "accepted_at": "2026-05-29T22:30:27.000Z",
2132
+ * "accession_number": "0001140361-26-023363",
2133
+ * "acquired_disposed_code": "D",
2134
+ * "conversion_or_exercise_price": null,
2135
+ * "deemed_execution_date": null,
2136
+ * "equity_swap_involved": false,
2137
+ * "exercise_date": null,
2138
+ * "expiration_date": null,
2139
+ * "field_footnote_ids": {
2140
+ * "price": [
2141
+ * "F1"
2142
+ * ]
2143
+ * },
2144
+ * "footnote_ids": [
2145
+ * "F1"
2146
+ * ],
2147
+ * "footnotes": [
2148
+ * {
2149
+ * "id": "F1",
2150
+ * "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."
2151
+ * }
2152
+ * ],
2153
+ * "issuer": {
2154
+ * "cik": "0000320193",
2155
+ * "name": "Apple Inc.",
2156
+ * "ticker": "AAPL"
2157
+ * },
2158
+ * "nature_of_ownership": null,
2159
+ * "ownership_type": "direct",
2160
+ * "price": "311.02",
2161
+ * "reporting_owners": [
2162
+ * {
2163
+ * "address": {
2164
+ * "city": "CUPERTINO",
2165
+ * "country": null,
2166
+ * "state": "CA",
2167
+ * "street1": "ONE APPLE PARK WAY",
2168
+ * "street2": null,
2169
+ * "zip_code": "95014"
2170
+ * },
2171
+ * "cik": "0001214128",
2172
+ * "name": "LEVINSON ARTHUR D",
2173
+ * "relationship": {
2174
+ * "is_director": true,
2175
+ * "is_officer": null,
2176
+ * "is_other": null,
2177
+ * "is_ten_percent_owner": null,
2178
+ * "officer_title": null,
2179
+ * "other_text": null
2180
+ * }
2181
+ * }
2182
+ * ],
2183
+ * "row_kind": "nonderivative_transaction",
2184
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
2185
+ * "security": "Common Stock",
2186
+ * "shares": "50000",
2187
+ * "shares_owned_after": "3764576",
2188
+ * "source_row_index": 1,
2189
+ * "transaction_code": "S",
2190
+ * "transaction_date": "2026-05-27",
2191
+ * "transaction_form_type": "4",
2192
+ * "transaction_timeliness": null,
2193
+ * "transaction_total_value": null,
2194
+ * "underlying_security": null
2195
+ * },
2196
+ * {
2197
+ * "accepted_at": "2026-05-29T22:30:27.000Z",
2198
+ * "accession_number": "0001140361-26-023363",
2199
+ * "acquired_disposed_code": "D",
2200
+ * "conversion_or_exercise_price": null,
2201
+ * "deemed_execution_date": null,
2202
+ * "equity_swap_involved": false,
2203
+ * "exercise_date": null,
2204
+ * "expiration_date": null,
2205
+ * "field_footnote_ids": {},
2206
+ * "footnote_ids": [],
2207
+ * "footnotes": [],
2208
+ * "issuer": {
2209
+ * "cik": "0000320193",
2210
+ * "name": "Apple Inc.",
2211
+ * "ticker": "AAPL"
2212
+ * },
2213
+ * "nature_of_ownership": null,
2214
+ * "ownership_type": "direct",
2215
+ * "price": "0",
2216
+ * "reporting_owners": [
2217
+ * {
2218
+ * "address": {
2219
+ * "city": "CUPERTINO",
2220
+ * "country": null,
2221
+ * "state": "CA",
2222
+ * "street1": "ONE APPLE PARK WAY",
2223
+ * "street2": null,
2224
+ * "zip_code": "95014"
2225
+ * },
2226
+ * "cik": "0001214128",
2227
+ * "name": "LEVINSON ARTHUR D",
2228
+ * "relationship": {
2229
+ * "is_director": true,
2230
+ * "is_officer": null,
2231
+ * "is_other": null,
2232
+ * "is_ten_percent_owner": null,
2233
+ * "officer_title": null,
2234
+ * "other_text": null
2235
+ * }
2236
+ * }
2237
+ * ],
2238
+ * "row_kind": "nonderivative_transaction",
2239
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm",
2240
+ * "security": "Common Stock",
2241
+ * "shares": "65000",
2242
+ * "shares_owned_after": "3699576",
2243
+ * "source_row_index": 2,
2244
+ * "transaction_code": "G",
2245
+ * "transaction_date": "2026-05-27",
2246
+ * "transaction_form_type": "4",
2247
+ * "transaction_timeliness": null,
2248
+ * "transaction_total_value": null,
2249
+ * "underlying_security": null
2250
+ * }
2251
+ * ]
2252
+ * }
2253
+ */
2254
+ "application/json": components["schemas"]["InsiderTransactionsResponse"];
2255
+ };
2256
+ };
2257
+ /** @description The query parameters are invalid, or the requested filing-date window matches more than 1000 rows. */
2258
+ 400: {
2259
+ headers: {
2260
+ [name: string]: unknown;
2261
+ };
2262
+ content: {
2263
+ "application/json": components["schemas"]["InsiderTransactionsBadRequestResponse"];
2264
+ };
2265
+ };
2266
+ /** @description The request is missing a valid Chadwin API key. */
2267
+ 401: {
2268
+ headers: {
2269
+ [name: string]: unknown;
2270
+ };
2271
+ content: {
2272
+ "application/json": components["schemas"]["ErrorResponse"];
2273
+ };
2274
+ };
2275
+ /** @description The subscription does not include this dataset. */
2276
+ 403: {
2277
+ headers: {
2278
+ [name: string]: unknown;
2279
+ };
2280
+ content: {
2281
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2282
+ };
2283
+ };
2284
+ /** @description The request exceeded a rate limit. */
2285
+ 429: {
2286
+ headers: {
2287
+ "RateLimit-Limit"?: string;
2288
+ "RateLimit-Reset"?: string;
2289
+ "Retry-After"?: string;
2290
+ "X-Billing-Period-Quota-Limit"?: string;
2291
+ "X-Billing-Period-Quota-Remaining"?: string;
2292
+ "X-Billing-Period-Quota-Reset"?: string;
2293
+ [name: string]: unknown;
2294
+ };
2295
+ content: {
2296
+ "application/json": components["schemas"]["ErrorResponse"];
2297
+ };
2298
+ };
2299
+ /** @description The database is unavailable. */
2300
+ 503: {
2301
+ headers: {
2302
+ [name: string]: unknown;
2303
+ };
2304
+ content: {
2305
+ "application/json": components["schemas"]["ErrorResponse"];
2306
+ };
2307
+ };
2308
+ };
2309
+ };
2310
+ listInsiderTransactionFeed: {
2311
+ parameters: {
2312
+ query?: {
2313
+ /** @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. */
2314
+ cursor?: string;
2315
+ /** @description Page size from 1 through 1000. */
2316
+ limit?: string;
2317
+ /** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
2318
+ start?: string;
2319
+ /** @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. */
2320
+ transaction_codes?: string;
2321
+ };
2322
+ header?: never;
2323
+ path?: never;
2324
+ cookie?: never;
2325
+ };
2326
+ requestBody?: never;
2327
+ responses: {
2328
+ /** @description Published insider transaction feed events. */
2329
+ 200: {
2330
+ headers: {
2331
+ "Cache-Control"?: string;
2332
+ "X-Billing-Period-Quota-Limit"?: string;
2333
+ "X-Billing-Period-Quota-Remaining"?: string;
2334
+ "X-Billing-Period-Quota-Reset"?: string;
2335
+ [name: string]: unknown;
2336
+ };
2337
+ content: {
2338
+ "application/json": components["schemas"]["InsiderTransactionFeedResponse"];
2339
+ };
2340
+ };
2341
+ /** @description The feed query parameters are invalid. */
2342
+ 400: {
2343
+ headers: {
2344
+ [name: string]: unknown;
2345
+ };
2346
+ content: {
2347
+ "application/json": components["schemas"]["InsiderTransactionFeedBadRequestResponse"];
2348
+ };
2349
+ };
2350
+ /** @description The request is missing a valid Chadwin API key. */
2351
+ 401: {
2352
+ headers: {
2353
+ [name: string]: unknown;
2354
+ };
2355
+ content: {
2356
+ "application/json": components["schemas"]["ErrorResponse"];
2357
+ };
2358
+ };
2359
+ /** @description The subscription does not include this dataset. */
2360
+ 403: {
2361
+ headers: {
2362
+ [name: string]: unknown;
2363
+ };
2364
+ content: {
2365
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2366
+ };
2367
+ };
2368
+ /** @description The request exceeded a rate limit. */
2369
+ 429: {
2370
+ headers: {
2371
+ "RateLimit-Limit"?: string;
2372
+ "RateLimit-Reset"?: string;
2373
+ "Retry-After"?: string;
2374
+ "X-Billing-Period-Quota-Limit"?: string;
2375
+ "X-Billing-Period-Quota-Remaining"?: string;
2376
+ "X-Billing-Period-Quota-Reset"?: string;
2377
+ [name: string]: unknown;
2378
+ };
2379
+ content: {
2380
+ "application/json": components["schemas"]["ErrorResponse"];
2381
+ };
2382
+ };
2383
+ /** @description The database is unavailable. */
2384
+ 503: {
2385
+ headers: {
2386
+ [name: string]: unknown;
2387
+ };
2388
+ content: {
2389
+ "application/json": components["schemas"]["ErrorResponse"];
2390
+ };
2391
+ };
2392
+ };
2393
+ };
2394
+ listInstitutionalHoldingFeed: {
2395
+ parameters: {
2396
+ query?: {
2397
+ /** @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. */
2398
+ cursor?: string;
2399
+ /** @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. */
2400
+ forms?: string;
2401
+ /** @description Page size from 1 through 1000. */
2402
+ limit?: string;
2403
+ /** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
2404
+ start?: string;
2405
+ };
2406
+ header?: never;
2407
+ path?: never;
2408
+ cookie?: never;
2409
+ };
2410
+ requestBody?: never;
2411
+ responses: {
2412
+ /** @description Published institutional holdings filing feed updates. */
2413
+ 200: {
2414
+ headers: {
2415
+ "Cache-Control"?: string;
2416
+ "X-Billing-Period-Quota-Limit"?: string;
2417
+ "X-Billing-Period-Quota-Remaining"?: string;
2418
+ "X-Billing-Period-Quota-Reset"?: string;
2419
+ [name: string]: unknown;
2420
+ };
2421
+ content: {
2422
+ "application/json": components["schemas"]["InstitutionalHoldingFeedResponse"];
2423
+ };
2424
+ };
2425
+ /** @description The feed query parameters are invalid. */
2426
+ 400: {
2427
+ headers: {
2428
+ [name: string]: unknown;
2429
+ };
2430
+ content: {
2431
+ "application/json": components["schemas"]["InstitutionalHoldingFeedBadRequestResponse"];
2432
+ };
2433
+ };
2434
+ /** @description The request is missing a valid Chadwin API key. */
2435
+ 401: {
2436
+ headers: {
2437
+ [name: string]: unknown;
2438
+ };
2439
+ content: {
2440
+ "application/json": components["schemas"]["ErrorResponse"];
2441
+ };
2442
+ };
2443
+ /** @description The subscription does not include this dataset. */
2444
+ 403: {
2445
+ headers: {
2446
+ [name: string]: unknown;
2447
+ };
2448
+ content: {
2449
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2450
+ };
2451
+ };
2452
+ /** @description The request exceeded a rate limit. */
2453
+ 429: {
2454
+ headers: {
2455
+ "RateLimit-Limit"?: string;
2456
+ "RateLimit-Reset"?: string;
2457
+ "Retry-After"?: string;
2458
+ "X-Billing-Period-Quota-Limit"?: string;
2459
+ "X-Billing-Period-Quota-Remaining"?: string;
2460
+ "X-Billing-Period-Quota-Reset"?: string;
2461
+ [name: string]: unknown;
2462
+ };
2463
+ content: {
2464
+ "application/json": components["schemas"]["ErrorResponse"];
2465
+ };
2466
+ };
2467
+ /** @description The database is unavailable. */
2468
+ 503: {
2469
+ headers: {
2470
+ [name: string]: unknown;
2471
+ };
2472
+ content: {
2473
+ "application/json": components["schemas"]["ErrorResponse"];
2474
+ };
2475
+ };
2476
+ };
2477
+ };
2478
+ listInstitutionalHoldingManagers: {
2479
+ parameters: {
2480
+ query?: {
2481
+ /** @description Optional pagination cursor returned as next_cursor from a prior response. */
2482
+ cursor?: string;
2483
+ /** @description Page size from 1 through 1000. */
2484
+ limit?: string;
2485
+ /** @description Optional Form 13F file-number filter for source filers associated with a manager profile. */
2486
+ form_13f_file_number?: string;
2487
+ /** @description Optional manager CIK filter for source filers associated with a manager profile. */
2488
+ cik?: string;
2489
+ };
2490
+ header?: never;
2491
+ path?: never;
2492
+ cookie?: never;
2493
+ };
2494
+ requestBody?: never;
2495
+ responses: {
2496
+ /** @description Paginated institutional manager profiles. */
2497
+ 200: {
2498
+ headers: {
2499
+ "Cache-Control"?: string;
2500
+ "X-Billing-Period-Quota-Limit"?: string;
2501
+ "X-Billing-Period-Quota-Remaining"?: string;
2502
+ "X-Billing-Period-Quota-Reset"?: string;
2503
+ [name: string]: unknown;
2504
+ };
2505
+ content: {
2506
+ /**
2507
+ * @example {
2508
+ * "has_more": false,
2509
+ * "managers": [
2510
+ * {
2511
+ * "cik": "0001067983",
2512
+ * "form_13f_file_number": "028-04545",
2513
+ * "holding_count": 124,
2514
+ * "latest_accepted_at": "2026-05-15T20:12:34.000Z",
2515
+ * "latest_period_of_report": "2026-03-31",
2516
+ * "name": "Berkshire Hathaway Inc.",
2517
+ * "total_value_usd": "267891234567"
2518
+ * }
2519
+ * ],
2520
+ * "next_cursor": "cur_eyJ2IjoxLCJuYW1lIjoiQmVya3NoaXJlIEhhdGhhd2F5IEluYy4iLCJmb3JtXzEzZl9maWxlX251bWJlciI6IjAyOC0wNDU0NSJ9"
2521
+ * }
2522
+ */
2523
+ "application/json": components["schemas"]["InstitutionalManagersResponse"];
2524
+ };
2525
+ };
2526
+ /** @description The query parameters are invalid. */
2527
+ 400: {
2528
+ headers: {
2529
+ [name: string]: unknown;
2530
+ };
2531
+ content: {
2532
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
2533
+ };
2534
+ };
2535
+ /** @description The request is missing a valid Chadwin API key. */
2536
+ 401: {
2537
+ headers: {
2538
+ [name: string]: unknown;
2539
+ };
2540
+ content: {
2541
+ "application/json": components["schemas"]["ErrorResponse"];
2542
+ };
2543
+ };
2544
+ /** @description The subscription does not include this dataset. */
2545
+ 403: {
2546
+ headers: {
2547
+ [name: string]: unknown;
2548
+ };
2549
+ content: {
2550
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2551
+ };
2552
+ };
2553
+ /** @description The request exceeded a rate limit. */
2554
+ 429: {
2555
+ headers: {
2556
+ "RateLimit-Limit"?: string;
2557
+ "RateLimit-Reset"?: string;
2558
+ "Retry-After"?: string;
2559
+ "X-Billing-Period-Quota-Limit"?: string;
2560
+ "X-Billing-Period-Quota-Remaining"?: string;
2561
+ "X-Billing-Period-Quota-Reset"?: string;
2562
+ [name: string]: unknown;
2563
+ };
2564
+ content: {
2565
+ "application/json": components["schemas"]["ErrorResponse"];
2566
+ };
2567
+ };
2568
+ /** @description The database is unavailable. */
2569
+ 503: {
2570
+ headers: {
2571
+ [name: string]: unknown;
2572
+ };
2573
+ content: {
2574
+ "application/json": components["schemas"]["ErrorResponse"];
2575
+ };
2576
+ };
2577
+ };
2578
+ };
2579
+ getInstitutionalHoldingManager: {
2580
+ parameters: {
2581
+ query?: never;
2582
+ header?: never;
2583
+ path: {
2584
+ /** @description SEC Form 13F file number */
2585
+ form_13f_file_number: string;
2586
+ };
2587
+ cookie?: never;
2588
+ };
2589
+ requestBody?: never;
2590
+ responses: {
2591
+ /** @description Institutional manager profile. */
2592
+ 200: {
2593
+ headers: {
2594
+ "Cache-Control"?: string;
2595
+ "X-Billing-Period-Quota-Limit"?: string;
2596
+ "X-Billing-Period-Quota-Remaining"?: string;
2597
+ "X-Billing-Period-Quota-Reset"?: string;
2598
+ [name: string]: unknown;
2599
+ };
2600
+ content: {
2601
+ /**
2602
+ * @example {
2603
+ * "latest_period": {
2604
+ * "accepted_at": "2026-05-15T20:12:34.000Z",
2605
+ * "holdings": {
2606
+ * "total_count": 124,
2607
+ * "total_value_usd": "267891234567",
2608
+ * "url": "/v1/institutional-holdings/managers/028-04545/holdings?period=2026-03-31"
2609
+ * },
2610
+ * "period_of_report": "2026-03-31"
2611
+ * },
2612
+ * "manager": {
2613
+ * "cik": "0001067983",
2614
+ * "form_13f_file_number": "028-04545",
2615
+ * "name": "Berkshire Hathaway Inc."
2616
+ * }
2617
+ * }
2618
+ */
2619
+ "application/json": components["schemas"]["InstitutionalManagerDetailResponse"];
2620
+ };
2621
+ };
2622
+ /** @description The Form 13F file number is invalid. */
2623
+ 400: {
2624
+ headers: {
2625
+ [name: string]: unknown;
2626
+ };
2627
+ content: {
2628
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
2629
+ };
2630
+ };
2631
+ /** @description The request is missing a valid Chadwin API key. */
2632
+ 401: {
2633
+ headers: {
2634
+ [name: string]: unknown;
2635
+ };
2636
+ content: {
2637
+ "application/json": components["schemas"]["ErrorResponse"];
2638
+ };
2639
+ };
2640
+ /** @description The subscription does not include this dataset. */
2641
+ 403: {
2642
+ headers: {
2643
+ [name: string]: unknown;
2644
+ };
2645
+ content: {
2646
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2647
+ };
2648
+ };
2649
+ /** @description The requested manager was not found. */
2650
+ 404: {
2651
+ headers: {
2652
+ [name: string]: unknown;
2653
+ };
2654
+ content: {
2655
+ "application/json": components["schemas"]["ErrorResponse"];
2656
+ };
2657
+ };
2658
+ /** @description The request exceeded a rate limit. */
2659
+ 429: {
2660
+ headers: {
2661
+ "RateLimit-Limit"?: string;
2662
+ "RateLimit-Reset"?: string;
2663
+ "Retry-After"?: string;
2664
+ "X-Billing-Period-Quota-Limit"?: string;
2665
+ "X-Billing-Period-Quota-Remaining"?: string;
2666
+ "X-Billing-Period-Quota-Reset"?: string;
2667
+ [name: string]: unknown;
2668
+ };
2669
+ content: {
2670
+ "application/json": components["schemas"]["ErrorResponse"];
2671
+ };
2672
+ };
2673
+ /** @description The database is unavailable. */
2674
+ 503: {
2675
+ headers: {
2676
+ [name: string]: unknown;
2677
+ };
2678
+ content: {
2679
+ "application/json": components["schemas"]["ErrorResponse"];
2680
+ };
2681
+ };
2682
+ };
2683
+ };
2684
+ listInstitutionalHoldingManagerHoldings: {
2685
+ parameters: {
2686
+ query: {
2687
+ /** @description Optional pagination cursor returned as next_cursor from a prior response. */
2688
+ cursor?: string;
2689
+ /** @description Page size from 1 through 5000. */
2690
+ limit?: string;
2691
+ /** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
2692
+ period: string;
2693
+ };
2694
+ header?: never;
2695
+ path: {
2696
+ /** @description SEC Form 13F file number */
2697
+ form_13f_file_number: string;
2698
+ };
2699
+ cookie?: never;
2700
+ };
2701
+ requestBody?: never;
2702
+ responses: {
2703
+ /** @description Paginated effective institutional manager holdings. */
2704
+ 200: {
2705
+ headers: {
2706
+ "Cache-Control"?: string;
2707
+ "X-Billing-Period-Quota-Limit"?: string;
2708
+ "X-Billing-Period-Quota-Remaining"?: string;
2709
+ "X-Billing-Period-Quota-Reset"?: string;
2710
+ [name: string]: unknown;
2711
+ };
2712
+ content: {
2713
+ /**
2714
+ * @example {
2715
+ * "has_more": false,
2716
+ * "holdings": [
2717
+ * {
2718
+ * "investment_discretion": "SOLE",
2719
+ * "other_managers": [],
2720
+ * "position": {
2721
+ * "amount": "1245000",
2722
+ * "market_value_usd": "221563000",
2723
+ * "type": "shares"
2724
+ * },
2725
+ * "security": {
2726
+ * "company": {
2727
+ * "cik": "0000320193",
2728
+ * "exchange": "NASDAQ",
2729
+ * "name": "Apple Inc.",
2730
+ * "ticker": "AAPL"
2731
+ * },
2732
+ * "issuer": "APPLE INC",
2733
+ * "option_type": null,
2734
+ * "title_of_class": "COM"
2735
+ * },
2736
+ * "source": {
2737
+ * "accession_number": "0000950123-26-004321"
2738
+ * },
2739
+ * "voting_authority": {
2740
+ * "none": "0",
2741
+ * "shared": "0",
2742
+ * "sole": "1245000"
2743
+ * }
2744
+ * }
2745
+ * ],
2746
+ * "manager": {
2747
+ * "cik": "0001067983",
2748
+ * "form_13f_file_number": "028-04545",
2749
+ * "name": "Berkshire Hathaway Inc."
2750
+ * },
2751
+ * "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
2752
+ * "period": {
2753
+ * "accepted_at": "2026-05-15T20:12:34.000Z",
2754
+ * "period_of_report": "2026-03-31"
2755
+ * }
2756
+ * }
2757
+ */
2758
+ "application/json": components["schemas"]["InstitutionalManagerHoldingsResponse"];
2759
+ };
2760
+ };
2761
+ /** @description The query parameters are invalid. */
2762
+ 400: {
2763
+ headers: {
2764
+ [name: string]: unknown;
2765
+ };
2766
+ content: {
2767
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
2768
+ };
2769
+ };
2770
+ /** @description The request is missing a valid Chadwin API key. */
2771
+ 401: {
2772
+ headers: {
2773
+ [name: string]: unknown;
2774
+ };
2775
+ content: {
2776
+ "application/json": components["schemas"]["ErrorResponse"];
2777
+ };
2778
+ };
2779
+ /** @description The subscription does not include this dataset. */
2780
+ 403: {
2781
+ headers: {
2782
+ [name: string]: unknown;
2783
+ };
2784
+ content: {
2785
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2786
+ };
2787
+ };
2788
+ /** @description The requested manager or report period was not found. */
2789
+ 404: {
2790
+ headers: {
2791
+ [name: string]: unknown;
2792
+ };
2793
+ content: {
2794
+ "application/json": components["schemas"]["ErrorResponse"];
2795
+ };
2796
+ };
2797
+ /** @description The request exceeded a rate limit. */
2798
+ 429: {
2799
+ headers: {
2800
+ "RateLimit-Limit"?: string;
2801
+ "RateLimit-Reset"?: string;
2802
+ "Retry-After"?: string;
2803
+ "X-Billing-Period-Quota-Limit"?: string;
2804
+ "X-Billing-Period-Quota-Remaining"?: string;
2805
+ "X-Billing-Period-Quota-Reset"?: string;
2806
+ [name: string]: unknown;
2807
+ };
2808
+ content: {
2809
+ "application/json": components["schemas"]["ErrorResponse"];
2810
+ };
2811
+ };
2812
+ /** @description The response could not be constructed. */
2813
+ 500: {
2814
+ headers: {
2815
+ [name: string]: unknown;
2816
+ };
2817
+ content: {
2818
+ "application/json": components["schemas"]["ErrorResponse"];
2819
+ };
2820
+ };
2821
+ /** @description The database is unavailable. */
2822
+ 503: {
2823
+ headers: {
2824
+ [name: string]: unknown;
2825
+ };
2826
+ content: {
2827
+ "application/json": components["schemas"]["ErrorResponse"];
2828
+ };
2829
+ };
2830
+ };
2831
+ };
2832
+ listInstitutionalHoldingManagerPeriods: {
2833
+ parameters: {
2834
+ query?: never;
2835
+ header?: never;
2836
+ path: {
2837
+ /** @description SEC Form 13F file number */
2838
+ form_13f_file_number: string;
2839
+ };
2840
+ cookie?: never;
2841
+ };
2842
+ requestBody?: never;
2843
+ responses: {
2844
+ /** @description Institutional manager report periods. */
2845
+ 200: {
2846
+ headers: {
2847
+ "Cache-Control"?: string;
2848
+ "X-Billing-Period-Quota-Limit"?: string;
2849
+ "X-Billing-Period-Quota-Remaining"?: string;
2850
+ "X-Billing-Period-Quota-Reset"?: string;
2851
+ [name: string]: unknown;
2852
+ };
2853
+ content: {
2854
+ /**
2855
+ * @example {
2856
+ * "manager": {
2857
+ * "cik": "0001067983",
2858
+ * "form_13f_file_number": "028-04545",
2859
+ * "name": "Berkshire Hathaway Inc."
2860
+ * },
2861
+ * "periods": [
2862
+ * {
2863
+ * "accepted_at": "2026-05-15T20:12:34.000Z",
2864
+ * "holdings": {
2865
+ * "total_count": 124,
2866
+ * "total_value_usd": "267891234567",
2867
+ * "url": "/v1/institutional-holdings/managers/028-04545/holdings?period=2026-03-31"
2868
+ * },
2869
+ * "period_of_report": "2026-03-31"
2870
+ * }
2871
+ * ]
2872
+ * }
2873
+ */
2874
+ "application/json": components["schemas"]["InstitutionalManagerPeriodsResponse"];
2875
+ };
2876
+ };
2877
+ /** @description The Form 13F file number is invalid. */
2878
+ 400: {
2879
+ headers: {
2880
+ [name: string]: unknown;
2881
+ };
2882
+ content: {
2883
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
2884
+ };
2885
+ };
2886
+ /** @description The request is missing a valid Chadwin API key. */
2887
+ 401: {
2888
+ headers: {
2889
+ [name: string]: unknown;
2890
+ };
2891
+ content: {
2892
+ "application/json": components["schemas"]["ErrorResponse"];
2893
+ };
2894
+ };
2895
+ /** @description The subscription does not include this dataset. */
2896
+ 403: {
2897
+ headers: {
2898
+ [name: string]: unknown;
2899
+ };
2900
+ content: {
2901
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
2902
+ };
2903
+ };
2904
+ /** @description The requested manager was not found. */
2905
+ 404: {
2906
+ headers: {
2907
+ [name: string]: unknown;
2908
+ };
2909
+ content: {
2910
+ "application/json": components["schemas"]["ErrorResponse"];
2911
+ };
2912
+ };
2913
+ /** @description The request exceeded a rate limit. */
2914
+ 429: {
2915
+ headers: {
2916
+ "RateLimit-Limit"?: string;
2917
+ "RateLimit-Reset"?: string;
2918
+ "Retry-After"?: string;
2919
+ "X-Billing-Period-Quota-Limit"?: string;
2920
+ "X-Billing-Period-Quota-Remaining"?: string;
2921
+ "X-Billing-Period-Quota-Reset"?: string;
2922
+ [name: string]: unknown;
2923
+ };
2924
+ content: {
2925
+ "application/json": components["schemas"]["ErrorResponse"];
2926
+ };
2927
+ };
2928
+ /** @description The database is unavailable. */
2929
+ 503: {
2930
+ headers: {
2931
+ [name: string]: unknown;
2932
+ };
2933
+ content: {
2934
+ "application/json": components["schemas"]["ErrorResponse"];
2935
+ };
2936
+ };
2937
+ };
2938
+ };
2939
+ listInstitutionalHoldingManagerPositions: {
2940
+ parameters: {
2941
+ query: {
2942
+ /** @description Optional pagination cursor returned as next_cursor from a prior response. */
2943
+ cursor?: string;
2944
+ /** @description Page size from 1 through 5000. */
2945
+ limit?: string;
2946
+ /** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
2947
+ period: string;
2948
+ };
2949
+ header?: never;
2950
+ path: {
2951
+ /** @description SEC Form 13F file number */
2952
+ form_13f_file_number: string;
2953
+ };
2954
+ cookie?: never;
2955
+ };
2956
+ requestBody?: never;
2957
+ responses: {
2958
+ /** @description Paginated consolidated institutional manager positions. */
2959
+ 200: {
2960
+ headers: {
2961
+ "Cache-Control"?: string;
2962
+ "X-Billing-Period-Quota-Limit"?: string;
2963
+ "X-Billing-Period-Quota-Remaining"?: string;
2964
+ "X-Billing-Period-Quota-Reset"?: string;
2965
+ [name: string]: unknown;
2966
+ };
2967
+ content: {
2968
+ /**
2969
+ * @example {
2970
+ * "has_more": false,
2971
+ * "manager": {
2972
+ * "cik": "0001067983",
2973
+ * "form_13f_file_number": "028-04545",
2974
+ * "name": "Berkshire Hathaway Inc."
2975
+ * },
2976
+ * "next_cursor": null,
2977
+ * "period": {
2978
+ * "accepted_at": "2026-05-15T20:12:34.000Z",
2979
+ * "period_of_report": "2026-03-31"
2980
+ * },
2981
+ * "positions": [
2982
+ * {
2983
+ * "position": {
2984
+ * "amount": "1245000",
2985
+ * "market_value_usd": "221563000",
2986
+ * "type": "shares"
2987
+ * },
2988
+ * "reported_holding_count": 3,
2989
+ * "security": {
2990
+ * "company": {
2991
+ * "cik": "0000320193",
2992
+ * "exchange": "NASDAQ",
2993
+ * "name": "Apple Inc.",
2994
+ * "ticker": "AAPL"
2995
+ * },
2996
+ * "issuer": "APPLE INC",
2997
+ * "option_type": null,
2998
+ * "title_of_class": "COM"
2999
+ * },
3000
+ * "voting_authority": {
3001
+ * "none": "0",
3002
+ * "shared": "0",
3003
+ * "sole": "1245000"
3004
+ * }
3005
+ * }
3006
+ * ]
3007
+ * }
3008
+ */
3009
+ "application/json": components["schemas"]["InstitutionalManagerPositionsResponse"];
3010
+ };
3011
+ };
3012
+ /** @description The query parameters are invalid. */
3013
+ 400: {
3014
+ headers: {
3015
+ [name: string]: unknown;
3016
+ };
3017
+ content: {
3018
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
3019
+ };
3020
+ };
3021
+ /** @description The request is missing a valid Chadwin API key. */
3022
+ 401: {
3023
+ headers: {
3024
+ [name: string]: unknown;
3025
+ };
3026
+ content: {
3027
+ "application/json": components["schemas"]["ErrorResponse"];
3028
+ };
3029
+ };
3030
+ /** @description The subscription does not include this dataset. */
3031
+ 403: {
3032
+ headers: {
3033
+ [name: string]: unknown;
3034
+ };
3035
+ content: {
3036
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3037
+ };
3038
+ };
3039
+ /** @description The requested manager or report period was not found. */
3040
+ 404: {
3041
+ headers: {
3042
+ [name: string]: unknown;
3043
+ };
3044
+ content: {
3045
+ "application/json": components["schemas"]["ErrorResponse"];
3046
+ };
3047
+ };
3048
+ /** @description The manager-period holdings changed after the cursor was issued. Restart pagination from the first page. */
3049
+ 409: {
3050
+ headers: {
3051
+ [name: string]: unknown;
3052
+ };
3053
+ content: {
3054
+ "application/json": components["schemas"]["ErrorResponse"];
3055
+ };
3056
+ };
3057
+ /** @description The request exceeded a rate limit. */
3058
+ 429: {
3059
+ headers: {
3060
+ "RateLimit-Limit"?: string;
3061
+ "RateLimit-Reset"?: string;
3062
+ "Retry-After"?: string;
3063
+ "X-Billing-Period-Quota-Limit"?: string;
3064
+ "X-Billing-Period-Quota-Remaining"?: string;
3065
+ "X-Billing-Period-Quota-Reset"?: string;
3066
+ [name: string]: unknown;
3067
+ };
3068
+ content: {
3069
+ "application/json": components["schemas"]["ErrorResponse"];
3070
+ };
3071
+ };
3072
+ /** @description The database is unavailable. */
3073
+ 503: {
3074
+ headers: {
3075
+ [name: string]: unknown;
3076
+ };
3077
+ content: {
3078
+ "application/json": components["schemas"]["ErrorResponse"];
3079
+ };
3080
+ };
3081
+ };
3082
+ };
3083
+ listProposedSales: {
3084
+ parameters: {
3085
+ query: {
3086
+ from: string;
3087
+ until?: string;
3088
+ tickers?: string;
3089
+ };
3090
+ header?: never;
3091
+ path?: never;
3092
+ cookie?: never;
3093
+ };
3094
+ requestBody?: never;
3095
+ responses: {
3096
+ /** @description Form 144 proposed-sale rows */
3097
+ 200: {
3098
+ headers: {
3099
+ "Cache-Control"?: string;
3100
+ "X-Billing-Period-Quota-Limit"?: string;
3101
+ "X-Billing-Period-Quota-Remaining"?: string;
3102
+ "X-Billing-Period-Quota-Reset"?: string;
3103
+ [name: string]: unknown;
3104
+ };
3105
+ content: {
3106
+ /**
3107
+ * @example {
3108
+ * "proposed_sales": [
3109
+ * {
3110
+ * "accepted_at": "2026-07-29T18:04:05.000Z",
3111
+ * "accession_number": "0001140361-26-030001",
3112
+ * "amount": "100",
3113
+ * "approximate_sale_date": "2026-07-30",
3114
+ * "issuer": {
3115
+ * "cik": "0000320193",
3116
+ * "name": "Apple Inc.",
3117
+ * "ticker": "AAPL"
3118
+ * },
3119
+ * "market_value": "20000.00",
3120
+ * "reporting_person": {
3121
+ * "cik": "0002100523",
3122
+ * "name": "Example Reporting Person",
3123
+ * "relationships": [
3124
+ * "Officer"
3125
+ * ]
3126
+ * },
3127
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm",
3128
+ * "security": "Common Stock",
3129
+ * "source_row_index": 1
3130
+ * }
3131
+ * ]
3132
+ * }
3133
+ */
3134
+ "application/json": components["schemas"]["ProposedSalesResponse"];
3135
+ };
3136
+ };
3137
+ /** @description The query is invalid or matches more than 1000 rows */
3138
+ 400: {
3139
+ headers: {
3140
+ [name: string]: unknown;
3141
+ };
3142
+ content: {
3143
+ "application/json": components["schemas"]["ErrorResponse"];
3144
+ };
3145
+ };
3146
+ /** @description The request is missing a valid Chadwin API key. */
3147
+ 401: {
3148
+ headers: {
3149
+ [name: string]: unknown;
3150
+ };
3151
+ content: {
3152
+ "application/json": components["schemas"]["ErrorResponse"];
3153
+ };
3154
+ };
3155
+ /** @description The subscription does not include this dataset. */
3156
+ 403: {
3157
+ headers: {
3158
+ [name: string]: unknown;
3159
+ };
3160
+ content: {
3161
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3162
+ };
3163
+ };
3164
+ /** @description The request exceeded a rate limit. */
3165
+ 429: {
3166
+ headers: {
3167
+ "RateLimit-Limit"?: string;
3168
+ "RateLimit-Reset"?: string;
3169
+ "Retry-After"?: string;
3170
+ "X-Billing-Period-Quota-Limit"?: string;
3171
+ "X-Billing-Period-Quota-Remaining"?: string;
3172
+ "X-Billing-Period-Quota-Reset"?: string;
3173
+ [name: string]: unknown;
3174
+ };
3175
+ content: {
3176
+ "application/json": components["schemas"]["ErrorResponse"];
3177
+ };
3178
+ };
3179
+ /** @description The database is unavailable */
3180
+ 503: {
3181
+ headers: {
3182
+ [name: string]: unknown;
3183
+ };
3184
+ content: {
3185
+ "application/json": components["schemas"]["ErrorResponse"];
3186
+ };
3187
+ };
3188
+ };
3189
+ };
3190
+ getSecCompanyReport: {
3191
+ parameters: {
3192
+ query?: never;
3193
+ header?: never;
3194
+ path: {
3195
+ accession: string;
3196
+ };
3197
+ cookie?: never;
3198
+ };
3199
+ requestBody?: never;
3200
+ responses: {
3201
+ /** @description Company report metadata */
3202
+ 200: {
3203
+ headers: {
3204
+ "Cache-Control"?: string;
3205
+ ETag?: string;
3206
+ "X-Billing-Period-Quota-Limit"?: string;
3207
+ "X-Billing-Period-Quota-Remaining"?: string;
3208
+ "X-Billing-Period-Quota-Reset"?: string;
3209
+ [name: string]: unknown;
3210
+ };
3211
+ content: {
3212
+ /**
3213
+ * @example {
3214
+ * "accepted_at": "2024-11-01T10:00:00.000Z",
3215
+ * "accession_number": "0000320193-24-000123",
3216
+ * "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
3217
+ * "fiscal_period": "FY",
3218
+ * "fiscal_year": 2024,
3219
+ * "form": "10-K",
3220
+ * "issuer": {
3221
+ * "cik": "0000320193",
3222
+ * "name": "Apple Inc.",
3223
+ * "ticker": "AAPL"
3224
+ * },
3225
+ * "period_end_date": "2024-09-28",
3226
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
3227
+ * }
3228
+ */
3229
+ "application/json": components["schemas"]["CompanyReportResponse"];
3230
+ };
3231
+ };
3232
+ /** @description The accession is invalid */
3233
+ 400: {
3234
+ headers: {
3235
+ [name: string]: unknown;
3236
+ };
3237
+ content: {
3238
+ "application/json": components["schemas"]["ErrorResponse"];
3239
+ };
3240
+ };
3241
+ /** @description The request is missing a valid Chadwin API key. */
3242
+ 401: {
3243
+ headers: {
3244
+ [name: string]: unknown;
3245
+ };
3246
+ content: {
3247
+ "application/json": components["schemas"]["ErrorResponse"];
3248
+ };
3249
+ };
3250
+ /** @description The subscription does not include this dataset. */
3251
+ 403: {
3252
+ headers: {
3253
+ [name: string]: unknown;
3254
+ };
3255
+ content: {
3256
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3257
+ };
3258
+ };
3259
+ /** @description The company report was not found */
3260
+ 404: {
3261
+ headers: {
3262
+ [name: string]: unknown;
3263
+ };
3264
+ content: {
3265
+ "application/json": components["schemas"]["ErrorResponse"];
3266
+ };
3267
+ };
3268
+ /** @description The request exceeded a rate limit. */
3269
+ 429: {
3270
+ headers: {
3271
+ "RateLimit-Limit"?: string;
3272
+ "RateLimit-Reset"?: string;
3273
+ "Retry-After"?: string;
3274
+ "X-Billing-Period-Quota-Limit"?: string;
3275
+ "X-Billing-Period-Quota-Remaining"?: string;
3276
+ "X-Billing-Period-Quota-Reset"?: string;
3277
+ [name: string]: unknown;
3278
+ };
3279
+ content: {
3280
+ "application/json": components["schemas"]["ErrorResponse"];
3281
+ };
3282
+ };
3283
+ /** @description The filing catalog is unavailable */
3284
+ 503: {
3285
+ headers: {
3286
+ [name: string]: unknown;
3287
+ };
3288
+ content: {
3289
+ "application/json": components["schemas"]["ErrorResponse"];
3290
+ };
3291
+ };
3292
+ };
3293
+ };
3294
+ getSecCompanyReportContent: {
3295
+ parameters: {
3296
+ query?: never;
3297
+ header?: never;
3298
+ path: {
3299
+ accession: string;
3300
+ };
3301
+ cookie?: never;
3302
+ };
3303
+ requestBody?: never;
3304
+ responses: {
3305
+ /** @description Cleaned company report HTML */
3306
+ 200: {
3307
+ headers: {
3308
+ "Cache-Control"?: string;
3309
+ "Content-Security-Policy"?: string;
3310
+ ETag?: string;
3311
+ "X-Billing-Period-Quota-Limit"?: string;
3312
+ "X-Billing-Period-Quota-Remaining"?: string;
3313
+ "X-Billing-Period-Quota-Reset"?: string;
3314
+ "X-Content-Type-Options"?: string;
3315
+ [name: string]: unknown;
3316
+ };
3317
+ content: {
3318
+ /** @example <!doctype html><html><body><h1>Annual report</h1></body></html> */
3319
+ "text/html": string;
3320
+ };
3321
+ };
3322
+ /** @description The accession is invalid */
3323
+ 400: {
3324
+ headers: {
3325
+ [name: string]: unknown;
3326
+ };
3327
+ content: {
3328
+ "application/json": components["schemas"]["ErrorResponse"];
3329
+ };
3330
+ };
3331
+ /** @description The request is missing a valid Chadwin API key. */
3332
+ 401: {
3333
+ headers: {
3334
+ [name: string]: unknown;
3335
+ };
3336
+ content: {
3337
+ "application/json": components["schemas"]["ErrorResponse"];
3338
+ };
3339
+ };
3340
+ /** @description The subscription does not include this dataset. */
3341
+ 403: {
3342
+ headers: {
3343
+ [name: string]: unknown;
3344
+ };
3345
+ content: {
3346
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3347
+ };
3348
+ };
3349
+ /** @description The company report was not found */
3350
+ 404: {
3351
+ headers: {
3352
+ [name: string]: unknown;
3353
+ };
3354
+ content: {
3355
+ "application/json": components["schemas"]["ErrorResponse"];
3356
+ };
3357
+ };
3358
+ /** @description The request exceeded a rate limit. */
3359
+ 429: {
3360
+ headers: {
3361
+ "RateLimit-Limit"?: string;
3362
+ "RateLimit-Reset"?: string;
3363
+ "Retry-After"?: string;
3364
+ "X-Billing-Period-Quota-Limit"?: string;
3365
+ "X-Billing-Period-Quota-Remaining"?: string;
3366
+ "X-Billing-Period-Quota-Reset"?: string;
3367
+ [name: string]: unknown;
3368
+ };
3369
+ content: {
3370
+ "application/json": components["schemas"]["ErrorResponse"];
3371
+ };
3372
+ };
3373
+ /** @description The catalog or prepared HTML is unavailable */
3374
+ 503: {
3375
+ headers: {
3376
+ [name: string]: unknown;
3377
+ };
3378
+ content: {
3379
+ "application/json": components["schemas"]["ErrorResponse"];
3380
+ };
3381
+ };
3382
+ };
3383
+ };
3384
+ getSecInsiderFiling: {
3385
+ parameters: {
3386
+ query?: never;
3387
+ header?: never;
3388
+ path: {
3389
+ /** @description SEC accession number with dashes */
3390
+ accession: string;
3391
+ };
3392
+ cookie?: never;
3393
+ };
3394
+ requestBody?: never;
3395
+ responses: {
3396
+ /** @description Complete parsed Section 16 ownership filing */
3397
+ 200: {
3398
+ headers: {
3399
+ "Cache-Control"?: string;
3400
+ ETag?: string;
3401
+ "X-Billing-Period-Quota-Limit"?: string;
3402
+ "X-Billing-Period-Quota-Remaining"?: string;
3403
+ "X-Billing-Period-Quota-Reset"?: string;
3404
+ [name: string]: unknown;
3405
+ };
3406
+ content: {
3407
+ /**
3408
+ * @example {
3409
+ * "accepted_at": "2026-05-29T22:30:27.000Z",
3410
+ * "accession_number": "0001140361-26-023363",
3411
+ * "date_of_original_submission": null,
3412
+ * "derivative_holdings": [],
3413
+ * "derivative_transactions": [],
3414
+ * "footnotes": [
3415
+ * {
3416
+ * "id": "F1",
3417
+ * "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."
3418
+ * }
3419
+ * ],
3420
+ * "form": "4",
3421
+ * "issuer": {
3422
+ * "cik": "0000320193",
3423
+ * "name": "Apple Inc.",
3424
+ * "ticker": "AAPL"
3425
+ * },
3426
+ * "non_derivative_holdings": [
3427
+ * {
3428
+ * "field_footnote_ids": {},
3429
+ * "footnote_ids": [],
3430
+ * "late_holding_form_type": null,
3431
+ * "nature_of_ownership": "By Spouse",
3432
+ * "ownership_type": "indirect",
3433
+ * "security": "Common Stock",
3434
+ * "shares_owned_after": "56000",
3435
+ * "source_row_index": 1,
3436
+ * "value_owned_after": null
3437
+ * }
3438
+ * ],
3439
+ * "non_derivative_transactions": [
3440
+ * {
3441
+ * "acquired_disposed_code": "D",
3442
+ * "conversion_or_exercise_price": null,
3443
+ * "deemed_execution_date": null,
3444
+ * "equity_swap_involved": false,
3445
+ * "exercise_date": null,
3446
+ * "expiration_date": null,
3447
+ * "field_footnote_ids": {
3448
+ * "price": [
3449
+ * "F1"
3450
+ * ]
3451
+ * },
3452
+ * "footnote_ids": [
3453
+ * "F1"
3454
+ * ],
3455
+ * "nature_of_ownership": null,
3456
+ * "ownership_type": "direct",
3457
+ * "price": "311.02",
3458
+ * "security": "Common Stock",
3459
+ * "shares": "50000",
3460
+ * "shares_owned_after": "3764576",
3461
+ * "source_row_index": 1,
3462
+ * "transaction_code": "S",
3463
+ * "transaction_date": "2026-05-27",
3464
+ * "transaction_form_type": "4",
3465
+ * "transaction_timeliness": null,
3466
+ * "transaction_total_value": null,
3467
+ * "underlying_security": null
3468
+ * },
3469
+ * {
3470
+ * "acquired_disposed_code": "D",
3471
+ * "conversion_or_exercise_price": null,
3472
+ * "deemed_execution_date": null,
3473
+ * "equity_swap_involved": false,
3474
+ * "exercise_date": null,
3475
+ * "expiration_date": null,
3476
+ * "field_footnote_ids": {},
3477
+ * "footnote_ids": [],
3478
+ * "nature_of_ownership": null,
3479
+ * "ownership_type": "direct",
3480
+ * "price": "0",
3481
+ * "security": "Common Stock",
3482
+ * "shares": "65000",
3483
+ * "shares_owned_after": "3699576",
3484
+ * "source_row_index": 2,
3485
+ * "transaction_code": "G",
3486
+ * "transaction_date": "2026-05-27",
3487
+ * "transaction_form_type": "4",
3488
+ * "transaction_timeliness": null,
3489
+ * "transaction_total_value": null,
3490
+ * "underlying_security": null
3491
+ * }
3492
+ * ],
3493
+ * "not_subject_to_section_16": null,
3494
+ * "owner_signatures": [
3495
+ * {
3496
+ * "date": "2026-05-29",
3497
+ * "name": "/s/ Sam Whittington, Attorney-in-Fact for Arthur D. Levinson"
3498
+ * }
3499
+ * ],
3500
+ * "period_of_report": "2026-05-27",
3501
+ * "remarks": null,
3502
+ * "reporting_owners": [
3503
+ * {
3504
+ * "address": {
3505
+ * "city": "CUPERTINO",
3506
+ * "country": null,
3507
+ * "state": "CA",
3508
+ * "street1": "ONE APPLE PARK WAY",
3509
+ * "street2": null,
3510
+ * "zip_code": "95014"
3511
+ * },
3512
+ * "cik": "0001214128",
3513
+ * "name": "LEVINSON ARTHUR D",
3514
+ * "relationship": {
3515
+ * "is_director": true,
3516
+ * "is_officer": null,
3517
+ * "is_other": null,
3518
+ * "is_ten_percent_owner": null,
3519
+ * "officer_title": null,
3520
+ * "other_text": null
3521
+ * }
3522
+ * }
3523
+ * ],
3524
+ * "rule_10b5_1": false,
3525
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126023363/0001140361-26-023363-index.htm"
3526
+ * }
3527
+ */
3528
+ "application/json": components["schemas"]["InsiderFilingDocument"];
3529
+ };
3530
+ };
3531
+ /** @description The accession number is invalid. */
3532
+ 400: {
3533
+ headers: {
3534
+ [name: string]: unknown;
3535
+ };
3536
+ content: {
3537
+ "application/json": components["schemas"]["ErrorResponse"];
3538
+ };
3539
+ };
3540
+ /** @description The request is missing a valid Chadwin API key. */
3541
+ 401: {
3542
+ headers: {
3543
+ [name: string]: unknown;
3544
+ };
3545
+ content: {
3546
+ "application/json": components["schemas"]["ErrorResponse"];
3547
+ };
3548
+ };
3549
+ /** @description The subscription does not include this dataset. */
3550
+ 403: {
3551
+ headers: {
3552
+ [name: string]: unknown;
3553
+ };
3554
+ content: {
3555
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3556
+ };
3557
+ };
3558
+ /** @description The requested insider filing was not found. */
3559
+ 404: {
3560
+ headers: {
3561
+ [name: string]: unknown;
3562
+ };
3563
+ content: {
3564
+ "application/json": components["schemas"]["ErrorResponse"];
3565
+ };
3566
+ };
3567
+ /** @description The request exceeded a rate limit. */
3568
+ 429: {
3569
+ headers: {
3570
+ "RateLimit-Limit"?: string;
3571
+ "RateLimit-Reset"?: string;
3572
+ "Retry-After"?: string;
3573
+ "X-Billing-Period-Quota-Limit"?: string;
3574
+ "X-Billing-Period-Quota-Remaining"?: string;
3575
+ "X-Billing-Period-Quota-Reset"?: string;
3576
+ [name: string]: unknown;
3577
+ };
3578
+ content: {
3579
+ "application/json": components["schemas"]["ErrorResponse"];
3580
+ };
3581
+ };
3582
+ /** @description The filing storage layer is unavailable. */
3583
+ 503: {
3584
+ headers: {
3585
+ [name: string]: unknown;
3586
+ };
3587
+ content: {
3588
+ "application/json": components["schemas"]["ErrorResponse"];
3589
+ };
3590
+ };
3591
+ };
3592
+ };
3593
+ getSecInstitutionalFiling: {
3594
+ parameters: {
3595
+ query?: never;
3596
+ header?: never;
3597
+ path: {
3598
+ /** @description SEC accession number with dashes */
3599
+ accession: string;
3600
+ };
3601
+ cookie?: never;
3602
+ };
3603
+ requestBody?: never;
3604
+ responses: {
3605
+ /** @description Parsed institutional filing metadata. */
3606
+ 200: {
3607
+ headers: {
3608
+ "Cache-Control"?: string;
3609
+ "X-Billing-Period-Quota-Limit"?: string;
3610
+ "X-Billing-Period-Quota-Remaining"?: string;
3611
+ "X-Billing-Period-Quota-Reset"?: string;
3612
+ [name: string]: unknown;
3613
+ };
3614
+ content: {
3615
+ /**
3616
+ * @example {
3617
+ * "accepted_at": "2026-05-15T20:12:34.000Z",
3618
+ * "accession_number": "0000950123-26-004321",
3619
+ * "amendment": null,
3620
+ * "confidential_treatment_requested": false,
3621
+ * "form": "13F-HR",
3622
+ * "holdings": {
3623
+ * "total_count": 124,
3624
+ * "total_value_usd": "267891234567",
3625
+ * "url": "/v1/sec/institutional-filings/0000950123-26-004321/holdings"
3626
+ * },
3627
+ * "included_managers": [],
3628
+ * "manager": {
3629
+ * "address": {
3630
+ * "city": "OMAHA",
3631
+ * "state_or_country": "NE",
3632
+ * "street1": "3555 FARNAM STREET",
3633
+ * "street2": null,
3634
+ * "zip_code": "68131"
3635
+ * },
3636
+ * "cik": "0001067983",
3637
+ * "crd_number": null,
3638
+ * "form_13f_file_number": "028-04545",
3639
+ * "name": "Berkshire Hathaway Inc."
3640
+ * },
3641
+ * "other_reporting_managers": [],
3642
+ * "period_of_report": "2026-03-31",
3643
+ * "remarks": null,
3644
+ * "report_type": "13F HOLDINGS REPORT",
3645
+ * "signature": null
3646
+ * }
3647
+ */
3648
+ "application/json": components["schemas"]["InstitutionalFilingDetailResponse"];
3649
+ };
3650
+ };
3651
+ /** @description The accession number is invalid. */
3652
+ 400: {
3653
+ headers: {
3654
+ [name: string]: unknown;
3655
+ };
3656
+ content: {
3657
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
3658
+ };
3659
+ };
3660
+ /** @description The request is missing a valid Chadwin API key. */
3661
+ 401: {
3662
+ headers: {
3663
+ [name: string]: unknown;
3664
+ };
3665
+ content: {
3666
+ "application/json": components["schemas"]["ErrorResponse"];
3667
+ };
3668
+ };
3669
+ /** @description The subscription does not include this dataset. */
3670
+ 403: {
3671
+ headers: {
3672
+ [name: string]: unknown;
3673
+ };
3674
+ content: {
3675
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3676
+ };
3677
+ };
3678
+ /** @description The requested institutional filing was not found. */
3679
+ 404: {
3680
+ headers: {
3681
+ [name: string]: unknown;
3682
+ };
3683
+ content: {
3684
+ "application/json": components["schemas"]["ErrorResponse"];
3685
+ };
3686
+ };
3687
+ /** @description The request exceeded a rate limit. */
3688
+ 429: {
3689
+ headers: {
3690
+ "RateLimit-Limit"?: string;
3691
+ "RateLimit-Reset"?: string;
3692
+ "Retry-After"?: string;
3693
+ "X-Billing-Period-Quota-Limit"?: string;
3694
+ "X-Billing-Period-Quota-Remaining"?: string;
3695
+ "X-Billing-Period-Quota-Reset"?: string;
3696
+ [name: string]: unknown;
3697
+ };
3698
+ content: {
3699
+ "application/json": components["schemas"]["ErrorResponse"];
3700
+ };
3701
+ };
3702
+ /** @description The database is unavailable. */
3703
+ 503: {
3704
+ headers: {
3705
+ [name: string]: unknown;
3706
+ };
3707
+ content: {
3708
+ "application/json": components["schemas"]["ErrorResponse"];
3709
+ };
3710
+ };
3711
+ };
3712
+ };
3713
+ listSecInstitutionalFilingHoldings: {
3714
+ parameters: {
3715
+ query?: {
3716
+ /** @description Optional pagination cursor returned as next_cursor from a prior response. */
3717
+ cursor?: string;
3718
+ /** @description Page size from 1 through 5000. */
3719
+ limit?: string;
3720
+ };
3721
+ header?: never;
3722
+ path: {
3723
+ /** @description SEC accession number with dashes */
3724
+ accession: string;
3725
+ };
3726
+ cookie?: never;
3727
+ };
3728
+ requestBody?: never;
3729
+ responses: {
3730
+ /** @description Paginated as-filed institutional holding rows. */
3731
+ 200: {
3732
+ headers: {
3733
+ "Cache-Control"?: string;
3734
+ "X-Billing-Period-Quota-Limit"?: string;
3735
+ "X-Billing-Period-Quota-Remaining"?: string;
3736
+ "X-Billing-Period-Quota-Reset"?: string;
3737
+ [name: string]: unknown;
3738
+ };
3739
+ content: {
3740
+ /**
3741
+ * @example {
3742
+ * "accession_number": "0000950123-26-004321",
3743
+ * "form": "13F-HR",
3744
+ * "has_more": false,
3745
+ * "holdings": [
3746
+ * {
3747
+ * "investment_discretion": "SOLE",
3748
+ * "other_managers": [],
3749
+ * "position": {
3750
+ * "amount": "1245000",
3751
+ * "market_value_usd": "221563000",
3752
+ * "type": "shares"
3753
+ * },
3754
+ * "security": {
3755
+ * "company": {
3756
+ * "cik": "0000320193",
3757
+ * "exchange": "NASDAQ",
3758
+ * "name": "Apple Inc.",
3759
+ * "ticker": "AAPL"
3760
+ * },
3761
+ * "issuer": "APPLE INC",
3762
+ * "option_type": null,
3763
+ * "title_of_class": "COM"
3764
+ * },
3765
+ * "voting_authority": {
3766
+ * "none": "0",
3767
+ * "shared": "0",
3768
+ * "sole": "1245000"
3769
+ * }
3770
+ * }
3771
+ * ],
3772
+ * "next_cursor": "cur_eyJ2IjoxLCJhZnRlciI6MX0",
3773
+ * "period_of_report": "2026-03-31",
3774
+ * "report_type": "13F HOLDINGS REPORT"
3775
+ * }
3776
+ */
3777
+ "application/json": components["schemas"]["InstitutionalFilingHoldingsResponse"];
3778
+ };
3779
+ };
3780
+ /** @description The query parameters are invalid. */
3781
+ 400: {
3782
+ headers: {
3783
+ [name: string]: unknown;
3784
+ };
3785
+ content: {
3786
+ "application/json": components["schemas"]["InstitutionalHoldingsBadRequestResponse"];
3787
+ };
3788
+ };
3789
+ /** @description The request is missing a valid Chadwin API key. */
3790
+ 401: {
3791
+ headers: {
3792
+ [name: string]: unknown;
3793
+ };
3794
+ content: {
3795
+ "application/json": components["schemas"]["ErrorResponse"];
3796
+ };
3797
+ };
3798
+ /** @description The subscription does not include this dataset. */
3799
+ 403: {
3800
+ headers: {
3801
+ [name: string]: unknown;
3802
+ };
3803
+ content: {
3804
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3805
+ };
3806
+ };
3807
+ /** @description The requested institutional filing was not found. */
3808
+ 404: {
3809
+ headers: {
3810
+ [name: string]: unknown;
3811
+ };
3812
+ content: {
3813
+ "application/json": components["schemas"]["ErrorResponse"];
3814
+ };
3815
+ };
3816
+ /** @description The request exceeded a rate limit. */
3817
+ 429: {
3818
+ headers: {
3819
+ "RateLimit-Limit"?: string;
3820
+ "RateLimit-Reset"?: string;
3821
+ "Retry-After"?: string;
3822
+ "X-Billing-Period-Quota-Limit"?: string;
3823
+ "X-Billing-Period-Quota-Remaining"?: string;
3824
+ "X-Billing-Period-Quota-Reset"?: string;
3825
+ [name: string]: unknown;
3826
+ };
3827
+ content: {
3828
+ "application/json": components["schemas"]["ErrorResponse"];
3829
+ };
3830
+ };
3831
+ /** @description The response could not be constructed. */
3832
+ 500: {
3833
+ headers: {
3834
+ [name: string]: unknown;
3835
+ };
3836
+ content: {
3837
+ "application/json": components["schemas"]["ErrorResponse"];
3838
+ };
3839
+ };
3840
+ /** @description The database is unavailable. */
3841
+ 503: {
3842
+ headers: {
3843
+ [name: string]: unknown;
3844
+ };
3845
+ content: {
3846
+ "application/json": components["schemas"]["ErrorResponse"];
3847
+ };
3848
+ };
3849
+ };
3850
+ };
3851
+ getSecProposedSaleFiling: {
3852
+ parameters: {
3853
+ query?: never;
3854
+ header?: never;
3855
+ path: {
3856
+ accession: string;
3857
+ };
3858
+ cookie?: never;
3859
+ };
3860
+ requestBody?: never;
3861
+ responses: {
3862
+ /** @description Parsed Form 144 filing */
3863
+ 200: {
3864
+ headers: {
3865
+ "Cache-Control"?: string;
3866
+ ETag?: string;
3867
+ "X-Billing-Period-Quota-Limit"?: string;
3868
+ "X-Billing-Period-Quota-Remaining"?: string;
3869
+ "X-Billing-Period-Quota-Reset"?: string;
3870
+ [name: string]: unknown;
3871
+ };
3872
+ content: {
3873
+ /**
3874
+ * @example {
3875
+ * "accepted_at": "2026-07-29T18:04:05.000Z",
3876
+ * "accession_number": "0001140361-26-030001",
3877
+ * "form": "144",
3878
+ * "issuer": {
3879
+ * "cik": "0000320193",
3880
+ * "name": "Apple Inc.",
3881
+ * "ticker": "AAPL"
3882
+ * },
3883
+ * "nothing_to_report": true,
3884
+ * "notice": {
3885
+ * "date": "2026-07-29",
3886
+ * "plan_adoption_dates": [
3887
+ * "2026-01-10"
3888
+ * ],
3889
+ * "signature": "/s/ Example Reporting Person"
3890
+ * },
3891
+ * "past_three_month_sales": [],
3892
+ * "previous_accession_number": null,
3893
+ * "proposed_sales": [
3894
+ * {
3895
+ * "amount": "100",
3896
+ * "amount_outstanding": "15000000000",
3897
+ * "approximate_sale_date": "2026-07-30",
3898
+ * "broker_or_market_maker": "Example Broker",
3899
+ * "intended_sale_exchange": "NASDAQ",
3900
+ * "market_value": "20000.00",
3901
+ * "security": "Common Stock",
3902
+ * "source_row_index": 1
3903
+ * }
3904
+ * ],
3905
+ * "remarks": null,
3906
+ * "reporting_person": {
3907
+ * "cik": "0002100523",
3908
+ * "name": "Example Reporting Person",
3909
+ * "relationships": [
3910
+ * "Officer"
3911
+ * ]
3912
+ * },
3913
+ * "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000114036126030001/0001140361-26-030001-index.htm",
3914
+ * "securities_to_be_sold": [
3915
+ * {
3916
+ * "acquired_from": "Apple Inc.",
3917
+ * "acquisition_date": "2025-01-15",
3918
+ * "acquisition_method": "Restricted stock vesting",
3919
+ * "amount": "100",
3920
+ * "donor_acquisition_date": null,
3921
+ * "is_gift": false,
3922
+ * "payment_date": null,
3923
+ * "payment_method": "Services",
3924
+ * "security": "Common Stock",
3925
+ * "source_row_index": 1
3926
+ * }
3927
+ * ]
3928
+ * }
3929
+ */
3930
+ "application/json": components["schemas"]["ProposedSaleFilingDetail"];
3931
+ };
3932
+ };
3933
+ /** @description The accession is invalid */
3934
+ 400: {
3935
+ headers: {
3936
+ [name: string]: unknown;
3937
+ };
3938
+ content: {
3939
+ "application/json": components["schemas"]["ErrorResponse"];
3940
+ };
3941
+ };
3942
+ /** @description The request is missing a valid Chadwin API key. */
3943
+ 401: {
3944
+ headers: {
3945
+ [name: string]: unknown;
3946
+ };
3947
+ content: {
3948
+ "application/json": components["schemas"]["ErrorResponse"];
3949
+ };
3950
+ };
3951
+ /** @description The subscription does not include this dataset. */
3952
+ 403: {
3953
+ headers: {
3954
+ [name: string]: unknown;
3955
+ };
3956
+ content: {
3957
+ "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
3958
+ };
3959
+ };
3960
+ /** @description The Form 144 filing was not found */
3961
+ 404: {
3962
+ headers: {
3963
+ [name: string]: unknown;
3964
+ };
3965
+ content: {
3966
+ "application/json": components["schemas"]["ErrorResponse"];
3967
+ };
3968
+ };
3969
+ /** @description The request exceeded a rate limit. */
3970
+ 429: {
3971
+ headers: {
3972
+ "RateLimit-Limit"?: string;
3973
+ "RateLimit-Reset"?: string;
3974
+ "Retry-After"?: string;
3975
+ "X-Billing-Period-Quota-Limit"?: string;
3976
+ "X-Billing-Period-Quota-Remaining"?: string;
3977
+ "X-Billing-Period-Quota-Reset"?: string;
3978
+ [name: string]: unknown;
3979
+ };
3980
+ content: {
3981
+ "application/json": components["schemas"]["ErrorResponse"];
3982
+ };
3983
+ };
3984
+ /** @description The filing storage layer is unavailable */
3985
+ 503: {
3986
+ headers: {
3987
+ [name: string]: unknown;
3988
+ };
3989
+ content: {
3990
+ "application/json": components["schemas"]["ErrorResponse"];
3991
+ };
3992
+ };
3993
+ };
3994
+ };
3995
+ }
3996
+
3997
+ type CompanyReportForm = "10-K" | "20-F" | "40-F";
3998
+ type InsiderActivityForm = "3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "144" | "144/A";
3999
+ type InsiderTransactionCode = "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
4000
+ type InstitutionalFilingForm = "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
4001
+ interface CompanyReportFeedFilters {
4002
+ forms?: CompanyReportForm[];
4003
+ limit?: number;
4004
+ }
4005
+ interface InsiderActivityFeedFilters {
4006
+ forms?: InsiderActivityForm[];
4007
+ limit?: number;
4008
+ }
4009
+ interface InsiderTransactionFeedFilters {
4010
+ transactionCodes?: InsiderTransactionCode[];
4011
+ limit?: number;
4012
+ }
4013
+ interface InstitutionalFilingFeedFilters {
4014
+ forms?: InstitutionalFilingForm[];
4015
+ limit?: number;
4016
+ }
4017
+ type ManagerHolding = components["schemas"]["InstitutionalManagerHolding"];
4018
+ type InstitutionalHolding = components["schemas"]["InstitutionalFilingHolding"] & {
4019
+ source?: ManagerHolding["source"];
4020
+ };
4021
+ type InstitutionalManager = components["schemas"]["InstitutionalManagerListItem"];
4022
+ type InstitutionalPosition = components["schemas"]["InstitutionalManagerPosition"];
4023
+
4024
+ type JsonResponse<Operation extends keyof operations> = operations[Operation] extends {
4025
+ responses: {
4026
+ 200: {
4027
+ content: {
4028
+ "application/json": infer Response;
4029
+ };
4030
+ };
4031
+ };
4032
+ } ? Response : never;
4033
+ type TextResponse<Operation extends keyof operations> = operations[Operation] extends {
4034
+ responses: {
4035
+ 200: {
4036
+ content: {
4037
+ "text/html": infer Response;
4038
+ };
4039
+ };
4040
+ };
4041
+ } ? Response : never;
4042
+
4043
+ type QueryScalar = boolean | number | string;
4044
+ type QueryValue = QueryScalar | readonly QueryScalar[] | null | undefined;
4045
+ interface TransportRequest {
4046
+ path: readonly string[];
4047
+ query?: Readonly<Record<string, QueryValue>>;
4048
+ responseType?: "json" | "text";
4049
+ }
4050
+ interface HttpTransportOptions {
4051
+ apiKey: string;
4052
+ baseURL?: string;
4053
+ fetch?: typeof fetch;
4054
+ }
4055
+ declare class HttpTransport {
4056
+ #private;
4057
+ constructor(options: HttpTransportOptions);
4058
+ request<T>(request: TransportRequest): PromiseWithResponse<T>;
4059
+ }
4060
+
4061
+ declare class Feeds {
4062
+ readonly companyReports: CompanyReportFeed;
4063
+ readonly insiderActivity: InsiderActivityFeed;
4064
+ readonly insiderTransactions: InsiderTransactionFeed;
4065
+ readonly institutionalFilings: InstitutionalFilingFeed;
4066
+ constructor(transport: HttpTransport);
4067
+ }
4068
+ declare class CompanyReportFeed {
4069
+ #private;
4070
+ private readonly transport;
4071
+ constructor(transport: HttpTransport);
4072
+ listLatest(filters?: CompanyReportFeedFilters): PromiseWithResponse<JsonResponse<"listCompanyReportFeed">>;
4073
+ listAfter({ cursor, ...filters }: CompanyReportFeedFilters & {
4074
+ cursor: string;
4075
+ }): PromiseWithResponse<JsonResponse<"listCompanyReportFeed">>;
4076
+ startFromNow(filters?: CompanyReportFeedFilters): PromiseWithResponse<JsonResponse<"listCompanyReportFeed">>;
4077
+ }
4078
+ declare class InsiderActivityFeed {
4079
+ #private;
4080
+ private readonly transport;
4081
+ constructor(transport: HttpTransport);
4082
+ listLatest(filters?: InsiderActivityFeedFilters): PromiseWithResponse<JsonResponse<"listInsiderActivityFeed">>;
4083
+ listAfter({ cursor, ...filters }: InsiderActivityFeedFilters & {
4084
+ cursor: string;
4085
+ }): PromiseWithResponse<JsonResponse<"listInsiderActivityFeed">>;
4086
+ startFromNow(filters?: InsiderActivityFeedFilters): PromiseWithResponse<JsonResponse<"listInsiderActivityFeed">>;
4087
+ }
4088
+ declare class InsiderTransactionFeed {
4089
+ #private;
4090
+ private readonly transport;
4091
+ constructor(transport: HttpTransport);
4092
+ listLatest(filters?: InsiderTransactionFeedFilters): PromiseWithResponse<JsonResponse<"listInsiderTransactionFeed">>;
4093
+ listAfter({ cursor, ...filters }: InsiderTransactionFeedFilters & {
4094
+ cursor: string;
4095
+ }): PromiseWithResponse<JsonResponse<"listInsiderTransactionFeed">>;
4096
+ startFromNow(filters?: InsiderTransactionFeedFilters): PromiseWithResponse<JsonResponse<"listInsiderTransactionFeed">>;
4097
+ }
4098
+ declare class InstitutionalFilingFeed {
4099
+ #private;
4100
+ private readonly transport;
4101
+ constructor(transport: HttpTransport);
4102
+ listLatest(filters?: InstitutionalFilingFeedFilters): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingFeed">>;
4103
+ listAfter({ cursor, ...filters }: InstitutionalFilingFeedFilters & {
4104
+ cursor: string;
4105
+ }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingFeed">>;
4106
+ startFromNow(filters?: InstitutionalFilingFeedFilters): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingFeed">>;
4107
+ }
4108
+
4109
+ declare class Companies {
4110
+ private readonly transport;
4111
+ constructor(transport: HttpTransport);
4112
+ search({ query }: {
4113
+ query: string;
4114
+ }): PromiseWithResponse<JsonResponse<"searchCompanies">>;
4115
+ get({ ticker }: {
4116
+ ticker: string;
4117
+ }): PromiseWithResponse<JsonResponse<"getCompany">>;
4118
+ }
4119
+ declare class CompanyReports {
4120
+ private readonly transport;
4121
+ constructor(transport: HttpTransport);
4122
+ get({ accessionNumber, }: {
4123
+ accessionNumber: string;
4124
+ }): PromiseWithResponse<JsonResponse<"getSecCompanyReport">>;
4125
+ getByFiscalYear({ ticker, fiscalYear, }: {
4126
+ ticker: string;
4127
+ fiscalYear: number;
4128
+ }): PromiseWithResponse<JsonResponse<"getCompanyReport">>;
4129
+ getHtml({ accessionNumber, }: {
4130
+ accessionNumber: string;
4131
+ }): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
4132
+ }
4133
+ declare class InsiderTransactions {
4134
+ private readonly transport;
4135
+ constructor(transport: HttpTransport);
4136
+ list({ filingDateFrom, filingDateUntil, tickers, transactionCodes, }: {
4137
+ filingDateFrom: string;
4138
+ filingDateUntil?: string;
4139
+ tickers?: string[];
4140
+ transactionCodes?: InsiderTransactionCode[];
4141
+ }): PromiseWithResponse<JsonResponse<"listInsiderTransactions">>;
4142
+ listForCompany({ ticker, filingDateFrom, filingDateUntil, transactionCodes, }: {
4143
+ ticker: string;
4144
+ filingDateFrom: string;
4145
+ filingDateUntil?: string;
4146
+ transactionCodes?: InsiderTransactionCode[];
4147
+ }): PromiseWithResponse<JsonResponse<"listCompanyInsiderTransactions">>;
4148
+ }
4149
+ declare class InsiderFilings {
4150
+ private readonly transport;
4151
+ constructor(transport: HttpTransport);
4152
+ get({ accessionNumber, }: {
4153
+ accessionNumber: string;
4154
+ }): PromiseWithResponse<JsonResponse<"getSecInsiderFiling">>;
4155
+ }
4156
+ declare class ProposedSales {
4157
+ private readonly transport;
4158
+ constructor(transport: HttpTransport);
4159
+ list({ filingDateFrom, filingDateUntil, tickers, }: {
4160
+ filingDateFrom: string;
4161
+ filingDateUntil?: string;
4162
+ tickers?: string[];
4163
+ }): PromiseWithResponse<JsonResponse<"listProposedSales">>;
4164
+ listForCompany({ ticker, filingDateFrom, filingDateUntil, }: {
4165
+ ticker: string;
4166
+ filingDateFrom: string;
4167
+ filingDateUntil?: string;
4168
+ }): PromiseWithResponse<JsonResponse<"listCompanyProposedSales">>;
4169
+ getFiling({ accessionNumber, }: {
4170
+ accessionNumber: string;
4171
+ }): PromiseWithResponse<JsonResponse<"getSecProposedSaleFiling">>;
4172
+ }
4173
+ declare class InstitutionalFilings {
4174
+ private readonly transport;
4175
+ constructor(transport: HttpTransport);
4176
+ get({ accessionNumber, }: {
4177
+ accessionNumber: string;
4178
+ }): PromiseWithResponse<JsonResponse<"getSecInstitutionalFiling">>;
4179
+ listHoldings({ accessionNumber, cursor, limit, }: {
4180
+ accessionNumber: string;
4181
+ cursor?: string;
4182
+ limit?: number;
4183
+ }): PromiseWithResponse<JsonResponse<"listSecInstitutionalFilingHoldings">>;
4184
+ iterateHoldings({ accessionNumber, limit, }: {
4185
+ accessionNumber: string;
4186
+ limit?: number;
4187
+ }): AsyncGenerator<InstitutionalHolding>;
4188
+ }
4189
+ declare class InstitutionalManagers {
4190
+ private readonly transport;
4191
+ constructor(transport: HttpTransport);
4192
+ list({ cik, form13fFileNumber, cursor, limit, }?: {
4193
+ cik?: string;
4194
+ form13fFileNumber?: string;
4195
+ cursor?: string;
4196
+ limit?: number;
4197
+ }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagers">>;
4198
+ get({ form13fFileNumber, }: {
4199
+ form13fFileNumber: string;
4200
+ }): PromiseWithResponse<JsonResponse<"getInstitutionalHoldingManager">>;
4201
+ listPeriods({ form13fFileNumber, }: {
4202
+ form13fFileNumber: string;
4203
+ }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerPeriods">>;
4204
+ listHoldings({ form13fFileNumber, reportPeriod, cursor, limit, }: {
4205
+ form13fFileNumber: string;
4206
+ reportPeriod: string;
4207
+ cursor?: string;
4208
+ limit?: number;
4209
+ }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerHoldings">>;
4210
+ listPositions({ form13fFileNumber, reportPeriod, cursor, limit, }: {
4211
+ form13fFileNumber: string;
4212
+ reportPeriod: string;
4213
+ cursor?: string;
4214
+ limit?: number;
4215
+ }): PromiseWithResponse<JsonResponse<"listInstitutionalHoldingManagerPositions">>;
4216
+ iterate({ cik, form13fFileNumber, limit, }?: {
4217
+ cik?: string;
4218
+ form13fFileNumber?: string;
4219
+ limit?: number;
4220
+ }): AsyncGenerator<InstitutionalManager>;
4221
+ iterateHoldings({ form13fFileNumber, reportPeriod, limit, }: {
4222
+ form13fFileNumber: string;
4223
+ reportPeriod: string;
4224
+ limit?: number;
4225
+ }): AsyncGenerator<InstitutionalHolding>;
4226
+ iteratePositions({ form13fFileNumber, reportPeriod, limit, }: {
4227
+ form13fFileNumber: string;
4228
+ reportPeriod: string;
4229
+ limit?: number;
4230
+ }): AsyncGenerator<InstitutionalPosition>;
4231
+ }
4232
+
4233
+ interface ClientOptions {
4234
+ apiKey: string;
4235
+ baseURL?: string;
4236
+ }
4237
+ declare class Chadwin {
4238
+ readonly companies: Companies;
4239
+ readonly companyReports: CompanyReports;
4240
+ readonly feeds: Feeds;
4241
+ readonly insiderFilings: InsiderFilings;
4242
+ readonly insiderTransactions: InsiderTransactions;
4243
+ readonly institutionalFilings: InstitutionalFilings;
4244
+ readonly institutionalManagers: InstitutionalManagers;
4245
+ readonly proposedSales: ProposedSales;
4246
+ constructor(options: ClientOptions);
4247
+ }
4248
+
4249
+ interface APIErrorOptions {
4250
+ status?: number;
4251
+ code?: string;
4252
+ headers?: Headers;
4253
+ }
4254
+ declare class APIError extends Error {
4255
+ readonly status: number | undefined;
4256
+ readonly code: string | undefined;
4257
+ readonly headers: Headers | undefined;
4258
+ constructor(message: string, options?: APIErrorOptions);
4259
+ }
4260
+
4261
+ export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportForm, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };