@invinite-org/invinite-data-cli 0.5.1 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/claude-plugin/skills/invinite-data-cli/SKILL.md +67 -64
- package/dist/src/commands/earnings.d.ts +2 -0
- package/dist/src/commands/earnings.js +16 -2
- package/dist/src/commands/earnings.js.map +1 -1
- package/dist/src/generated/cli-manifest.json +425 -3
- package/dist/src/spec-commands.d.ts +1 -1
- package/dist/src/spec-commands.js +3 -0
- package/dist/src/spec-commands.js.map +1 -1
- package/dist/src/spec-manifest.d.ts +50 -6
- package/dist/src/spec-manifest.js +12 -1
- package/dist/src/spec-manifest.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"specVersion": "1.0.0",
|
|
3
|
-
"specSha256": "
|
|
3
|
+
"specSha256": "073dfae86134f0e72cf41a3699c95b130bd4a05d112638af81ea14d4fb890c90",
|
|
4
4
|
"groups": [
|
|
5
5
|
{
|
|
6
6
|
"name": "company",
|
|
@@ -78,6 +78,7 @@
|
|
|
78
78
|
"in": "query",
|
|
79
79
|
"required": true,
|
|
80
80
|
"type": "string",
|
|
81
|
+
"example": "AAPL",
|
|
81
82
|
"description": "Ticker symbol or CIK",
|
|
82
83
|
"alias": "i"
|
|
83
84
|
}
|
|
@@ -137,6 +138,7 @@
|
|
|
137
138
|
"in": "query",
|
|
138
139
|
"required": true,
|
|
139
140
|
"type": "string",
|
|
141
|
+
"example": "AAPL",
|
|
140
142
|
"description": "Ticker symbol or CIK",
|
|
141
143
|
"alias": "i"
|
|
142
144
|
},
|
|
@@ -145,6 +147,7 @@
|
|
|
145
147
|
"in": "query",
|
|
146
148
|
"required": false,
|
|
147
149
|
"type": "string",
|
|
150
|
+
"example": "2025-01-01",
|
|
148
151
|
"description": "Filter dividends with ex_dividend_date on or after this date (YYYY-MM-DD)"
|
|
149
152
|
},
|
|
150
153
|
{
|
|
@@ -152,6 +155,7 @@
|
|
|
152
155
|
"in": "query",
|
|
153
156
|
"required": false,
|
|
154
157
|
"type": "string",
|
|
158
|
+
"example": "2025-12-31",
|
|
155
159
|
"description": "Filter dividends with ex_dividend_date on or before this date (YYYY-MM-DD)"
|
|
156
160
|
},
|
|
157
161
|
{
|
|
@@ -164,6 +168,7 @@
|
|
|
164
168
|
"desc"
|
|
165
169
|
],
|
|
166
170
|
"default": "desc",
|
|
171
|
+
"example": "desc",
|
|
167
172
|
"description": "Sort direction for dividends by ex_dividend_date",
|
|
168
173
|
"alias": "s"
|
|
169
174
|
},
|
|
@@ -173,6 +178,7 @@
|
|
|
173
178
|
"required": false,
|
|
174
179
|
"type": "integer",
|
|
175
180
|
"default": 40,
|
|
181
|
+
"example": 5,
|
|
176
182
|
"description": "Maximum number of dividends to return",
|
|
177
183
|
"alias": "l"
|
|
178
184
|
},
|
|
@@ -182,6 +188,7 @@
|
|
|
182
188
|
"required": false,
|
|
183
189
|
"type": "integer",
|
|
184
190
|
"default": 0,
|
|
191
|
+
"example": 0,
|
|
185
192
|
"description": "Number of dividends to skip for pagination"
|
|
186
193
|
}
|
|
187
194
|
],
|
|
@@ -215,6 +222,7 @@
|
|
|
215
222
|
"in": "query",
|
|
216
223
|
"required": true,
|
|
217
224
|
"type": "string",
|
|
225
|
+
"example": "AAPL",
|
|
218
226
|
"description": "Ticker symbol or CIK",
|
|
219
227
|
"alias": "i"
|
|
220
228
|
},
|
|
@@ -228,6 +236,7 @@
|
|
|
228
236
|
"desc"
|
|
229
237
|
],
|
|
230
238
|
"default": "desc",
|
|
239
|
+
"example": "desc",
|
|
231
240
|
"description": "Sort direction for periods by period_end",
|
|
232
241
|
"alias": "s"
|
|
233
242
|
},
|
|
@@ -237,6 +246,7 @@
|
|
|
237
246
|
"required": false,
|
|
238
247
|
"type": "integer",
|
|
239
248
|
"default": 40,
|
|
249
|
+
"example": 5,
|
|
240
250
|
"description": "Maximum number of periods per company",
|
|
241
251
|
"alias": "l"
|
|
242
252
|
},
|
|
@@ -246,6 +256,7 @@
|
|
|
246
256
|
"required": false,
|
|
247
257
|
"type": "integer",
|
|
248
258
|
"default": 0,
|
|
259
|
+
"example": 0,
|
|
249
260
|
"description": "Number of periods to skip for pagination"
|
|
250
261
|
}
|
|
251
262
|
],
|
|
@@ -295,6 +306,7 @@
|
|
|
295
306
|
"in": "query",
|
|
296
307
|
"required": true,
|
|
297
308
|
"type": "string",
|
|
309
|
+
"example": "apple",
|
|
298
310
|
"description": "Search text to match against ticker (prefix) or name (contains)",
|
|
299
311
|
"alias": "q"
|
|
300
312
|
},
|
|
@@ -304,6 +316,7 @@
|
|
|
304
316
|
"required": false,
|
|
305
317
|
"type": "integer",
|
|
306
318
|
"default": 10,
|
|
319
|
+
"example": 5,
|
|
307
320
|
"description": "Maximum number of companies to return",
|
|
308
321
|
"alias": "l"
|
|
309
322
|
},
|
|
@@ -313,6 +326,7 @@
|
|
|
313
326
|
"required": false,
|
|
314
327
|
"type": "integer",
|
|
315
328
|
"default": 0,
|
|
329
|
+
"example": 0,
|
|
316
330
|
"description": "Pagination offset"
|
|
317
331
|
}
|
|
318
332
|
],
|
|
@@ -343,6 +357,7 @@
|
|
|
343
357
|
"in": "query",
|
|
344
358
|
"required": true,
|
|
345
359
|
"type": "string",
|
|
360
|
+
"example": "AAPL",
|
|
346
361
|
"description": "Ticker symbol or CIK",
|
|
347
362
|
"alias": "i"
|
|
348
363
|
},
|
|
@@ -356,6 +371,7 @@
|
|
|
356
371
|
"desc"
|
|
357
372
|
],
|
|
358
373
|
"default": "desc",
|
|
374
|
+
"example": "desc",
|
|
359
375
|
"description": "Sort direction for splits by execution_date",
|
|
360
376
|
"alias": "s"
|
|
361
377
|
},
|
|
@@ -365,6 +381,7 @@
|
|
|
365
381
|
"required": false,
|
|
366
382
|
"type": "integer",
|
|
367
383
|
"default": 40,
|
|
384
|
+
"example": 5,
|
|
368
385
|
"description": "Maximum number of splits to return",
|
|
369
386
|
"alias": "l"
|
|
370
387
|
},
|
|
@@ -374,6 +391,7 @@
|
|
|
374
391
|
"required": false,
|
|
375
392
|
"type": "integer",
|
|
376
393
|
"default": 0,
|
|
394
|
+
"example": 0,
|
|
377
395
|
"description": "Number of splits to skip for pagination"
|
|
378
396
|
}
|
|
379
397
|
],
|
|
@@ -403,6 +421,7 @@
|
|
|
403
421
|
"in": "query",
|
|
404
422
|
"required": true,
|
|
405
423
|
"type": "string",
|
|
424
|
+
"example": "MSFT",
|
|
406
425
|
"description": "Company ticker symbol or CIK (US companies only)",
|
|
407
426
|
"alias": "i"
|
|
408
427
|
},
|
|
@@ -412,6 +431,7 @@
|
|
|
412
431
|
"required": false,
|
|
413
432
|
"type": "integer",
|
|
414
433
|
"default": 25,
|
|
434
|
+
"example": 5,
|
|
415
435
|
"description": "Maximum number of analysts to return",
|
|
416
436
|
"alias": "l"
|
|
417
437
|
},
|
|
@@ -421,6 +441,7 @@
|
|
|
421
441
|
"required": false,
|
|
422
442
|
"type": "integer",
|
|
423
443
|
"default": 0,
|
|
444
|
+
"example": 0,
|
|
424
445
|
"description": "Number of analysts to skip for pagination"
|
|
425
446
|
}
|
|
426
447
|
],
|
|
@@ -454,6 +475,7 @@
|
|
|
454
475
|
"in": "query",
|
|
455
476
|
"required": false,
|
|
456
477
|
"type": "string",
|
|
478
|
+
"example": "2026-07-01",
|
|
457
479
|
"description": "First day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: today"
|
|
458
480
|
},
|
|
459
481
|
{
|
|
@@ -461,6 +483,7 @@
|
|
|
461
483
|
"in": "query",
|
|
462
484
|
"required": false,
|
|
463
485
|
"type": "string",
|
|
486
|
+
"example": "2026-07-31",
|
|
464
487
|
"description": "Last day (YYYY-MM-DD), at most 92 days after `from`: a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: `from` + 14 days"
|
|
465
488
|
},
|
|
466
489
|
{
|
|
@@ -476,6 +499,9 @@
|
|
|
476
499
|
"postponed",
|
|
477
500
|
"cancelled"
|
|
478
501
|
],
|
|
502
|
+
"example": [
|
|
503
|
+
"confirmed"
|
|
504
|
+
],
|
|
479
505
|
"description": "Filter by date status (repeatable). Default: every status except `cancelled`"
|
|
480
506
|
},
|
|
481
507
|
{
|
|
@@ -488,6 +514,7 @@
|
|
|
488
514
|
"amc",
|
|
489
515
|
"intraday"
|
|
490
516
|
],
|
|
517
|
+
"example": "amc",
|
|
491
518
|
"description": "Filter by market session"
|
|
492
519
|
},
|
|
493
520
|
{
|
|
@@ -495,6 +522,7 @@
|
|
|
495
522
|
"in": "query",
|
|
496
523
|
"required": false,
|
|
497
524
|
"type": "string",
|
|
525
|
+
"example": "NASDAQ",
|
|
498
526
|
"description": "Filter by listing exchange (e.g. NASDAQ, NYSE)"
|
|
499
527
|
},
|
|
500
528
|
{
|
|
@@ -503,6 +531,7 @@
|
|
|
503
531
|
"required": false,
|
|
504
532
|
"type": "string",
|
|
505
533
|
"default": "earnings_call",
|
|
534
|
+
"example": "earnings_call",
|
|
506
535
|
"description": "Event types as a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` = every event type"
|
|
507
536
|
},
|
|
508
537
|
{
|
|
@@ -515,6 +544,7 @@
|
|
|
515
544
|
"desc"
|
|
516
545
|
],
|
|
517
546
|
"default": "asc",
|
|
547
|
+
"example": "desc",
|
|
518
548
|
"description": "Sort direction by scheduled start",
|
|
519
549
|
"alias": "s"
|
|
520
550
|
},
|
|
@@ -524,6 +554,7 @@
|
|
|
524
554
|
"required": false,
|
|
525
555
|
"type": "integer",
|
|
526
556
|
"default": 100,
|
|
557
|
+
"example": 5,
|
|
527
558
|
"description": "Maximum number of events to return",
|
|
528
559
|
"alias": "l"
|
|
529
560
|
},
|
|
@@ -533,6 +564,7 @@
|
|
|
533
564
|
"required": false,
|
|
534
565
|
"type": "integer",
|
|
535
566
|
"default": 0,
|
|
567
|
+
"example": 0,
|
|
536
568
|
"description": "Number of events to skip for pagination"
|
|
537
569
|
}
|
|
538
570
|
],
|
|
@@ -573,6 +605,7 @@
|
|
|
573
605
|
"in": "query",
|
|
574
606
|
"required": false,
|
|
575
607
|
"type": "string",
|
|
608
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
576
609
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
577
610
|
},
|
|
578
611
|
{
|
|
@@ -580,6 +613,7 @@
|
|
|
580
613
|
"in": "query",
|
|
581
614
|
"required": false,
|
|
582
615
|
"type": "string",
|
|
616
|
+
"example": "MSFT",
|
|
583
617
|
"description": "Company ticker symbol or CIK (US companies only); alone = the latest call with a diff, else with year+quarter or date",
|
|
584
618
|
"alias": "i"
|
|
585
619
|
},
|
|
@@ -588,6 +622,7 @@
|
|
|
588
622
|
"in": "query",
|
|
589
623
|
"required": false,
|
|
590
624
|
"type": "integer",
|
|
625
|
+
"example": 2026,
|
|
591
626
|
"description": "Fiscal year of the call (with quarter)"
|
|
592
627
|
},
|
|
593
628
|
{
|
|
@@ -595,6 +630,7 @@
|
|
|
595
630
|
"in": "query",
|
|
596
631
|
"required": false,
|
|
597
632
|
"type": "integer",
|
|
633
|
+
"example": 4,
|
|
598
634
|
"description": "Fiscal quarter of the call (with year)"
|
|
599
635
|
},
|
|
600
636
|
{
|
|
@@ -602,6 +638,7 @@
|
|
|
602
638
|
"in": "query",
|
|
603
639
|
"required": false,
|
|
604
640
|
"type": "string",
|
|
641
|
+
"example": "2026-07-29",
|
|
605
642
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
606
643
|
},
|
|
607
644
|
{
|
|
@@ -616,6 +653,7 @@
|
|
|
616
653
|
"agm",
|
|
617
654
|
"other"
|
|
618
655
|
],
|
|
656
|
+
"example": "earnings_call",
|
|
619
657
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
620
658
|
},
|
|
621
659
|
{
|
|
@@ -627,9 +665,13 @@
|
|
|
627
665
|
"prior"
|
|
628
666
|
],
|
|
629
667
|
"default": "prior",
|
|
668
|
+
"example": "prior",
|
|
630
669
|
"description": "Comparison base: the company's prior call"
|
|
631
670
|
}
|
|
632
671
|
],
|
|
672
|
+
"exampleParams": [
|
|
673
|
+
"event_id"
|
|
674
|
+
],
|
|
633
675
|
"view": "keyValue",
|
|
634
676
|
"columns": [
|
|
635
677
|
"event.symbol",
|
|
@@ -665,6 +707,7 @@
|
|
|
665
707
|
"in": "query",
|
|
666
708
|
"required": true,
|
|
667
709
|
"type": "string",
|
|
710
|
+
"example": "Azure growth",
|
|
668
711
|
"description": "The question or phrase to search for",
|
|
669
712
|
"alias": "q"
|
|
670
713
|
},
|
|
@@ -673,6 +716,7 @@
|
|
|
673
716
|
"in": "query",
|
|
674
717
|
"required": false,
|
|
675
718
|
"type": "string",
|
|
719
|
+
"example": "MSFT",
|
|
676
720
|
"description": "Search one company's documents (ticker or CIK, US only)",
|
|
677
721
|
"alias": "i"
|
|
678
722
|
},
|
|
@@ -682,6 +726,9 @@
|
|
|
682
726
|
"required": false,
|
|
683
727
|
"type": "array",
|
|
684
728
|
"items": "string",
|
|
729
|
+
"example": [
|
|
730
|
+
"annual_report"
|
|
731
|
+
],
|
|
685
732
|
"description": "Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing"
|
|
686
733
|
},
|
|
687
734
|
{
|
|
@@ -690,6 +737,9 @@
|
|
|
690
737
|
"required": false,
|
|
691
738
|
"type": "array",
|
|
692
739
|
"items": "string",
|
|
740
|
+
"example": [
|
|
741
|
+
"annual_reports"
|
|
742
|
+
],
|
|
693
743
|
"description": "Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other"
|
|
694
744
|
},
|
|
695
745
|
{
|
|
@@ -697,6 +747,7 @@
|
|
|
697
747
|
"in": "query",
|
|
698
748
|
"required": false,
|
|
699
749
|
"type": "integer",
|
|
750
|
+
"example": 2025,
|
|
700
751
|
"description": "Only documents of this year"
|
|
701
752
|
},
|
|
702
753
|
{
|
|
@@ -708,6 +759,7 @@
|
|
|
708
759
|
"event_documents",
|
|
709
760
|
"company_documents"
|
|
710
761
|
],
|
|
762
|
+
"example": "company_documents",
|
|
711
763
|
"description": "event_documents (a call's documents) or company_documents (the company's IR library)"
|
|
712
764
|
},
|
|
713
765
|
{
|
|
@@ -716,16 +768,21 @@
|
|
|
716
768
|
"required": false,
|
|
717
769
|
"type": "integer",
|
|
718
770
|
"default": 10,
|
|
771
|
+
"example": 5,
|
|
719
772
|
"description": "Maximum number of passages (at most 20)",
|
|
720
773
|
"alias": "l"
|
|
721
774
|
}
|
|
722
775
|
],
|
|
776
|
+
"exampleParams": [
|
|
777
|
+
"identifier"
|
|
778
|
+
],
|
|
723
779
|
"view": "table",
|
|
724
780
|
"rowsPath": "hits",
|
|
725
781
|
"columns": [
|
|
726
782
|
"score",
|
|
727
783
|
"kind",
|
|
728
784
|
"year",
|
|
785
|
+
"group",
|
|
729
786
|
"page",
|
|
730
787
|
"symbol",
|
|
731
788
|
"title",
|
|
@@ -752,6 +809,9 @@
|
|
|
752
809
|
"enum": [
|
|
753
810
|
"observations"
|
|
754
811
|
],
|
|
812
|
+
"example": [
|
|
813
|
+
"observations"
|
|
814
|
+
],
|
|
755
815
|
"description": "Extra data (repeatable): `observations` = the date / time observations behind the call time"
|
|
756
816
|
},
|
|
757
817
|
{
|
|
@@ -759,6 +819,7 @@
|
|
|
759
819
|
"in": "path",
|
|
760
820
|
"required": true,
|
|
761
821
|
"type": "string",
|
|
822
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
762
823
|
"description": "Event identifier (event_id of any earnings-calls response)"
|
|
763
824
|
}
|
|
764
825
|
],
|
|
@@ -803,6 +864,7 @@
|
|
|
803
864
|
"in": "query",
|
|
804
865
|
"required": true,
|
|
805
866
|
"type": "string",
|
|
867
|
+
"example": "MSFT",
|
|
806
868
|
"description": "Company ticker symbol or CIK (US companies only)",
|
|
807
869
|
"alias": "i"
|
|
808
870
|
},
|
|
@@ -811,6 +873,7 @@
|
|
|
811
873
|
"in": "query",
|
|
812
874
|
"required": false,
|
|
813
875
|
"type": "string",
|
|
876
|
+
"example": "2026-01-01",
|
|
814
877
|
"description": "Only calls on or after this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
815
878
|
},
|
|
816
879
|
{
|
|
@@ -818,6 +881,7 @@
|
|
|
818
881
|
"in": "query",
|
|
819
882
|
"required": false,
|
|
820
883
|
"type": "string",
|
|
884
|
+
"example": "2026-09-30",
|
|
821
885
|
"description": "Only calls on or before this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
822
886
|
},
|
|
823
887
|
{
|
|
@@ -829,6 +893,9 @@
|
|
|
829
893
|
"enum": [
|
|
830
894
|
"observations"
|
|
831
895
|
],
|
|
896
|
+
"example": [
|
|
897
|
+
"observations"
|
|
898
|
+
],
|
|
832
899
|
"description": "Extra data per event (repeatable): `observations` = the date / time observations"
|
|
833
900
|
},
|
|
834
901
|
{
|
|
@@ -837,6 +904,7 @@
|
|
|
837
904
|
"required": false,
|
|
838
905
|
"type": "string",
|
|
839
906
|
"default": "all",
|
|
907
|
+
"example": "earnings_call",
|
|
840
908
|
"description": "Only events of these types, a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` (default) = every event type"
|
|
841
909
|
},
|
|
842
910
|
{
|
|
@@ -849,6 +917,7 @@
|
|
|
849
917
|
"desc"
|
|
850
918
|
],
|
|
851
919
|
"default": "desc",
|
|
920
|
+
"example": "desc",
|
|
852
921
|
"description": "Sort direction by scheduled start",
|
|
853
922
|
"alias": "s"
|
|
854
923
|
},
|
|
@@ -858,6 +927,7 @@
|
|
|
858
927
|
"required": false,
|
|
859
928
|
"type": "integer",
|
|
860
929
|
"default": 50,
|
|
930
|
+
"example": 5,
|
|
861
931
|
"description": "Maximum number of events to return",
|
|
862
932
|
"alias": "l"
|
|
863
933
|
},
|
|
@@ -867,6 +937,7 @@
|
|
|
867
937
|
"required": false,
|
|
868
938
|
"type": "integer",
|
|
869
939
|
"default": 0,
|
|
940
|
+
"example": 0,
|
|
870
941
|
"description": "Number of events to skip for pagination"
|
|
871
942
|
}
|
|
872
943
|
],
|
|
@@ -907,6 +978,7 @@
|
|
|
907
978
|
"in": "query",
|
|
908
979
|
"required": false,
|
|
909
980
|
"type": "string",
|
|
981
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
910
982
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
911
983
|
},
|
|
912
984
|
{
|
|
@@ -914,6 +986,7 @@
|
|
|
914
986
|
"in": "query",
|
|
915
987
|
"required": false,
|
|
916
988
|
"type": "string",
|
|
989
|
+
"example": "MSFT",
|
|
917
990
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
918
991
|
"alias": "i"
|
|
919
992
|
},
|
|
@@ -922,6 +995,7 @@
|
|
|
922
995
|
"in": "query",
|
|
923
996
|
"required": false,
|
|
924
997
|
"type": "integer",
|
|
998
|
+
"example": 2026,
|
|
925
999
|
"description": "Fiscal year of the call (with quarter)"
|
|
926
1000
|
},
|
|
927
1001
|
{
|
|
@@ -929,6 +1003,7 @@
|
|
|
929
1003
|
"in": "query",
|
|
930
1004
|
"required": false,
|
|
931
1005
|
"type": "integer",
|
|
1006
|
+
"example": 4,
|
|
932
1007
|
"description": "Fiscal quarter of the call (with year)"
|
|
933
1008
|
},
|
|
934
1009
|
{
|
|
@@ -936,6 +1011,7 @@
|
|
|
936
1011
|
"in": "query",
|
|
937
1012
|
"required": false,
|
|
938
1013
|
"type": "string",
|
|
1014
|
+
"example": "2026-07-29",
|
|
939
1015
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
940
1016
|
},
|
|
941
1017
|
{
|
|
@@ -950,6 +1026,7 @@
|
|
|
950
1026
|
"agm",
|
|
951
1027
|
"other"
|
|
952
1028
|
],
|
|
1029
|
+
"example": "earnings_call",
|
|
953
1030
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
954
1031
|
},
|
|
955
1032
|
{
|
|
@@ -962,6 +1039,7 @@
|
|
|
962
1039
|
"kpi"
|
|
963
1040
|
],
|
|
964
1041
|
"default": "guidance",
|
|
1042
|
+
"example": "guidance",
|
|
965
1043
|
"description": "guidance = consolidated forward guidance; kpi = every reported KPI figure"
|
|
966
1044
|
},
|
|
967
1045
|
{
|
|
@@ -975,6 +1053,7 @@
|
|
|
975
1053
|
"all"
|
|
976
1054
|
],
|
|
977
1055
|
"default": "all",
|
|
1056
|
+
"example": "all",
|
|
978
1057
|
"description": "Guidance review filter: approved (human-approved only), auto, or all (auto + needs_review + approved)"
|
|
979
1058
|
},
|
|
980
1059
|
{
|
|
@@ -983,6 +1062,7 @@
|
|
|
983
1062
|
"required": false,
|
|
984
1063
|
"type": "integer",
|
|
985
1064
|
"default": 200,
|
|
1065
|
+
"example": 5,
|
|
986
1066
|
"description": "Maximum number of items to return",
|
|
987
1067
|
"alias": "l"
|
|
988
1068
|
},
|
|
@@ -992,9 +1072,13 @@
|
|
|
992
1072
|
"required": false,
|
|
993
1073
|
"type": "integer",
|
|
994
1074
|
"default": 0,
|
|
1075
|
+
"example": 0,
|
|
995
1076
|
"description": "Number of items to skip for pagination"
|
|
996
1077
|
}
|
|
997
1078
|
],
|
|
1079
|
+
"exampleParams": [
|
|
1080
|
+
"event_id"
|
|
1081
|
+
],
|
|
998
1082
|
"view": "json",
|
|
999
1083
|
"pagination": "top",
|
|
1000
1084
|
"allItemsPath": [
|
|
@@ -1016,6 +1100,7 @@
|
|
|
1016
1100
|
"in": "query",
|
|
1017
1101
|
"required": true,
|
|
1018
1102
|
"type": "string",
|
|
1103
|
+
"example": "MSFT",
|
|
1019
1104
|
"description": "Company ticker symbol or CIK (US companies only)",
|
|
1020
1105
|
"alias": "i"
|
|
1021
1106
|
},
|
|
@@ -1024,6 +1109,7 @@
|
|
|
1024
1109
|
"in": "query",
|
|
1025
1110
|
"required": true,
|
|
1026
1111
|
"type": "string",
|
|
1112
|
+
"example": "revenue",
|
|
1027
1113
|
"description": "Normalized metric (e.g. revenue, eps_non_gaap, segment:iphone)"
|
|
1028
1114
|
},
|
|
1029
1115
|
{
|
|
@@ -1037,6 +1123,7 @@
|
|
|
1037
1123
|
"half",
|
|
1038
1124
|
"other"
|
|
1039
1125
|
],
|
|
1126
|
+
"example": "quarter",
|
|
1040
1127
|
"description": "Only this kind of guided period"
|
|
1041
1128
|
},
|
|
1042
1129
|
{
|
|
@@ -1049,6 +1136,7 @@
|
|
|
1049
1136
|
"non_gaap",
|
|
1050
1137
|
"unknown"
|
|
1051
1138
|
],
|
|
1139
|
+
"example": "gaap",
|
|
1052
1140
|
"description": "Only this accounting basis"
|
|
1053
1141
|
},
|
|
1054
1142
|
{
|
|
@@ -1057,6 +1145,7 @@
|
|
|
1057
1145
|
"required": false,
|
|
1058
1146
|
"type": "integer",
|
|
1059
1147
|
"default": 12,
|
|
1148
|
+
"example": 5,
|
|
1060
1149
|
"description": "Maximum number of series entries to return",
|
|
1061
1150
|
"alias": "l"
|
|
1062
1151
|
}
|
|
@@ -1120,6 +1209,7 @@
|
|
|
1120
1209
|
"in": "query",
|
|
1121
1210
|
"required": false,
|
|
1122
1211
|
"type": "string",
|
|
1212
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1123
1213
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1124
1214
|
},
|
|
1125
1215
|
{
|
|
@@ -1127,6 +1217,7 @@
|
|
|
1127
1217
|
"in": "query",
|
|
1128
1218
|
"required": false,
|
|
1129
1219
|
"type": "string",
|
|
1220
|
+
"example": "MSFT",
|
|
1130
1221
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1131
1222
|
"alias": "i"
|
|
1132
1223
|
},
|
|
@@ -1135,6 +1226,7 @@
|
|
|
1135
1226
|
"in": "query",
|
|
1136
1227
|
"required": false,
|
|
1137
1228
|
"type": "integer",
|
|
1229
|
+
"example": 2026,
|
|
1138
1230
|
"description": "Fiscal year of the call (with quarter)"
|
|
1139
1231
|
},
|
|
1140
1232
|
{
|
|
@@ -1142,6 +1234,7 @@
|
|
|
1142
1234
|
"in": "query",
|
|
1143
1235
|
"required": false,
|
|
1144
1236
|
"type": "integer",
|
|
1237
|
+
"example": 4,
|
|
1145
1238
|
"description": "Fiscal quarter of the call (with year)"
|
|
1146
1239
|
},
|
|
1147
1240
|
{
|
|
@@ -1149,6 +1242,7 @@
|
|
|
1149
1242
|
"in": "query",
|
|
1150
1243
|
"required": false,
|
|
1151
1244
|
"type": "string",
|
|
1245
|
+
"example": "2026-07-29",
|
|
1152
1246
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1153
1247
|
},
|
|
1154
1248
|
{
|
|
@@ -1163,9 +1257,13 @@
|
|
|
1163
1257
|
"agm",
|
|
1164
1258
|
"other"
|
|
1165
1259
|
],
|
|
1260
|
+
"example": "earnings_call",
|
|
1166
1261
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1167
1262
|
}
|
|
1168
1263
|
],
|
|
1264
|
+
"exampleParams": [
|
|
1265
|
+
"event_id"
|
|
1266
|
+
],
|
|
1169
1267
|
"view": "keyValue",
|
|
1170
1268
|
"columns": [
|
|
1171
1269
|
"event.symbol",
|
|
@@ -1200,6 +1298,7 @@
|
|
|
1200
1298
|
"in": "query",
|
|
1201
1299
|
"required": false,
|
|
1202
1300
|
"type": "string",
|
|
1301
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1203
1302
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1204
1303
|
},
|
|
1205
1304
|
{
|
|
@@ -1207,6 +1306,7 @@
|
|
|
1207
1306
|
"in": "query",
|
|
1208
1307
|
"required": false,
|
|
1209
1308
|
"type": "string",
|
|
1309
|
+
"example": "MSFT",
|
|
1210
1310
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1211
1311
|
"alias": "i"
|
|
1212
1312
|
},
|
|
@@ -1215,6 +1315,7 @@
|
|
|
1215
1315
|
"in": "query",
|
|
1216
1316
|
"required": false,
|
|
1217
1317
|
"type": "integer",
|
|
1318
|
+
"example": 2026,
|
|
1218
1319
|
"description": "Fiscal year of the call (with quarter)"
|
|
1219
1320
|
},
|
|
1220
1321
|
{
|
|
@@ -1222,6 +1323,7 @@
|
|
|
1222
1323
|
"in": "query",
|
|
1223
1324
|
"required": false,
|
|
1224
1325
|
"type": "integer",
|
|
1326
|
+
"example": 4,
|
|
1225
1327
|
"description": "Fiscal quarter of the call (with year)"
|
|
1226
1328
|
},
|
|
1227
1329
|
{
|
|
@@ -1229,6 +1331,7 @@
|
|
|
1229
1331
|
"in": "query",
|
|
1230
1332
|
"required": false,
|
|
1231
1333
|
"type": "string",
|
|
1334
|
+
"example": "2026-07-29",
|
|
1232
1335
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1233
1336
|
},
|
|
1234
1337
|
{
|
|
@@ -1243,6 +1346,7 @@
|
|
|
1243
1346
|
"agm",
|
|
1244
1347
|
"other"
|
|
1245
1348
|
],
|
|
1349
|
+
"example": "earnings_call",
|
|
1246
1350
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1247
1351
|
},
|
|
1248
1352
|
{
|
|
@@ -1254,9 +1358,15 @@
|
|
|
1254
1358
|
"enum": [
|
|
1255
1359
|
"evidence"
|
|
1256
1360
|
],
|
|
1361
|
+
"example": [
|
|
1362
|
+
"evidence"
|
|
1363
|
+
],
|
|
1257
1364
|
"description": "Extra data (repeatable): `evidence` = the quotes each name was resolved from"
|
|
1258
1365
|
}
|
|
1259
1366
|
],
|
|
1367
|
+
"exampleParams": [
|
|
1368
|
+
"event_id"
|
|
1369
|
+
],
|
|
1260
1370
|
"view": "table",
|
|
1261
1371
|
"rowsPath": "participants",
|
|
1262
1372
|
"columns": [
|
|
@@ -1286,6 +1396,7 @@
|
|
|
1286
1396
|
"required": false,
|
|
1287
1397
|
"type": "integer",
|
|
1288
1398
|
"default": 50,
|
|
1399
|
+
"example": 5,
|
|
1289
1400
|
"description": "Maximum number of appearances to return",
|
|
1290
1401
|
"alias": "l"
|
|
1291
1402
|
},
|
|
@@ -1295,6 +1406,7 @@
|
|
|
1295
1406
|
"required": false,
|
|
1296
1407
|
"type": "integer",
|
|
1297
1408
|
"default": 0,
|
|
1409
|
+
"example": 0,
|
|
1298
1410
|
"description": "Number of appearances to skip for pagination"
|
|
1299
1411
|
},
|
|
1300
1412
|
{
|
|
@@ -1302,6 +1414,7 @@
|
|
|
1302
1414
|
"in": "path",
|
|
1303
1415
|
"required": true,
|
|
1304
1416
|
"type": "string",
|
|
1417
|
+
"example": "9b135e05-d7c2-4d23-9c89-728501ad8e58",
|
|
1305
1418
|
"description": "Person identifier (person_id of participants / qa / analysts)"
|
|
1306
1419
|
}
|
|
1307
1420
|
],
|
|
@@ -1339,6 +1452,7 @@
|
|
|
1339
1452
|
"in": "query",
|
|
1340
1453
|
"required": false,
|
|
1341
1454
|
"type": "string",
|
|
1455
|
+
"example": "dd04abe1-f83f-4e92-8ddf-1f8864e7db30",
|
|
1342
1456
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1343
1457
|
},
|
|
1344
1458
|
{
|
|
@@ -1346,6 +1460,7 @@
|
|
|
1346
1460
|
"in": "query",
|
|
1347
1461
|
"required": false,
|
|
1348
1462
|
"type": "string",
|
|
1463
|
+
"example": "JPM",
|
|
1349
1464
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1350
1465
|
"alias": "i"
|
|
1351
1466
|
},
|
|
@@ -1354,6 +1469,7 @@
|
|
|
1354
1469
|
"in": "query",
|
|
1355
1470
|
"required": false,
|
|
1356
1471
|
"type": "integer",
|
|
1472
|
+
"example": 2026,
|
|
1357
1473
|
"description": "Fiscal year of the call (with quarter)"
|
|
1358
1474
|
},
|
|
1359
1475
|
{
|
|
@@ -1361,6 +1477,7 @@
|
|
|
1361
1477
|
"in": "query",
|
|
1362
1478
|
"required": false,
|
|
1363
1479
|
"type": "integer",
|
|
1480
|
+
"example": 3,
|
|
1364
1481
|
"description": "Fiscal quarter of the call (with year)"
|
|
1365
1482
|
},
|
|
1366
1483
|
{
|
|
@@ -1368,6 +1485,7 @@
|
|
|
1368
1485
|
"in": "query",
|
|
1369
1486
|
"required": false,
|
|
1370
1487
|
"type": "string",
|
|
1488
|
+
"example": "2026-10-13",
|
|
1371
1489
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1372
1490
|
},
|
|
1373
1491
|
{
|
|
@@ -1382,9 +1500,13 @@
|
|
|
1382
1500
|
"agm",
|
|
1383
1501
|
"other"
|
|
1384
1502
|
],
|
|
1503
|
+
"example": "earnings_call",
|
|
1385
1504
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1386
1505
|
}
|
|
1387
1506
|
],
|
|
1507
|
+
"exampleParams": [
|
|
1508
|
+
"event_id"
|
|
1509
|
+
],
|
|
1388
1510
|
"view": "json",
|
|
1389
1511
|
"pagination": "none"
|
|
1390
1512
|
},
|
|
@@ -1402,6 +1524,7 @@
|
|
|
1402
1524
|
"in": "query",
|
|
1403
1525
|
"required": false,
|
|
1404
1526
|
"type": "string",
|
|
1527
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1405
1528
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1406
1529
|
},
|
|
1407
1530
|
{
|
|
@@ -1409,6 +1532,7 @@
|
|
|
1409
1532
|
"in": "query",
|
|
1410
1533
|
"required": false,
|
|
1411
1534
|
"type": "string",
|
|
1535
|
+
"example": "MSFT",
|
|
1412
1536
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1413
1537
|
"alias": "i"
|
|
1414
1538
|
},
|
|
@@ -1417,6 +1541,7 @@
|
|
|
1417
1541
|
"in": "query",
|
|
1418
1542
|
"required": false,
|
|
1419
1543
|
"type": "integer",
|
|
1544
|
+
"example": 2026,
|
|
1420
1545
|
"description": "Fiscal year of the call (with quarter)"
|
|
1421
1546
|
},
|
|
1422
1547
|
{
|
|
@@ -1424,6 +1549,7 @@
|
|
|
1424
1549
|
"in": "query",
|
|
1425
1550
|
"required": false,
|
|
1426
1551
|
"type": "integer",
|
|
1552
|
+
"example": 4,
|
|
1427
1553
|
"description": "Fiscal quarter of the call (with year)"
|
|
1428
1554
|
},
|
|
1429
1555
|
{
|
|
@@ -1431,6 +1557,7 @@
|
|
|
1431
1557
|
"in": "query",
|
|
1432
1558
|
"required": false,
|
|
1433
1559
|
"type": "string",
|
|
1560
|
+
"example": "2026-07-29",
|
|
1434
1561
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1435
1562
|
},
|
|
1436
1563
|
{
|
|
@@ -1445,6 +1572,7 @@
|
|
|
1445
1572
|
"agm",
|
|
1446
1573
|
"other"
|
|
1447
1574
|
],
|
|
1575
|
+
"example": "earnings_call",
|
|
1448
1576
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1449
1577
|
},
|
|
1450
1578
|
{
|
|
@@ -1458,9 +1586,13 @@
|
|
|
1458
1586
|
"all"
|
|
1459
1587
|
],
|
|
1460
1588
|
"default": "all",
|
|
1589
|
+
"example": "qa",
|
|
1461
1590
|
"description": "prepared (remarks), qa, or all (the whole call)"
|
|
1462
1591
|
}
|
|
1463
1592
|
],
|
|
1593
|
+
"exampleParams": [
|
|
1594
|
+
"event_id"
|
|
1595
|
+
],
|
|
1464
1596
|
"view": "table",
|
|
1465
1597
|
"rowsPath": "speakers",
|
|
1466
1598
|
"columns": [
|
|
@@ -1494,6 +1626,7 @@
|
|
|
1494
1626
|
"in": "query",
|
|
1495
1627
|
"required": false,
|
|
1496
1628
|
"type": "string",
|
|
1629
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1497
1630
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1498
1631
|
},
|
|
1499
1632
|
{
|
|
@@ -1501,6 +1634,7 @@
|
|
|
1501
1634
|
"in": "query",
|
|
1502
1635
|
"required": false,
|
|
1503
1636
|
"type": "string",
|
|
1637
|
+
"example": "MSFT",
|
|
1504
1638
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1505
1639
|
"alias": "i"
|
|
1506
1640
|
},
|
|
@@ -1509,6 +1643,7 @@
|
|
|
1509
1643
|
"in": "query",
|
|
1510
1644
|
"required": false,
|
|
1511
1645
|
"type": "integer",
|
|
1646
|
+
"example": 2026,
|
|
1512
1647
|
"description": "Fiscal year of the call (with quarter)"
|
|
1513
1648
|
},
|
|
1514
1649
|
{
|
|
@@ -1516,6 +1651,7 @@
|
|
|
1516
1651
|
"in": "query",
|
|
1517
1652
|
"required": false,
|
|
1518
1653
|
"type": "integer",
|
|
1654
|
+
"example": 4,
|
|
1519
1655
|
"description": "Fiscal quarter of the call (with year)"
|
|
1520
1656
|
},
|
|
1521
1657
|
{
|
|
@@ -1523,6 +1659,7 @@
|
|
|
1523
1659
|
"in": "query",
|
|
1524
1660
|
"required": false,
|
|
1525
1661
|
"type": "string",
|
|
1662
|
+
"example": "2026-07-29",
|
|
1526
1663
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1527
1664
|
},
|
|
1528
1665
|
{
|
|
@@ -1537,6 +1674,7 @@
|
|
|
1537
1674
|
"agm",
|
|
1538
1675
|
"other"
|
|
1539
1676
|
],
|
|
1677
|
+
"example": "earnings_call",
|
|
1540
1678
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1541
1679
|
},
|
|
1542
1680
|
{
|
|
@@ -1545,6 +1683,7 @@
|
|
|
1545
1683
|
"required": false,
|
|
1546
1684
|
"type": "integer",
|
|
1547
1685
|
"default": 50,
|
|
1686
|
+
"example": 5,
|
|
1548
1687
|
"description": "Maximum number of Q&A pairs to return",
|
|
1549
1688
|
"alias": "l"
|
|
1550
1689
|
},
|
|
@@ -1554,6 +1693,7 @@
|
|
|
1554
1693
|
"required": false,
|
|
1555
1694
|
"type": "integer",
|
|
1556
1695
|
"default": 0,
|
|
1696
|
+
"example": 0,
|
|
1557
1697
|
"description": "Number of Q&A pairs to skip for pagination"
|
|
1558
1698
|
},
|
|
1559
1699
|
{
|
|
@@ -1564,9 +1704,13 @@
|
|
|
1564
1704
|
"enum": [
|
|
1565
1705
|
"scores"
|
|
1566
1706
|
],
|
|
1707
|
+
"example": "scores",
|
|
1567
1708
|
"description": "scores = add each pair's descriptive scores (analyst casting order, question tone, difficulty, evasiveness, non-answer flag with verbatim evidence); null for a pair not scored yet"
|
|
1568
1709
|
}
|
|
1569
1710
|
],
|
|
1711
|
+
"exampleParams": [
|
|
1712
|
+
"event_id"
|
|
1713
|
+
],
|
|
1570
1714
|
"view": "table",
|
|
1571
1715
|
"rowsPath": "pairs",
|
|
1572
1716
|
"columns": [
|
|
@@ -1597,6 +1741,7 @@
|
|
|
1597
1741
|
"in": "query",
|
|
1598
1742
|
"required": true,
|
|
1599
1743
|
"type": "string",
|
|
1744
|
+
"example": "Azure growth",
|
|
1600
1745
|
"description": "The question or phrase to search for",
|
|
1601
1746
|
"alias": "q"
|
|
1602
1747
|
},
|
|
@@ -1605,6 +1750,7 @@
|
|
|
1605
1750
|
"in": "query",
|
|
1606
1751
|
"required": false,
|
|
1607
1752
|
"type": "string",
|
|
1753
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1608
1754
|
"description": "Search one call"
|
|
1609
1755
|
},
|
|
1610
1756
|
{
|
|
@@ -1612,6 +1758,7 @@
|
|
|
1612
1758
|
"in": "query",
|
|
1613
1759
|
"required": false,
|
|
1614
1760
|
"type": "string",
|
|
1761
|
+
"example": "MSFT",
|
|
1615
1762
|
"description": "Search one company's calls (ticker or CIK, US only)",
|
|
1616
1763
|
"alias": "i"
|
|
1617
1764
|
},
|
|
@@ -1620,6 +1767,7 @@
|
|
|
1620
1767
|
"in": "query",
|
|
1621
1768
|
"required": false,
|
|
1622
1769
|
"type": "string",
|
|
1770
|
+
"example": "2026-07-01",
|
|
1623
1771
|
"description": "First call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. An unscoped search defaults to 365 days back"
|
|
1624
1772
|
},
|
|
1625
1773
|
{
|
|
@@ -1627,6 +1775,7 @@
|
|
|
1627
1775
|
"in": "query",
|
|
1628
1776
|
"required": false,
|
|
1629
1777
|
"type": "string",
|
|
1778
|
+
"example": "2026-07-31",
|
|
1630
1779
|
"description": "Last call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1631
1780
|
},
|
|
1632
1781
|
{
|
|
@@ -1640,6 +1789,7 @@
|
|
|
1640
1789
|
"preparedRemarks",
|
|
1641
1790
|
"presentation"
|
|
1642
1791
|
],
|
|
1792
|
+
"example": "qa",
|
|
1643
1793
|
"description": "transcript (all speech), qa, preparedRemarks or presentation (slide text)"
|
|
1644
1794
|
},
|
|
1645
1795
|
{
|
|
@@ -1648,6 +1798,7 @@
|
|
|
1648
1798
|
"required": false,
|
|
1649
1799
|
"type": "string",
|
|
1650
1800
|
"default": "earnings_call",
|
|
1801
|
+
"example": "earnings_call",
|
|
1651
1802
|
"description": "Events searched, as a comma list of earnings_call, investor_day, conference, agm, other; `all` = every event type (default earnings calls)"
|
|
1652
1803
|
},
|
|
1653
1804
|
{
|
|
@@ -1656,10 +1807,14 @@
|
|
|
1656
1807
|
"required": false,
|
|
1657
1808
|
"type": "integer",
|
|
1658
1809
|
"default": 5,
|
|
1810
|
+
"example": 5,
|
|
1659
1811
|
"description": "Maximum number of passages (at most 8)",
|
|
1660
1812
|
"alias": "l"
|
|
1661
1813
|
}
|
|
1662
1814
|
],
|
|
1815
|
+
"exampleParams": [
|
|
1816
|
+
"identifier"
|
|
1817
|
+
],
|
|
1663
1818
|
"view": "table",
|
|
1664
1819
|
"rowsPath": "hits",
|
|
1665
1820
|
"columns": [
|
|
@@ -1688,6 +1843,7 @@
|
|
|
1688
1843
|
"in": "query",
|
|
1689
1844
|
"required": false,
|
|
1690
1845
|
"type": "string",
|
|
1846
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1691
1847
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1692
1848
|
},
|
|
1693
1849
|
{
|
|
@@ -1695,6 +1851,7 @@
|
|
|
1695
1851
|
"in": "query",
|
|
1696
1852
|
"required": false,
|
|
1697
1853
|
"type": "string",
|
|
1854
|
+
"example": "MSFT",
|
|
1698
1855
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1699
1856
|
"alias": "i"
|
|
1700
1857
|
},
|
|
@@ -1703,6 +1860,7 @@
|
|
|
1703
1860
|
"in": "query",
|
|
1704
1861
|
"required": false,
|
|
1705
1862
|
"type": "integer",
|
|
1863
|
+
"example": 2026,
|
|
1706
1864
|
"description": "Fiscal year of the call (with quarter)"
|
|
1707
1865
|
},
|
|
1708
1866
|
{
|
|
@@ -1710,6 +1868,7 @@
|
|
|
1710
1868
|
"in": "query",
|
|
1711
1869
|
"required": false,
|
|
1712
1870
|
"type": "integer",
|
|
1871
|
+
"example": 4,
|
|
1713
1872
|
"description": "Fiscal quarter of the call (with year)"
|
|
1714
1873
|
},
|
|
1715
1874
|
{
|
|
@@ -1717,6 +1876,7 @@
|
|
|
1717
1876
|
"in": "query",
|
|
1718
1877
|
"required": false,
|
|
1719
1878
|
"type": "string",
|
|
1879
|
+
"example": "2026-07-29",
|
|
1720
1880
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1721
1881
|
},
|
|
1722
1882
|
{
|
|
@@ -1731,9 +1891,13 @@
|
|
|
1731
1891
|
"agm",
|
|
1732
1892
|
"other"
|
|
1733
1893
|
],
|
|
1894
|
+
"example": "earnings_call",
|
|
1734
1895
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1735
1896
|
}
|
|
1736
1897
|
],
|
|
1898
|
+
"exampleParams": [
|
|
1899
|
+
"event_id"
|
|
1900
|
+
],
|
|
1737
1901
|
"view": "keyValue",
|
|
1738
1902
|
"columns": [
|
|
1739
1903
|
"event.symbol",
|
|
@@ -1761,6 +1925,7 @@
|
|
|
1761
1925
|
"in": "query",
|
|
1762
1926
|
"required": false,
|
|
1763
1927
|
"type": "string",
|
|
1928
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1764
1929
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1765
1930
|
},
|
|
1766
1931
|
{
|
|
@@ -1768,6 +1933,7 @@
|
|
|
1768
1933
|
"in": "query",
|
|
1769
1934
|
"required": false,
|
|
1770
1935
|
"type": "string",
|
|
1936
|
+
"example": "MSFT",
|
|
1771
1937
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1772
1938
|
"alias": "i"
|
|
1773
1939
|
},
|
|
@@ -1776,6 +1942,7 @@
|
|
|
1776
1942
|
"in": "query",
|
|
1777
1943
|
"required": false,
|
|
1778
1944
|
"type": "integer",
|
|
1945
|
+
"example": 2026,
|
|
1779
1946
|
"description": "Fiscal year of the call (with quarter)"
|
|
1780
1947
|
},
|
|
1781
1948
|
{
|
|
@@ -1783,6 +1950,7 @@
|
|
|
1783
1950
|
"in": "query",
|
|
1784
1951
|
"required": false,
|
|
1785
1952
|
"type": "integer",
|
|
1953
|
+
"example": 4,
|
|
1786
1954
|
"description": "Fiscal quarter of the call (with year)"
|
|
1787
1955
|
},
|
|
1788
1956
|
{
|
|
@@ -1790,6 +1958,7 @@
|
|
|
1790
1958
|
"in": "query",
|
|
1791
1959
|
"required": false,
|
|
1792
1960
|
"type": "string",
|
|
1961
|
+
"example": "2026-07-29",
|
|
1793
1962
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1794
1963
|
},
|
|
1795
1964
|
{
|
|
@@ -1804,6 +1973,7 @@
|
|
|
1804
1973
|
"agm",
|
|
1805
1974
|
"other"
|
|
1806
1975
|
],
|
|
1976
|
+
"example": "earnings_call",
|
|
1807
1977
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1808
1978
|
},
|
|
1809
1979
|
{
|
|
@@ -1811,6 +1981,7 @@
|
|
|
1811
1981
|
"in": "query",
|
|
1812
1982
|
"required": true,
|
|
1813
1983
|
"type": "integer",
|
|
1984
|
+
"example": 3,
|
|
1814
1985
|
"description": "Older version (one listed by transcript/versions)"
|
|
1815
1986
|
},
|
|
1816
1987
|
{
|
|
@@ -1818,9 +1989,13 @@
|
|
|
1818
1989
|
"in": "query",
|
|
1819
1990
|
"required": false,
|
|
1820
1991
|
"type": "integer",
|
|
1992
|
+
"example": 6,
|
|
1821
1993
|
"description": "Newer version; default = the current one"
|
|
1822
1994
|
}
|
|
1823
1995
|
],
|
|
1996
|
+
"exampleParams": [
|
|
1997
|
+
"event_id"
|
|
1998
|
+
],
|
|
1824
1999
|
"view": "table",
|
|
1825
2000
|
"rowsPath": "changes",
|
|
1826
2001
|
"columns": [
|
|
@@ -1844,6 +2019,7 @@
|
|
|
1844
2019
|
"in": "query",
|
|
1845
2020
|
"required": false,
|
|
1846
2021
|
"type": "string",
|
|
2022
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1847
2023
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1848
2024
|
},
|
|
1849
2025
|
{
|
|
@@ -1851,6 +2027,7 @@
|
|
|
1851
2027
|
"in": "query",
|
|
1852
2028
|
"required": false,
|
|
1853
2029
|
"type": "string",
|
|
2030
|
+
"example": "MSFT",
|
|
1854
2031
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1855
2032
|
"alias": "i"
|
|
1856
2033
|
},
|
|
@@ -1859,6 +2036,7 @@
|
|
|
1859
2036
|
"in": "query",
|
|
1860
2037
|
"required": false,
|
|
1861
2038
|
"type": "integer",
|
|
2039
|
+
"example": 2026,
|
|
1862
2040
|
"description": "Fiscal year of the call (with quarter)"
|
|
1863
2041
|
},
|
|
1864
2042
|
{
|
|
@@ -1866,6 +2044,7 @@
|
|
|
1866
2044
|
"in": "query",
|
|
1867
2045
|
"required": false,
|
|
1868
2046
|
"type": "integer",
|
|
2047
|
+
"example": 4,
|
|
1869
2048
|
"description": "Fiscal quarter of the call (with year)"
|
|
1870
2049
|
},
|
|
1871
2050
|
{
|
|
@@ -1873,6 +2052,7 @@
|
|
|
1873
2052
|
"in": "query",
|
|
1874
2053
|
"required": false,
|
|
1875
2054
|
"type": "string",
|
|
2055
|
+
"example": "2026-07-29",
|
|
1876
2056
|
"description": "Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date"
|
|
1877
2057
|
},
|
|
1878
2058
|
{
|
|
@@ -1887,9 +2067,13 @@
|
|
|
1887
2067
|
"agm",
|
|
1888
2068
|
"other"
|
|
1889
2069
|
],
|
|
2070
|
+
"example": "earnings_call",
|
|
1890
2071
|
"description": "Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only"
|
|
1891
2072
|
}
|
|
1892
2073
|
],
|
|
2074
|
+
"exampleParams": [
|
|
2075
|
+
"event_id"
|
|
2076
|
+
],
|
|
1893
2077
|
"view": "table",
|
|
1894
2078
|
"rowsPath": "versions",
|
|
1895
2079
|
"columns": [
|
|
@@ -1916,6 +2100,7 @@
|
|
|
1916
2100
|
"in": "query",
|
|
1917
2101
|
"required": false,
|
|
1918
2102
|
"type": "string",
|
|
2103
|
+
"example": "AAPL",
|
|
1919
2104
|
"description": "Optional ticker symbol or CIK. If omitted, returns form types across all filings.",
|
|
1920
2105
|
"alias": "i"
|
|
1921
2106
|
}
|
|
@@ -1937,6 +2122,7 @@
|
|
|
1937
2122
|
"in": "query",
|
|
1938
2123
|
"required": true,
|
|
1939
2124
|
"type": "string",
|
|
2125
|
+
"example": "AAPL",
|
|
1940
2126
|
"description": "Ticker symbol or CIK",
|
|
1941
2127
|
"alias": "i"
|
|
1942
2128
|
},
|
|
@@ -1945,6 +2131,7 @@
|
|
|
1945
2131
|
"in": "query",
|
|
1946
2132
|
"required": false,
|
|
1947
2133
|
"type": "string",
|
|
2134
|
+
"example": "10-K",
|
|
1948
2135
|
"description": "SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types."
|
|
1949
2136
|
},
|
|
1950
2137
|
{
|
|
@@ -1957,6 +2144,7 @@
|
|
|
1957
2144
|
"desc"
|
|
1958
2145
|
],
|
|
1959
2146
|
"default": "desc",
|
|
2147
|
+
"example": "desc",
|
|
1960
2148
|
"description": "Sort direction for filings by filing_date",
|
|
1961
2149
|
"alias": "s"
|
|
1962
2150
|
},
|
|
@@ -1966,6 +2154,7 @@
|
|
|
1966
2154
|
"required": false,
|
|
1967
2155
|
"type": "integer",
|
|
1968
2156
|
"default": 40,
|
|
2157
|
+
"example": 5,
|
|
1969
2158
|
"description": "Maximum number of filings to return",
|
|
1970
2159
|
"alias": "l"
|
|
1971
2160
|
},
|
|
@@ -1975,6 +2164,7 @@
|
|
|
1975
2164
|
"required": false,
|
|
1976
2165
|
"type": "integer",
|
|
1977
2166
|
"default": 0,
|
|
2167
|
+
"example": 0,
|
|
1978
2168
|
"description": "Number of filings to skip for pagination"
|
|
1979
2169
|
}
|
|
1980
2170
|
],
|
|
@@ -2010,6 +2200,7 @@
|
|
|
2010
2200
|
"in": "query",
|
|
2011
2201
|
"required": true,
|
|
2012
2202
|
"type": "string",
|
|
2203
|
+
"example": "What are Apple's main risk factors?",
|
|
2013
2204
|
"description": "Natural language search request for SEC filing information (e.g., 'What are Apple's main risk factors?')",
|
|
2014
2205
|
"alias": "r"
|
|
2015
2206
|
},
|
|
@@ -2018,6 +2209,7 @@
|
|
|
2018
2209
|
"in": "query",
|
|
2019
2210
|
"required": false,
|
|
2020
2211
|
"type": "string",
|
|
2212
|
+
"example": "AAPL",
|
|
2021
2213
|
"description": "Ticker symbol or CIK to filter search results to a specific company",
|
|
2022
2214
|
"alias": "i"
|
|
2023
2215
|
},
|
|
@@ -2026,9 +2218,13 @@
|
|
|
2026
2218
|
"in": "query",
|
|
2027
2219
|
"required": false,
|
|
2028
2220
|
"type": "string",
|
|
2221
|
+
"example": "0000320193-25-000079",
|
|
2029
2222
|
"description": "Accession number to filter search results to a specific filing"
|
|
2030
2223
|
}
|
|
2031
2224
|
],
|
|
2225
|
+
"exampleParams": [
|
|
2226
|
+
"identifier"
|
|
2227
|
+
],
|
|
2032
2228
|
"view": "json",
|
|
2033
2229
|
"pagination": "none"
|
|
2034
2230
|
},
|
|
@@ -2046,6 +2242,7 @@
|
|
|
2046
2242
|
"in": "query",
|
|
2047
2243
|
"required": true,
|
|
2048
2244
|
"type": "string",
|
|
2245
|
+
"example": "AAPL",
|
|
2049
2246
|
"description": "Ticker symbol or CIK",
|
|
2050
2247
|
"alias": "i"
|
|
2051
2248
|
},
|
|
@@ -2059,6 +2256,7 @@
|
|
|
2059
2256
|
"10-K",
|
|
2060
2257
|
"8-K"
|
|
2061
2258
|
],
|
|
2259
|
+
"example": "10-K",
|
|
2062
2260
|
"description": "SEC form type. Filter requirements vary: 8-K requires accession_number; 10-K requires accession_number or fiscal_year; 10-Q requires accession_number or fiscal_year+fiscal_quarter."
|
|
2063
2261
|
},
|
|
2064
2262
|
{
|
|
@@ -2066,6 +2264,7 @@
|
|
|
2066
2264
|
"in": "query",
|
|
2067
2265
|
"required": false,
|
|
2068
2266
|
"type": "string",
|
|
2267
|
+
"example": "part_i-item_1a",
|
|
2069
2268
|
"description": "Optional section ID. If not specified, all sections from the filing are returned."
|
|
2070
2269
|
},
|
|
2071
2270
|
{
|
|
@@ -2073,6 +2272,7 @@
|
|
|
2073
2272
|
"in": "query",
|
|
2074
2273
|
"required": false,
|
|
2075
2274
|
"type": "string",
|
|
2275
|
+
"example": "0000320193-25-000079",
|
|
2076
2276
|
"description": "SEC accession number of the filing"
|
|
2077
2277
|
},
|
|
2078
2278
|
{
|
|
@@ -2080,6 +2280,7 @@
|
|
|
2080
2280
|
"in": "query",
|
|
2081
2281
|
"required": false,
|
|
2082
2282
|
"type": "integer",
|
|
2283
|
+
"example": 2025,
|
|
2083
2284
|
"description": "Fiscal year"
|
|
2084
2285
|
},
|
|
2085
2286
|
{
|
|
@@ -2087,9 +2288,13 @@
|
|
|
2087
2288
|
"in": "query",
|
|
2088
2289
|
"required": false,
|
|
2089
2290
|
"type": "integer",
|
|
2291
|
+
"example": 4,
|
|
2090
2292
|
"description": "Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter."
|
|
2091
2293
|
}
|
|
2092
2294
|
],
|
|
2295
|
+
"exampleParams": [
|
|
2296
|
+
"fiscal_year"
|
|
2297
|
+
],
|
|
2093
2298
|
"view": "json",
|
|
2094
2299
|
"pagination": "none"
|
|
2095
2300
|
},
|
|
@@ -2107,6 +2312,7 @@
|
|
|
2107
2312
|
"in": "query",
|
|
2108
2313
|
"required": true,
|
|
2109
2314
|
"type": "string",
|
|
2315
|
+
"example": "AAPL",
|
|
2110
2316
|
"description": "Ticker symbol or CIK",
|
|
2111
2317
|
"alias": "i"
|
|
2112
2318
|
},
|
|
@@ -2121,6 +2327,7 @@
|
|
|
2121
2327
|
"ytd",
|
|
2122
2328
|
"ttm"
|
|
2123
2329
|
],
|
|
2330
|
+
"example": "annual",
|
|
2124
2331
|
"description": "Type of fiscal period",
|
|
2125
2332
|
"alias": "p"
|
|
2126
2333
|
},
|
|
@@ -2134,6 +2341,7 @@
|
|
|
2134
2341
|
"desc"
|
|
2135
2342
|
],
|
|
2136
2343
|
"default": "desc",
|
|
2344
|
+
"example": "desc",
|
|
2137
2345
|
"description": "Sort direction for periods by period_end",
|
|
2138
2346
|
"alias": "s"
|
|
2139
2347
|
},
|
|
@@ -2143,6 +2351,7 @@
|
|
|
2143
2351
|
"required": false,
|
|
2144
2352
|
"type": "integer",
|
|
2145
2353
|
"default": 10,
|
|
2354
|
+
"example": 5,
|
|
2146
2355
|
"description": "Maximum number of periods per ticker",
|
|
2147
2356
|
"alias": "l"
|
|
2148
2357
|
},
|
|
@@ -2152,6 +2361,7 @@
|
|
|
2152
2361
|
"required": false,
|
|
2153
2362
|
"type": "integer",
|
|
2154
2363
|
"default": 0,
|
|
2364
|
+
"example": 0,
|
|
2155
2365
|
"description": "Number of periods to skip for pagination"
|
|
2156
2366
|
}
|
|
2157
2367
|
],
|
|
@@ -2175,6 +2385,7 @@
|
|
|
2175
2385
|
"in": "query",
|
|
2176
2386
|
"required": true,
|
|
2177
2387
|
"type": "string",
|
|
2388
|
+
"example": "AAPL",
|
|
2178
2389
|
"description": "Ticker symbol or CIK",
|
|
2179
2390
|
"alias": "i"
|
|
2180
2391
|
},
|
|
@@ -2189,6 +2400,7 @@
|
|
|
2189
2400
|
"ytd",
|
|
2190
2401
|
"ttm"
|
|
2191
2402
|
],
|
|
2403
|
+
"example": "annual",
|
|
2192
2404
|
"description": "Type of fiscal period",
|
|
2193
2405
|
"alias": "p"
|
|
2194
2406
|
},
|
|
@@ -2202,6 +2414,7 @@
|
|
|
2202
2414
|
"desc"
|
|
2203
2415
|
],
|
|
2204
2416
|
"default": "desc",
|
|
2417
|
+
"example": "desc",
|
|
2205
2418
|
"description": "Sort direction for periods by period_end",
|
|
2206
2419
|
"alias": "s"
|
|
2207
2420
|
},
|
|
@@ -2211,6 +2424,7 @@
|
|
|
2211
2424
|
"required": false,
|
|
2212
2425
|
"type": "integer",
|
|
2213
2426
|
"default": 10,
|
|
2427
|
+
"example": 5,
|
|
2214
2428
|
"description": "Maximum number of periods per ticker",
|
|
2215
2429
|
"alias": "l"
|
|
2216
2430
|
},
|
|
@@ -2220,6 +2434,7 @@
|
|
|
2220
2434
|
"required": false,
|
|
2221
2435
|
"type": "integer",
|
|
2222
2436
|
"default": 0,
|
|
2437
|
+
"example": 0,
|
|
2223
2438
|
"description": "Number of periods to skip for pagination"
|
|
2224
2439
|
},
|
|
2225
2440
|
{
|
|
@@ -2232,6 +2447,7 @@
|
|
|
2232
2447
|
"false"
|
|
2233
2448
|
],
|
|
2234
2449
|
"default": "false",
|
|
2450
|
+
"example": "true",
|
|
2235
2451
|
"description": "Include formula in response"
|
|
2236
2452
|
}
|
|
2237
2453
|
],
|
|
@@ -2255,6 +2471,7 @@
|
|
|
2255
2471
|
"in": "query",
|
|
2256
2472
|
"required": true,
|
|
2257
2473
|
"type": "string",
|
|
2474
|
+
"example": "AAPL",
|
|
2258
2475
|
"description": "Ticker symbol or CIK",
|
|
2259
2476
|
"alias": "i"
|
|
2260
2477
|
},
|
|
@@ -2269,6 +2486,7 @@
|
|
|
2269
2486
|
"ytd",
|
|
2270
2487
|
"ttm"
|
|
2271
2488
|
],
|
|
2489
|
+
"example": "annual",
|
|
2272
2490
|
"description": "Type of fiscal period",
|
|
2273
2491
|
"alias": "p"
|
|
2274
2492
|
},
|
|
@@ -2282,6 +2500,7 @@
|
|
|
2282
2500
|
"desc"
|
|
2283
2501
|
],
|
|
2284
2502
|
"default": "desc",
|
|
2503
|
+
"example": "desc",
|
|
2285
2504
|
"description": "Sort direction for periods by period_end",
|
|
2286
2505
|
"alias": "s"
|
|
2287
2506
|
},
|
|
@@ -2291,6 +2510,7 @@
|
|
|
2291
2510
|
"required": false,
|
|
2292
2511
|
"type": "integer",
|
|
2293
2512
|
"default": 10,
|
|
2513
|
+
"example": 5,
|
|
2294
2514
|
"description": "Maximum number of periods per ticker",
|
|
2295
2515
|
"alias": "l"
|
|
2296
2516
|
},
|
|
@@ -2300,6 +2520,7 @@
|
|
|
2300
2520
|
"required": false,
|
|
2301
2521
|
"type": "integer",
|
|
2302
2522
|
"default": 0,
|
|
2523
|
+
"example": 0,
|
|
2303
2524
|
"description": "Number of periods to skip for pagination"
|
|
2304
2525
|
}
|
|
2305
2526
|
],
|
|
@@ -2323,6 +2544,7 @@
|
|
|
2323
2544
|
"in": "query",
|
|
2324
2545
|
"required": true,
|
|
2325
2546
|
"type": "string",
|
|
2547
|
+
"example": "AAPL",
|
|
2326
2548
|
"description": "Ticker symbol or CIK",
|
|
2327
2549
|
"alias": "i"
|
|
2328
2550
|
},
|
|
@@ -2337,6 +2559,7 @@
|
|
|
2337
2559
|
"ytd",
|
|
2338
2560
|
"ttm"
|
|
2339
2561
|
],
|
|
2562
|
+
"example": "annual",
|
|
2340
2563
|
"description": "Type of fiscal period",
|
|
2341
2564
|
"alias": "p"
|
|
2342
2565
|
},
|
|
@@ -2350,6 +2573,7 @@
|
|
|
2350
2573
|
"desc"
|
|
2351
2574
|
],
|
|
2352
2575
|
"default": "desc",
|
|
2576
|
+
"example": "desc",
|
|
2353
2577
|
"description": "Sort direction for periods by period_end",
|
|
2354
2578
|
"alias": "s"
|
|
2355
2579
|
},
|
|
@@ -2359,6 +2583,7 @@
|
|
|
2359
2583
|
"required": false,
|
|
2360
2584
|
"type": "integer",
|
|
2361
2585
|
"default": 10,
|
|
2586
|
+
"example": 5,
|
|
2362
2587
|
"description": "Maximum number of periods per ticker",
|
|
2363
2588
|
"alias": "l"
|
|
2364
2589
|
},
|
|
@@ -2368,6 +2593,7 @@
|
|
|
2368
2593
|
"required": false,
|
|
2369
2594
|
"type": "integer",
|
|
2370
2595
|
"default": 0,
|
|
2596
|
+
"example": 0,
|
|
2371
2597
|
"description": "Number of periods to skip for pagination"
|
|
2372
2598
|
}
|
|
2373
2599
|
],
|
|
@@ -2391,6 +2617,7 @@
|
|
|
2391
2617
|
"in": "query",
|
|
2392
2618
|
"required": true,
|
|
2393
2619
|
"type": "string",
|
|
2620
|
+
"example": "AAPL",
|
|
2394
2621
|
"description": "Ticker symbol or CIK",
|
|
2395
2622
|
"alias": "i"
|
|
2396
2623
|
},
|
|
@@ -2405,6 +2632,7 @@
|
|
|
2405
2632
|
"ytd",
|
|
2406
2633
|
"ttm"
|
|
2407
2634
|
],
|
|
2635
|
+
"example": "annual",
|
|
2408
2636
|
"description": "Type of fiscal period",
|
|
2409
2637
|
"alias": "p"
|
|
2410
2638
|
},
|
|
@@ -2418,6 +2646,7 @@
|
|
|
2418
2646
|
"desc"
|
|
2419
2647
|
],
|
|
2420
2648
|
"default": "desc",
|
|
2649
|
+
"example": "desc",
|
|
2421
2650
|
"description": "Sort direction for periods by period_end",
|
|
2422
2651
|
"alias": "s"
|
|
2423
2652
|
},
|
|
@@ -2427,6 +2656,7 @@
|
|
|
2427
2656
|
"required": false,
|
|
2428
2657
|
"type": "integer",
|
|
2429
2658
|
"default": 10,
|
|
2659
|
+
"example": 5,
|
|
2430
2660
|
"description": "Maximum number of periods per ticker",
|
|
2431
2661
|
"alias": "l"
|
|
2432
2662
|
},
|
|
@@ -2436,6 +2666,7 @@
|
|
|
2436
2666
|
"required": false,
|
|
2437
2667
|
"type": "integer",
|
|
2438
2668
|
"default": 0,
|
|
2669
|
+
"example": 0,
|
|
2439
2670
|
"description": "Number of periods to skip for pagination"
|
|
2440
2671
|
},
|
|
2441
2672
|
{
|
|
@@ -2448,6 +2679,7 @@
|
|
|
2448
2679
|
"false"
|
|
2449
2680
|
],
|
|
2450
2681
|
"default": "false",
|
|
2682
|
+
"example": "true",
|
|
2451
2683
|
"description": "Include formula in response"
|
|
2452
2684
|
}
|
|
2453
2685
|
],
|
|
@@ -2471,6 +2703,7 @@
|
|
|
2471
2703
|
"in": "query",
|
|
2472
2704
|
"required": true,
|
|
2473
2705
|
"type": "string",
|
|
2706
|
+
"example": "AAPL",
|
|
2474
2707
|
"description": "Ticker symbol or CIK",
|
|
2475
2708
|
"alias": "i"
|
|
2476
2709
|
},
|
|
@@ -2485,6 +2718,7 @@
|
|
|
2485
2718
|
"ytd",
|
|
2486
2719
|
"ttm"
|
|
2487
2720
|
],
|
|
2721
|
+
"example": "annual",
|
|
2488
2722
|
"description": "Type of fiscal period",
|
|
2489
2723
|
"alias": "p"
|
|
2490
2724
|
},
|
|
@@ -2498,6 +2732,7 @@
|
|
|
2498
2732
|
"desc"
|
|
2499
2733
|
],
|
|
2500
2734
|
"default": "desc",
|
|
2735
|
+
"example": "desc",
|
|
2501
2736
|
"description": "Sort direction for periods by period_end",
|
|
2502
2737
|
"alias": "s"
|
|
2503
2738
|
},
|
|
@@ -2507,6 +2742,7 @@
|
|
|
2507
2742
|
"required": false,
|
|
2508
2743
|
"type": "integer",
|
|
2509
2744
|
"default": 10,
|
|
2745
|
+
"example": 5,
|
|
2510
2746
|
"description": "Maximum number of periods per ticker",
|
|
2511
2747
|
"alias": "l"
|
|
2512
2748
|
},
|
|
@@ -2516,6 +2752,7 @@
|
|
|
2516
2752
|
"required": false,
|
|
2517
2753
|
"type": "integer",
|
|
2518
2754
|
"default": 0,
|
|
2755
|
+
"example": 0,
|
|
2519
2756
|
"description": "Number of periods to skip for pagination"
|
|
2520
2757
|
}
|
|
2521
2758
|
],
|
|
@@ -2539,6 +2776,7 @@
|
|
|
2539
2776
|
"in": "query",
|
|
2540
2777
|
"required": true,
|
|
2541
2778
|
"type": "string",
|
|
2779
|
+
"example": "AAPL",
|
|
2542
2780
|
"description": "Ticker symbol or CIK",
|
|
2543
2781
|
"alias": "i"
|
|
2544
2782
|
},
|
|
@@ -2553,6 +2791,7 @@
|
|
|
2553
2791
|
"ytd",
|
|
2554
2792
|
"ttm"
|
|
2555
2793
|
],
|
|
2794
|
+
"example": "annual",
|
|
2556
2795
|
"description": "Type of fiscal period",
|
|
2557
2796
|
"alias": "p"
|
|
2558
2797
|
},
|
|
@@ -2566,6 +2805,7 @@
|
|
|
2566
2805
|
"desc"
|
|
2567
2806
|
],
|
|
2568
2807
|
"default": "desc",
|
|
2808
|
+
"example": "desc",
|
|
2569
2809
|
"description": "Sort direction for periods by period_end",
|
|
2570
2810
|
"alias": "s"
|
|
2571
2811
|
},
|
|
@@ -2575,6 +2815,7 @@
|
|
|
2575
2815
|
"required": false,
|
|
2576
2816
|
"type": "integer",
|
|
2577
2817
|
"default": 10,
|
|
2818
|
+
"example": 5,
|
|
2578
2819
|
"description": "Maximum number of periods per ticker",
|
|
2579
2820
|
"alias": "l"
|
|
2580
2821
|
},
|
|
@@ -2584,6 +2825,7 @@
|
|
|
2584
2825
|
"required": false,
|
|
2585
2826
|
"type": "integer",
|
|
2586
2827
|
"default": 0,
|
|
2828
|
+
"example": 0,
|
|
2587
2829
|
"description": "Number of periods to skip for pagination"
|
|
2588
2830
|
}
|
|
2589
2831
|
],
|
|
@@ -2607,6 +2849,7 @@
|
|
|
2607
2849
|
"in": "query",
|
|
2608
2850
|
"required": true,
|
|
2609
2851
|
"type": "string",
|
|
2852
|
+
"example": "AAPL",
|
|
2610
2853
|
"description": "Ticker symbol or CIK",
|
|
2611
2854
|
"alias": "i"
|
|
2612
2855
|
},
|
|
@@ -2621,6 +2864,7 @@
|
|
|
2621
2864
|
"ytd",
|
|
2622
2865
|
"ttm"
|
|
2623
2866
|
],
|
|
2867
|
+
"example": "annual",
|
|
2624
2868
|
"description": "Type of fiscal period",
|
|
2625
2869
|
"alias": "p"
|
|
2626
2870
|
},
|
|
@@ -2634,6 +2878,7 @@
|
|
|
2634
2878
|
"desc"
|
|
2635
2879
|
],
|
|
2636
2880
|
"default": "desc",
|
|
2881
|
+
"example": "desc",
|
|
2637
2882
|
"description": "Sort direction for periods by period_end",
|
|
2638
2883
|
"alias": "s"
|
|
2639
2884
|
},
|
|
@@ -2643,6 +2888,7 @@
|
|
|
2643
2888
|
"required": false,
|
|
2644
2889
|
"type": "integer",
|
|
2645
2890
|
"default": 10,
|
|
2891
|
+
"example": 5,
|
|
2646
2892
|
"description": "Maximum number of periods per ticker",
|
|
2647
2893
|
"alias": "l"
|
|
2648
2894
|
},
|
|
@@ -2652,6 +2898,7 @@
|
|
|
2652
2898
|
"required": false,
|
|
2653
2899
|
"type": "integer",
|
|
2654
2900
|
"default": 0,
|
|
2901
|
+
"example": 0,
|
|
2655
2902
|
"description": "Number of periods to skip for pagination"
|
|
2656
2903
|
},
|
|
2657
2904
|
{
|
|
@@ -2664,6 +2911,7 @@
|
|
|
2664
2911
|
"false"
|
|
2665
2912
|
],
|
|
2666
2913
|
"default": "false",
|
|
2914
|
+
"example": "true",
|
|
2667
2915
|
"description": "Include formula in response"
|
|
2668
2916
|
}
|
|
2669
2917
|
],
|
|
@@ -2687,6 +2935,7 @@
|
|
|
2687
2935
|
"in": "query",
|
|
2688
2936
|
"required": true,
|
|
2689
2937
|
"type": "string",
|
|
2938
|
+
"example": "AAPL",
|
|
2690
2939
|
"description": "Ticker symbol or CIK",
|
|
2691
2940
|
"alias": "i"
|
|
2692
2941
|
},
|
|
@@ -2701,6 +2950,7 @@
|
|
|
2701
2950
|
"ytd",
|
|
2702
2951
|
"ttm"
|
|
2703
2952
|
],
|
|
2953
|
+
"example": "annual",
|
|
2704
2954
|
"description": "Type of fiscal period",
|
|
2705
2955
|
"alias": "p"
|
|
2706
2956
|
},
|
|
@@ -2714,6 +2964,7 @@
|
|
|
2714
2964
|
"desc"
|
|
2715
2965
|
],
|
|
2716
2966
|
"default": "desc",
|
|
2967
|
+
"example": "desc",
|
|
2717
2968
|
"description": "Sort direction for periods by period_end",
|
|
2718
2969
|
"alias": "s"
|
|
2719
2970
|
},
|
|
@@ -2723,6 +2974,7 @@
|
|
|
2723
2974
|
"required": false,
|
|
2724
2975
|
"type": "integer",
|
|
2725
2976
|
"default": 10,
|
|
2977
|
+
"example": 5,
|
|
2726
2978
|
"description": "Maximum number of periods per ticker",
|
|
2727
2979
|
"alias": "l"
|
|
2728
2980
|
},
|
|
@@ -2732,6 +2984,7 @@
|
|
|
2732
2984
|
"required": false,
|
|
2733
2985
|
"type": "integer",
|
|
2734
2986
|
"default": 0,
|
|
2987
|
+
"example": 0,
|
|
2735
2988
|
"description": "Number of periods to skip for pagination"
|
|
2736
2989
|
}
|
|
2737
2990
|
],
|
|
@@ -2755,6 +3008,7 @@
|
|
|
2755
3008
|
"in": "query",
|
|
2756
3009
|
"required": true,
|
|
2757
3010
|
"type": "string",
|
|
3011
|
+
"example": "AAPL,MSFT",
|
|
2758
3012
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2759
3013
|
"alias": "i"
|
|
2760
3014
|
},
|
|
@@ -2769,6 +3023,7 @@
|
|
|
2769
3023
|
"ytd",
|
|
2770
3024
|
"ttm"
|
|
2771
3025
|
],
|
|
3026
|
+
"example": "annual",
|
|
2772
3027
|
"description": "Type of fiscal period",
|
|
2773
3028
|
"alias": "p"
|
|
2774
3029
|
},
|
|
@@ -2777,6 +3032,7 @@
|
|
|
2777
3032
|
"in": "query",
|
|
2778
3033
|
"required": false,
|
|
2779
3034
|
"type": "integer",
|
|
3035
|
+
"example": 2024,
|
|
2780
3036
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2781
3037
|
},
|
|
2782
3038
|
{
|
|
@@ -2784,6 +3040,7 @@
|
|
|
2784
3040
|
"in": "query",
|
|
2785
3041
|
"required": false,
|
|
2786
3042
|
"type": "integer",
|
|
3043
|
+
"example": 4,
|
|
2787
3044
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2788
3045
|
}
|
|
2789
3046
|
],
|
|
@@ -2804,6 +3061,7 @@
|
|
|
2804
3061
|
"in": "query",
|
|
2805
3062
|
"required": true,
|
|
2806
3063
|
"type": "string",
|
|
3064
|
+
"example": "AAPL,MSFT",
|
|
2807
3065
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2808
3066
|
"alias": "i"
|
|
2809
3067
|
},
|
|
@@ -2818,6 +3076,7 @@
|
|
|
2818
3076
|
"ytd",
|
|
2819
3077
|
"ttm"
|
|
2820
3078
|
],
|
|
3079
|
+
"example": "annual",
|
|
2821
3080
|
"description": "Type of fiscal period",
|
|
2822
3081
|
"alias": "p"
|
|
2823
3082
|
},
|
|
@@ -2826,6 +3085,7 @@
|
|
|
2826
3085
|
"in": "query",
|
|
2827
3086
|
"required": false,
|
|
2828
3087
|
"type": "integer",
|
|
3088
|
+
"example": 2024,
|
|
2829
3089
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2830
3090
|
},
|
|
2831
3091
|
{
|
|
@@ -2833,6 +3093,7 @@
|
|
|
2833
3093
|
"in": "query",
|
|
2834
3094
|
"required": false,
|
|
2835
3095
|
"type": "integer",
|
|
3096
|
+
"example": 4,
|
|
2836
3097
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2837
3098
|
},
|
|
2838
3099
|
{
|
|
@@ -2845,6 +3106,7 @@
|
|
|
2845
3106
|
"false"
|
|
2846
3107
|
],
|
|
2847
3108
|
"default": "false",
|
|
3109
|
+
"example": "true",
|
|
2848
3110
|
"description": "Include formula in response"
|
|
2849
3111
|
}
|
|
2850
3112
|
],
|
|
@@ -2865,6 +3127,7 @@
|
|
|
2865
3127
|
"in": "query",
|
|
2866
3128
|
"required": true,
|
|
2867
3129
|
"type": "string",
|
|
3130
|
+
"example": "AAPL,MSFT",
|
|
2868
3131
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2869
3132
|
"alias": "i"
|
|
2870
3133
|
},
|
|
@@ -2879,6 +3142,7 @@
|
|
|
2879
3142
|
"ytd",
|
|
2880
3143
|
"ttm"
|
|
2881
3144
|
],
|
|
3145
|
+
"example": "annual",
|
|
2882
3146
|
"description": "Type of fiscal period",
|
|
2883
3147
|
"alias": "p"
|
|
2884
3148
|
},
|
|
@@ -2887,6 +3151,7 @@
|
|
|
2887
3151
|
"in": "query",
|
|
2888
3152
|
"required": false,
|
|
2889
3153
|
"type": "integer",
|
|
3154
|
+
"example": 2024,
|
|
2890
3155
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2891
3156
|
},
|
|
2892
3157
|
{
|
|
@@ -2894,6 +3159,7 @@
|
|
|
2894
3159
|
"in": "query",
|
|
2895
3160
|
"required": false,
|
|
2896
3161
|
"type": "integer",
|
|
3162
|
+
"example": 4,
|
|
2897
3163
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2898
3164
|
}
|
|
2899
3165
|
],
|
|
@@ -2914,6 +3180,7 @@
|
|
|
2914
3180
|
"in": "query",
|
|
2915
3181
|
"required": true,
|
|
2916
3182
|
"type": "string",
|
|
3183
|
+
"example": "AAPL",
|
|
2917
3184
|
"description": "Ticker symbol or CIK",
|
|
2918
3185
|
"alias": "i"
|
|
2919
3186
|
},
|
|
@@ -2928,6 +3195,7 @@
|
|
|
2928
3195
|
"ytd",
|
|
2929
3196
|
"ttm"
|
|
2930
3197
|
],
|
|
3198
|
+
"example": "annual",
|
|
2931
3199
|
"description": "Type of fiscal period",
|
|
2932
3200
|
"alias": "p"
|
|
2933
3201
|
},
|
|
@@ -2941,6 +3209,7 @@
|
|
|
2941
3209
|
"desc"
|
|
2942
3210
|
],
|
|
2943
3211
|
"default": "desc",
|
|
3212
|
+
"example": "desc",
|
|
2944
3213
|
"description": "Sort direction for periods by period_end",
|
|
2945
3214
|
"alias": "s"
|
|
2946
3215
|
},
|
|
@@ -2950,6 +3219,7 @@
|
|
|
2950
3219
|
"required": false,
|
|
2951
3220
|
"type": "integer",
|
|
2952
3221
|
"default": 10,
|
|
3222
|
+
"example": 5,
|
|
2953
3223
|
"description": "Maximum number of periods per ticker",
|
|
2954
3224
|
"alias": "l"
|
|
2955
3225
|
},
|
|
@@ -2959,6 +3229,7 @@
|
|
|
2959
3229
|
"required": false,
|
|
2960
3230
|
"type": "integer",
|
|
2961
3231
|
"default": 0,
|
|
3232
|
+
"example": 0,
|
|
2962
3233
|
"description": "Number of periods to skip for pagination"
|
|
2963
3234
|
}
|
|
2964
3235
|
],
|
|
@@ -2982,6 +3253,7 @@
|
|
|
2982
3253
|
"in": "query",
|
|
2983
3254
|
"required": true,
|
|
2984
3255
|
"type": "string",
|
|
3256
|
+
"example": "AAPL",
|
|
2985
3257
|
"description": "Ticker symbol or CIK",
|
|
2986
3258
|
"alias": "i"
|
|
2987
3259
|
},
|
|
@@ -2996,6 +3268,7 @@
|
|
|
2996
3268
|
"ytd",
|
|
2997
3269
|
"ttm"
|
|
2998
3270
|
],
|
|
3271
|
+
"example": "annual",
|
|
2999
3272
|
"description": "Type of fiscal period",
|
|
3000
3273
|
"alias": "p"
|
|
3001
3274
|
},
|
|
@@ -3009,6 +3282,7 @@
|
|
|
3009
3282
|
"desc"
|
|
3010
3283
|
],
|
|
3011
3284
|
"default": "desc",
|
|
3285
|
+
"example": "desc",
|
|
3012
3286
|
"description": "Sort direction for periods by period_end",
|
|
3013
3287
|
"alias": "s"
|
|
3014
3288
|
},
|
|
@@ -3018,6 +3292,7 @@
|
|
|
3018
3292
|
"required": false,
|
|
3019
3293
|
"type": "integer",
|
|
3020
3294
|
"default": 10,
|
|
3295
|
+
"example": 5,
|
|
3021
3296
|
"description": "Maximum number of periods per ticker",
|
|
3022
3297
|
"alias": "l"
|
|
3023
3298
|
},
|
|
@@ -3027,6 +3302,7 @@
|
|
|
3027
3302
|
"required": false,
|
|
3028
3303
|
"type": "integer",
|
|
3029
3304
|
"default": 0,
|
|
3305
|
+
"example": 0,
|
|
3030
3306
|
"description": "Number of periods to skip for pagination"
|
|
3031
3307
|
},
|
|
3032
3308
|
{
|
|
@@ -3039,6 +3315,7 @@
|
|
|
3039
3315
|
"false"
|
|
3040
3316
|
],
|
|
3041
3317
|
"default": "false",
|
|
3318
|
+
"example": "true",
|
|
3042
3319
|
"description": "Include formula in response"
|
|
3043
3320
|
}
|
|
3044
3321
|
],
|
|
@@ -3062,6 +3339,7 @@
|
|
|
3062
3339
|
"in": "query",
|
|
3063
3340
|
"required": true,
|
|
3064
3341
|
"type": "string",
|
|
3342
|
+
"example": "AAPL",
|
|
3065
3343
|
"description": "Ticker symbol or CIK",
|
|
3066
3344
|
"alias": "i"
|
|
3067
3345
|
},
|
|
@@ -3076,6 +3354,7 @@
|
|
|
3076
3354
|
"ytd",
|
|
3077
3355
|
"ttm"
|
|
3078
3356
|
],
|
|
3357
|
+
"example": "annual",
|
|
3079
3358
|
"description": "Type of fiscal period",
|
|
3080
3359
|
"alias": "p"
|
|
3081
3360
|
},
|
|
@@ -3089,6 +3368,7 @@
|
|
|
3089
3368
|
"desc"
|
|
3090
3369
|
],
|
|
3091
3370
|
"default": "desc",
|
|
3371
|
+
"example": "desc",
|
|
3092
3372
|
"description": "Sort direction for periods by period_end",
|
|
3093
3373
|
"alias": "s"
|
|
3094
3374
|
},
|
|
@@ -3098,6 +3378,7 @@
|
|
|
3098
3378
|
"required": false,
|
|
3099
3379
|
"type": "integer",
|
|
3100
3380
|
"default": 10,
|
|
3381
|
+
"example": 5,
|
|
3101
3382
|
"description": "Maximum number of periods per ticker",
|
|
3102
3383
|
"alias": "l"
|
|
3103
3384
|
},
|
|
@@ -3107,6 +3388,7 @@
|
|
|
3107
3388
|
"required": false,
|
|
3108
3389
|
"type": "integer",
|
|
3109
3390
|
"default": 0,
|
|
3391
|
+
"example": 0,
|
|
3110
3392
|
"description": "Number of periods to skip for pagination"
|
|
3111
3393
|
}
|
|
3112
3394
|
],
|
|
@@ -3130,6 +3412,7 @@
|
|
|
3130
3412
|
"in": "query",
|
|
3131
3413
|
"required": true,
|
|
3132
3414
|
"type": "string",
|
|
3415
|
+
"example": "AAPL",
|
|
3133
3416
|
"description": "Ticker symbol or CIK",
|
|
3134
3417
|
"alias": "i"
|
|
3135
3418
|
},
|
|
@@ -3144,6 +3427,7 @@
|
|
|
3144
3427
|
"ytd",
|
|
3145
3428
|
"ttm"
|
|
3146
3429
|
],
|
|
3430
|
+
"example": "annual",
|
|
3147
3431
|
"description": "Type of fiscal period",
|
|
3148
3432
|
"alias": "p"
|
|
3149
3433
|
},
|
|
@@ -3157,6 +3441,7 @@
|
|
|
3157
3441
|
"desc"
|
|
3158
3442
|
],
|
|
3159
3443
|
"default": "desc",
|
|
3444
|
+
"example": "desc",
|
|
3160
3445
|
"description": "Sort direction for periods by period_end",
|
|
3161
3446
|
"alias": "s"
|
|
3162
3447
|
},
|
|
@@ -3166,6 +3451,7 @@
|
|
|
3166
3451
|
"required": false,
|
|
3167
3452
|
"type": "integer",
|
|
3168
3453
|
"default": 10,
|
|
3454
|
+
"example": 5,
|
|
3169
3455
|
"description": "Maximum number of periods per ticker",
|
|
3170
3456
|
"alias": "l"
|
|
3171
3457
|
},
|
|
@@ -3175,6 +3461,7 @@
|
|
|
3175
3461
|
"required": false,
|
|
3176
3462
|
"type": "integer",
|
|
3177
3463
|
"default": 0,
|
|
3464
|
+
"example": 0,
|
|
3178
3465
|
"description": "Number of periods to skip for pagination"
|
|
3179
3466
|
}
|
|
3180
3467
|
],
|
|
@@ -3198,6 +3485,7 @@
|
|
|
3198
3485
|
"in": "query",
|
|
3199
3486
|
"required": true,
|
|
3200
3487
|
"type": "string",
|
|
3488
|
+
"example": "AAPL",
|
|
3201
3489
|
"description": "Ticker symbol or CIK",
|
|
3202
3490
|
"alias": "i"
|
|
3203
3491
|
},
|
|
@@ -3212,6 +3500,7 @@
|
|
|
3212
3500
|
"ytd",
|
|
3213
3501
|
"ttm"
|
|
3214
3502
|
],
|
|
3503
|
+
"example": "annual",
|
|
3215
3504
|
"description": "Type of fiscal period",
|
|
3216
3505
|
"alias": "p"
|
|
3217
3506
|
},
|
|
@@ -3225,6 +3514,7 @@
|
|
|
3225
3514
|
"desc"
|
|
3226
3515
|
],
|
|
3227
3516
|
"default": "desc",
|
|
3517
|
+
"example": "desc",
|
|
3228
3518
|
"description": "Sort direction for periods by period_end",
|
|
3229
3519
|
"alias": "s"
|
|
3230
3520
|
},
|
|
@@ -3234,6 +3524,7 @@
|
|
|
3234
3524
|
"required": false,
|
|
3235
3525
|
"type": "integer",
|
|
3236
3526
|
"default": 10,
|
|
3527
|
+
"example": 5,
|
|
3237
3528
|
"description": "Maximum number of periods per ticker",
|
|
3238
3529
|
"alias": "l"
|
|
3239
3530
|
},
|
|
@@ -3243,6 +3534,7 @@
|
|
|
3243
3534
|
"required": false,
|
|
3244
3535
|
"type": "integer",
|
|
3245
3536
|
"default": 0,
|
|
3537
|
+
"example": 0,
|
|
3246
3538
|
"description": "Number of periods to skip for pagination"
|
|
3247
3539
|
},
|
|
3248
3540
|
{
|
|
@@ -3255,6 +3547,7 @@
|
|
|
3255
3547
|
"false"
|
|
3256
3548
|
],
|
|
3257
3549
|
"default": "false",
|
|
3550
|
+
"example": "true",
|
|
3258
3551
|
"description": "Include formula in response"
|
|
3259
3552
|
}
|
|
3260
3553
|
],
|
|
@@ -3278,6 +3571,7 @@
|
|
|
3278
3571
|
"in": "query",
|
|
3279
3572
|
"required": true,
|
|
3280
3573
|
"type": "string",
|
|
3574
|
+
"example": "AAPL",
|
|
3281
3575
|
"description": "Ticker symbol or CIK",
|
|
3282
3576
|
"alias": "i"
|
|
3283
3577
|
},
|
|
@@ -3292,6 +3586,7 @@
|
|
|
3292
3586
|
"ytd",
|
|
3293
3587
|
"ttm"
|
|
3294
3588
|
],
|
|
3589
|
+
"example": "annual",
|
|
3295
3590
|
"description": "Type of fiscal period",
|
|
3296
3591
|
"alias": "p"
|
|
3297
3592
|
},
|
|
@@ -3305,6 +3600,7 @@
|
|
|
3305
3600
|
"desc"
|
|
3306
3601
|
],
|
|
3307
3602
|
"default": "desc",
|
|
3603
|
+
"example": "desc",
|
|
3308
3604
|
"description": "Sort direction for periods by period_end",
|
|
3309
3605
|
"alias": "s"
|
|
3310
3606
|
},
|
|
@@ -3314,6 +3610,7 @@
|
|
|
3314
3610
|
"required": false,
|
|
3315
3611
|
"type": "integer",
|
|
3316
3612
|
"default": 10,
|
|
3613
|
+
"example": 5,
|
|
3317
3614
|
"description": "Maximum number of periods per ticker",
|
|
3318
3615
|
"alias": "l"
|
|
3319
3616
|
},
|
|
@@ -3323,6 +3620,7 @@
|
|
|
3323
3620
|
"required": false,
|
|
3324
3621
|
"type": "integer",
|
|
3325
3622
|
"default": 0,
|
|
3623
|
+
"example": 0,
|
|
3326
3624
|
"description": "Number of periods to skip for pagination"
|
|
3327
3625
|
}
|
|
3328
3626
|
],
|
|
@@ -3346,6 +3644,7 @@
|
|
|
3346
3644
|
"in": "query",
|
|
3347
3645
|
"required": true,
|
|
3348
3646
|
"type": "string",
|
|
3647
|
+
"example": "AAPL",
|
|
3349
3648
|
"description": "Ticker symbol or CIK",
|
|
3350
3649
|
"alias": "i"
|
|
3351
3650
|
},
|
|
@@ -3360,6 +3659,7 @@
|
|
|
3360
3659
|
"ytd",
|
|
3361
3660
|
"ttm"
|
|
3362
3661
|
],
|
|
3662
|
+
"example": "annual",
|
|
3363
3663
|
"description": "Type of fiscal period",
|
|
3364
3664
|
"alias": "p"
|
|
3365
3665
|
},
|
|
@@ -3373,6 +3673,7 @@
|
|
|
3373
3673
|
"desc"
|
|
3374
3674
|
],
|
|
3375
3675
|
"default": "desc",
|
|
3676
|
+
"example": "desc",
|
|
3376
3677
|
"description": "Sort direction for periods by period_end",
|
|
3377
3678
|
"alias": "s"
|
|
3378
3679
|
},
|
|
@@ -3382,6 +3683,7 @@
|
|
|
3382
3683
|
"required": false,
|
|
3383
3684
|
"type": "integer",
|
|
3384
3685
|
"default": 10,
|
|
3686
|
+
"example": 5,
|
|
3385
3687
|
"description": "Maximum number of periods per ticker",
|
|
3386
3688
|
"alias": "l"
|
|
3387
3689
|
},
|
|
@@ -3391,6 +3693,7 @@
|
|
|
3391
3693
|
"required": false,
|
|
3392
3694
|
"type": "integer",
|
|
3393
3695
|
"default": 0,
|
|
3696
|
+
"example": 0,
|
|
3394
3697
|
"description": "Number of periods to skip for pagination"
|
|
3395
3698
|
}
|
|
3396
3699
|
],
|
|
@@ -3414,6 +3717,7 @@
|
|
|
3414
3717
|
"in": "query",
|
|
3415
3718
|
"required": true,
|
|
3416
3719
|
"type": "string",
|
|
3720
|
+
"example": "AAPL",
|
|
3417
3721
|
"description": "Ticker symbol or CIK",
|
|
3418
3722
|
"alias": "i"
|
|
3419
3723
|
},
|
|
@@ -3428,6 +3732,7 @@
|
|
|
3428
3732
|
"ytd",
|
|
3429
3733
|
"ttm"
|
|
3430
3734
|
],
|
|
3735
|
+
"example": "annual",
|
|
3431
3736
|
"description": "Type of fiscal period",
|
|
3432
3737
|
"alias": "p"
|
|
3433
3738
|
},
|
|
@@ -3441,6 +3746,7 @@
|
|
|
3441
3746
|
"desc"
|
|
3442
3747
|
],
|
|
3443
3748
|
"default": "desc",
|
|
3749
|
+
"example": "desc",
|
|
3444
3750
|
"description": "Sort direction for periods by period_end",
|
|
3445
3751
|
"alias": "s"
|
|
3446
3752
|
},
|
|
@@ -3450,6 +3756,7 @@
|
|
|
3450
3756
|
"required": false,
|
|
3451
3757
|
"type": "integer",
|
|
3452
3758
|
"default": 10,
|
|
3759
|
+
"example": 5,
|
|
3453
3760
|
"description": "Maximum number of periods per ticker",
|
|
3454
3761
|
"alias": "l"
|
|
3455
3762
|
},
|
|
@@ -3459,6 +3766,7 @@
|
|
|
3459
3766
|
"required": false,
|
|
3460
3767
|
"type": "integer",
|
|
3461
3768
|
"default": 0,
|
|
3769
|
+
"example": 0,
|
|
3462
3770
|
"description": "Number of periods to skip for pagination"
|
|
3463
3771
|
},
|
|
3464
3772
|
{
|
|
@@ -3471,6 +3779,7 @@
|
|
|
3471
3779
|
"false"
|
|
3472
3780
|
],
|
|
3473
3781
|
"default": "false",
|
|
3782
|
+
"example": "true",
|
|
3474
3783
|
"description": "Include formula in response"
|
|
3475
3784
|
}
|
|
3476
3785
|
],
|
|
@@ -3494,6 +3803,7 @@
|
|
|
3494
3803
|
"in": "query",
|
|
3495
3804
|
"required": true,
|
|
3496
3805
|
"type": "string",
|
|
3806
|
+
"example": "AAPL",
|
|
3497
3807
|
"description": "Ticker symbol or CIK",
|
|
3498
3808
|
"alias": "i"
|
|
3499
3809
|
},
|
|
@@ -3508,6 +3818,7 @@
|
|
|
3508
3818
|
"ytd",
|
|
3509
3819
|
"ttm"
|
|
3510
3820
|
],
|
|
3821
|
+
"example": "annual",
|
|
3511
3822
|
"description": "Type of fiscal period",
|
|
3512
3823
|
"alias": "p"
|
|
3513
3824
|
},
|
|
@@ -3521,6 +3832,7 @@
|
|
|
3521
3832
|
"desc"
|
|
3522
3833
|
],
|
|
3523
3834
|
"default": "desc",
|
|
3835
|
+
"example": "desc",
|
|
3524
3836
|
"description": "Sort direction for periods by period_end",
|
|
3525
3837
|
"alias": "s"
|
|
3526
3838
|
},
|
|
@@ -3530,6 +3842,7 @@
|
|
|
3530
3842
|
"required": false,
|
|
3531
3843
|
"type": "integer",
|
|
3532
3844
|
"default": 10,
|
|
3845
|
+
"example": 5,
|
|
3533
3846
|
"description": "Maximum number of periods per ticker",
|
|
3534
3847
|
"alias": "l"
|
|
3535
3848
|
},
|
|
@@ -3539,6 +3852,7 @@
|
|
|
3539
3852
|
"required": false,
|
|
3540
3853
|
"type": "integer",
|
|
3541
3854
|
"default": 0,
|
|
3855
|
+
"example": 0,
|
|
3542
3856
|
"description": "Number of periods to skip for pagination"
|
|
3543
3857
|
}
|
|
3544
3858
|
],
|
|
@@ -3562,6 +3876,7 @@
|
|
|
3562
3876
|
"in": "query",
|
|
3563
3877
|
"required": true,
|
|
3564
3878
|
"type": "string",
|
|
3879
|
+
"example": "AAPL,MSFT",
|
|
3565
3880
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3566
3881
|
"alias": "i"
|
|
3567
3882
|
},
|
|
@@ -3576,6 +3891,7 @@
|
|
|
3576
3891
|
"ytd",
|
|
3577
3892
|
"ttm"
|
|
3578
3893
|
],
|
|
3894
|
+
"example": "annual",
|
|
3579
3895
|
"description": "Type of fiscal period",
|
|
3580
3896
|
"alias": "p"
|
|
3581
3897
|
},
|
|
@@ -3584,6 +3900,7 @@
|
|
|
3584
3900
|
"in": "query",
|
|
3585
3901
|
"required": false,
|
|
3586
3902
|
"type": "integer",
|
|
3903
|
+
"example": 2024,
|
|
3587
3904
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3588
3905
|
},
|
|
3589
3906
|
{
|
|
@@ -3591,6 +3908,7 @@
|
|
|
3591
3908
|
"in": "query",
|
|
3592
3909
|
"required": false,
|
|
3593
3910
|
"type": "integer",
|
|
3911
|
+
"example": 4,
|
|
3594
3912
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3595
3913
|
}
|
|
3596
3914
|
],
|
|
@@ -3611,6 +3929,7 @@
|
|
|
3611
3929
|
"in": "query",
|
|
3612
3930
|
"required": true,
|
|
3613
3931
|
"type": "string",
|
|
3932
|
+
"example": "AAPL,MSFT",
|
|
3614
3933
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3615
3934
|
"alias": "i"
|
|
3616
3935
|
},
|
|
@@ -3625,6 +3944,7 @@
|
|
|
3625
3944
|
"ytd",
|
|
3626
3945
|
"ttm"
|
|
3627
3946
|
],
|
|
3947
|
+
"example": "annual",
|
|
3628
3948
|
"description": "Type of fiscal period",
|
|
3629
3949
|
"alias": "p"
|
|
3630
3950
|
},
|
|
@@ -3633,6 +3953,7 @@
|
|
|
3633
3953
|
"in": "query",
|
|
3634
3954
|
"required": false,
|
|
3635
3955
|
"type": "integer",
|
|
3956
|
+
"example": 2024,
|
|
3636
3957
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3637
3958
|
},
|
|
3638
3959
|
{
|
|
@@ -3640,6 +3961,7 @@
|
|
|
3640
3961
|
"in": "query",
|
|
3641
3962
|
"required": false,
|
|
3642
3963
|
"type": "integer",
|
|
3964
|
+
"example": 4,
|
|
3643
3965
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3644
3966
|
},
|
|
3645
3967
|
{
|
|
@@ -3652,6 +3974,7 @@
|
|
|
3652
3974
|
"false"
|
|
3653
3975
|
],
|
|
3654
3976
|
"default": "false",
|
|
3977
|
+
"example": "true",
|
|
3655
3978
|
"description": "Include formula in response"
|
|
3656
3979
|
}
|
|
3657
3980
|
],
|
|
@@ -3672,6 +3995,7 @@
|
|
|
3672
3995
|
"in": "query",
|
|
3673
3996
|
"required": true,
|
|
3674
3997
|
"type": "string",
|
|
3998
|
+
"example": "AAPL,MSFT",
|
|
3675
3999
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3676
4000
|
"alias": "i"
|
|
3677
4001
|
},
|
|
@@ -3686,6 +4010,7 @@
|
|
|
3686
4010
|
"ytd",
|
|
3687
4011
|
"ttm"
|
|
3688
4012
|
],
|
|
4013
|
+
"example": "annual",
|
|
3689
4014
|
"description": "Type of fiscal period",
|
|
3690
4015
|
"alias": "p"
|
|
3691
4016
|
},
|
|
@@ -3694,6 +4019,7 @@
|
|
|
3694
4019
|
"in": "query",
|
|
3695
4020
|
"required": false,
|
|
3696
4021
|
"type": "integer",
|
|
4022
|
+
"example": 2024,
|
|
3697
4023
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3698
4024
|
},
|
|
3699
4025
|
{
|
|
@@ -3701,6 +4027,7 @@
|
|
|
3701
4027
|
"in": "query",
|
|
3702
4028
|
"required": false,
|
|
3703
4029
|
"type": "integer",
|
|
4030
|
+
"example": 4,
|
|
3704
4031
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3705
4032
|
}
|
|
3706
4033
|
],
|
|
@@ -3737,6 +4064,7 @@
|
|
|
3737
4064
|
"in": "query",
|
|
3738
4065
|
"required": true,
|
|
3739
4066
|
"type": "string",
|
|
4067
|
+
"example": "AAPL",
|
|
3740
4068
|
"description": "Company ticker symbol or CIK",
|
|
3741
4069
|
"alias": "i"
|
|
3742
4070
|
},
|
|
@@ -3745,6 +4073,7 @@
|
|
|
3745
4073
|
"in": "query",
|
|
3746
4074
|
"required": false,
|
|
3747
4075
|
"type": "string",
|
|
4076
|
+
"example": "2025-01-01",
|
|
3748
4077
|
"description": "Filter transactions filed on or after this date (YYYY-MM-DD)"
|
|
3749
4078
|
},
|
|
3750
4079
|
{
|
|
@@ -3752,6 +4081,7 @@
|
|
|
3752
4081
|
"in": "query",
|
|
3753
4082
|
"required": false,
|
|
3754
4083
|
"type": "string",
|
|
4084
|
+
"example": "2025-12-31",
|
|
3755
4085
|
"description": "Filter transactions filed on or before this date (YYYY-MM-DD)"
|
|
3756
4086
|
},
|
|
3757
4087
|
{
|
|
@@ -3763,6 +4093,7 @@
|
|
|
3763
4093
|
"A",
|
|
3764
4094
|
"D"
|
|
3765
4095
|
],
|
|
4096
|
+
"example": "D",
|
|
3766
4097
|
"description": "Filter by acquisition (A) or disposition (D)"
|
|
3767
4098
|
},
|
|
3768
4099
|
{
|
|
@@ -3775,6 +4106,7 @@
|
|
|
3775
4106
|
"desc"
|
|
3776
4107
|
],
|
|
3777
4108
|
"default": "desc",
|
|
4109
|
+
"example": "desc",
|
|
3778
4110
|
"description": "Sort direction by filed_at date",
|
|
3779
4111
|
"alias": "s"
|
|
3780
4112
|
},
|
|
@@ -3784,6 +4116,7 @@
|
|
|
3784
4116
|
"required": false,
|
|
3785
4117
|
"type": "integer",
|
|
3786
4118
|
"default": 100,
|
|
4119
|
+
"example": 5,
|
|
3787
4120
|
"description": "Maximum number of transactions to return",
|
|
3788
4121
|
"alias": "l"
|
|
3789
4122
|
},
|
|
@@ -3793,6 +4126,7 @@
|
|
|
3793
4126
|
"required": false,
|
|
3794
4127
|
"type": "integer",
|
|
3795
4128
|
"default": 0,
|
|
4129
|
+
"example": 0,
|
|
3796
4130
|
"description": "Number of transactions to skip for pagination"
|
|
3797
4131
|
}
|
|
3798
4132
|
],
|
|
@@ -3837,6 +4171,7 @@
|
|
|
3837
4171
|
"in": "query",
|
|
3838
4172
|
"required": false,
|
|
3839
4173
|
"type": "string",
|
|
4174
|
+
"example": "2025-01-01",
|
|
3840
4175
|
"description": "Filter IPOs with listing_date on or after this date (YYYY-MM-DD)"
|
|
3841
4176
|
},
|
|
3842
4177
|
{
|
|
@@ -3844,6 +4179,7 @@
|
|
|
3844
4179
|
"in": "query",
|
|
3845
4180
|
"required": false,
|
|
3846
4181
|
"type": "string",
|
|
4182
|
+
"example": "2025-12-31",
|
|
3847
4183
|
"description": "Filter IPOs with listing_date on or before this date (YYYY-MM-DD)"
|
|
3848
4184
|
},
|
|
3849
4185
|
{
|
|
@@ -3856,6 +4192,7 @@
|
|
|
3856
4192
|
"desc"
|
|
3857
4193
|
],
|
|
3858
4194
|
"default": "desc",
|
|
4195
|
+
"example": "desc",
|
|
3859
4196
|
"description": "Sort direction for IPOs by listing_date",
|
|
3860
4197
|
"alias": "s"
|
|
3861
4198
|
},
|
|
@@ -3865,6 +4202,7 @@
|
|
|
3865
4202
|
"required": false,
|
|
3866
4203
|
"type": "integer",
|
|
3867
4204
|
"default": 100,
|
|
4205
|
+
"example": 5,
|
|
3868
4206
|
"description": "Maximum number of IPOs to return",
|
|
3869
4207
|
"alias": "l"
|
|
3870
4208
|
},
|
|
@@ -3874,6 +4212,7 @@
|
|
|
3874
4212
|
"required": false,
|
|
3875
4213
|
"type": "integer",
|
|
3876
4214
|
"default": 0,
|
|
4215
|
+
"example": 0,
|
|
3877
4216
|
"description": "Number of IPOs to skip for pagination"
|
|
3878
4217
|
}
|
|
3879
4218
|
],
|
|
@@ -3916,6 +4255,7 @@
|
|
|
3916
4255
|
"desc"
|
|
3917
4256
|
],
|
|
3918
4257
|
"default": "asc",
|
|
4258
|
+
"example": "desc",
|
|
3919
4259
|
"description": "Sort direction for holidays by date",
|
|
3920
4260
|
"alias": "s"
|
|
3921
4261
|
},
|
|
@@ -3925,6 +4265,7 @@
|
|
|
3925
4265
|
"required": false,
|
|
3926
4266
|
"type": "integer",
|
|
3927
4267
|
"default": 100,
|
|
4268
|
+
"example": 5,
|
|
3928
4269
|
"description": "Maximum number of holidays to return",
|
|
3929
4270
|
"alias": "l"
|
|
3930
4271
|
},
|
|
@@ -3934,6 +4275,7 @@
|
|
|
3934
4275
|
"required": false,
|
|
3935
4276
|
"type": "integer",
|
|
3936
4277
|
"default": 0,
|
|
4278
|
+
"example": 0,
|
|
3937
4279
|
"description": "Number of holidays to skip for pagination"
|
|
3938
4280
|
}
|
|
3939
4281
|
],
|
|
@@ -3993,6 +4335,7 @@
|
|
|
3993
4335
|
"in": "query",
|
|
3994
4336
|
"required": true,
|
|
3995
4337
|
"type": "string",
|
|
4338
|
+
"example": "AAPL",
|
|
3996
4339
|
"description": "Ticker symbol or CIK",
|
|
3997
4340
|
"alias": "i"
|
|
3998
4341
|
},
|
|
@@ -4006,6 +4349,7 @@
|
|
|
4006
4349
|
"5",
|
|
4007
4350
|
"10"
|
|
4008
4351
|
],
|
|
4352
|
+
"example": "5",
|
|
4009
4353
|
"description": "CAGR calculation period in years: 3, 5, 10"
|
|
4010
4354
|
},
|
|
4011
4355
|
{
|
|
@@ -4018,6 +4362,7 @@
|
|
|
4018
4362
|
"desc"
|
|
4019
4363
|
],
|
|
4020
4364
|
"default": "desc",
|
|
4365
|
+
"example": "desc",
|
|
4021
4366
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4022
4367
|
"alias": "s"
|
|
4023
4368
|
},
|
|
@@ -4027,6 +4372,7 @@
|
|
|
4027
4372
|
"required": false,
|
|
4028
4373
|
"type": "integer",
|
|
4029
4374
|
"default": 10,
|
|
4375
|
+
"example": 5,
|
|
4030
4376
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4031
4377
|
"alias": "l"
|
|
4032
4378
|
},
|
|
@@ -4036,6 +4382,7 @@
|
|
|
4036
4382
|
"required": false,
|
|
4037
4383
|
"type": "integer",
|
|
4038
4384
|
"default": 0,
|
|
4385
|
+
"example": 0,
|
|
4039
4386
|
"description": "Number of periods to skip for pagination"
|
|
4040
4387
|
}
|
|
4041
4388
|
],
|
|
@@ -4059,6 +4406,7 @@
|
|
|
4059
4406
|
"in": "query",
|
|
4060
4407
|
"required": true,
|
|
4061
4408
|
"type": "string",
|
|
4409
|
+
"example": "AAPL",
|
|
4062
4410
|
"description": "Ticker symbol or CIK",
|
|
4063
4411
|
"alias": "i"
|
|
4064
4412
|
},
|
|
@@ -4073,6 +4421,7 @@
|
|
|
4073
4421
|
"ytd",
|
|
4074
4422
|
"ttm"
|
|
4075
4423
|
],
|
|
4424
|
+
"example": "annual",
|
|
4076
4425
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4077
4426
|
"alias": "p"
|
|
4078
4427
|
},
|
|
@@ -4085,6 +4434,7 @@
|
|
|
4085
4434
|
"year_over_year",
|
|
4086
4435
|
"quarter_over_quarter"
|
|
4087
4436
|
],
|
|
4437
|
+
"example": "year_over_year",
|
|
4088
4438
|
"description": "Filter by growth type: year_over_year, quarter_over_quarter"
|
|
4089
4439
|
},
|
|
4090
4440
|
{
|
|
@@ -4097,6 +4447,7 @@
|
|
|
4097
4447
|
"desc"
|
|
4098
4448
|
],
|
|
4099
4449
|
"default": "desc",
|
|
4450
|
+
"example": "desc",
|
|
4100
4451
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4101
4452
|
"alias": "s"
|
|
4102
4453
|
},
|
|
@@ -4106,6 +4457,7 @@
|
|
|
4106
4457
|
"required": false,
|
|
4107
4458
|
"type": "integer",
|
|
4108
4459
|
"default": 10,
|
|
4460
|
+
"example": 5,
|
|
4109
4461
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4110
4462
|
"alias": "l"
|
|
4111
4463
|
},
|
|
@@ -4115,6 +4467,7 @@
|
|
|
4115
4467
|
"required": false,
|
|
4116
4468
|
"type": "integer",
|
|
4117
4469
|
"default": 0,
|
|
4470
|
+
"example": 0,
|
|
4118
4471
|
"description": "Number of periods to skip for pagination"
|
|
4119
4472
|
}
|
|
4120
4473
|
],
|
|
@@ -4138,6 +4491,7 @@
|
|
|
4138
4491
|
"in": "query",
|
|
4139
4492
|
"required": true,
|
|
4140
4493
|
"type": "string",
|
|
4494
|
+
"example": "AAPL",
|
|
4141
4495
|
"description": "Ticker symbol or CIK",
|
|
4142
4496
|
"alias": "i"
|
|
4143
4497
|
},
|
|
@@ -4152,6 +4506,7 @@
|
|
|
4152
4506
|
"ytd",
|
|
4153
4507
|
"ttm"
|
|
4154
4508
|
],
|
|
4509
|
+
"example": "annual",
|
|
4155
4510
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4156
4511
|
"alias": "p"
|
|
4157
4512
|
},
|
|
@@ -4166,6 +4521,7 @@
|
|
|
4166
4521
|
"liquidity",
|
|
4167
4522
|
"solvency"
|
|
4168
4523
|
],
|
|
4524
|
+
"example": "profitability",
|
|
4169
4525
|
"description": "Filter by ratio category: valuation, profitability, liquidity, solvency"
|
|
4170
4526
|
},
|
|
4171
4527
|
{
|
|
@@ -4178,6 +4534,7 @@
|
|
|
4178
4534
|
"desc"
|
|
4179
4535
|
],
|
|
4180
4536
|
"default": "desc",
|
|
4537
|
+
"example": "desc",
|
|
4181
4538
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4182
4539
|
"alias": "s"
|
|
4183
4540
|
},
|
|
@@ -4187,6 +4544,7 @@
|
|
|
4187
4544
|
"required": false,
|
|
4188
4545
|
"type": "integer",
|
|
4189
4546
|
"default": 10,
|
|
4547
|
+
"example": 5,
|
|
4190
4548
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4191
4549
|
"alias": "l"
|
|
4192
4550
|
},
|
|
@@ -4196,6 +4554,7 @@
|
|
|
4196
4554
|
"required": false,
|
|
4197
4555
|
"type": "integer",
|
|
4198
4556
|
"default": 0,
|
|
4557
|
+
"example": 0,
|
|
4199
4558
|
"description": "Number of periods to skip for pagination"
|
|
4200
4559
|
}
|
|
4201
4560
|
],
|
|
@@ -4219,6 +4578,7 @@
|
|
|
4219
4578
|
"in": "query",
|
|
4220
4579
|
"required": true,
|
|
4221
4580
|
"type": "string",
|
|
4581
|
+
"example": "AAPL",
|
|
4222
4582
|
"description": "Company ticker symbol or CIK",
|
|
4223
4583
|
"alias": "i"
|
|
4224
4584
|
},
|
|
@@ -4227,6 +4587,7 @@
|
|
|
4227
4587
|
"in": "query",
|
|
4228
4588
|
"required": false,
|
|
4229
4589
|
"type": "number",
|
|
4590
|
+
"example": 1000000000,
|
|
4230
4591
|
"description": "Minimum dollar value filter"
|
|
4231
4592
|
},
|
|
4232
4593
|
{
|
|
@@ -4239,6 +4600,7 @@
|
|
|
4239
4600
|
"desc"
|
|
4240
4601
|
],
|
|
4241
4602
|
"default": "desc",
|
|
4603
|
+
"example": "desc",
|
|
4242
4604
|
"description": "Sort direction by dollar_value",
|
|
4243
4605
|
"alias": "s"
|
|
4244
4606
|
},
|
|
@@ -4248,6 +4610,7 @@
|
|
|
4248
4610
|
"required": false,
|
|
4249
4611
|
"type": "integer",
|
|
4250
4612
|
"default": 100,
|
|
4613
|
+
"example": 5,
|
|
4251
4614
|
"description": "Maximum number of holdings to return",
|
|
4252
4615
|
"alias": "l"
|
|
4253
4616
|
},
|
|
@@ -4257,6 +4620,7 @@
|
|
|
4257
4620
|
"required": false,
|
|
4258
4621
|
"type": "integer",
|
|
4259
4622
|
"default": 0,
|
|
4623
|
+
"example": 0,
|
|
4260
4624
|
"description": "Number of holdings to skip for pagination"
|
|
4261
4625
|
}
|
|
4262
4626
|
],
|
|
@@ -4303,6 +4667,7 @@
|
|
|
4303
4667
|
"in": "query",
|
|
4304
4668
|
"required": true,
|
|
4305
4669
|
"type": "string",
|
|
4670
|
+
"example": "1067983",
|
|
4306
4671
|
"description": "Institution CIK"
|
|
4307
4672
|
},
|
|
4308
4673
|
{
|
|
@@ -4315,6 +4680,7 @@
|
|
|
4315
4680
|
"desc"
|
|
4316
4681
|
],
|
|
4317
4682
|
"default": "desc",
|
|
4683
|
+
"example": "desc",
|
|
4318
4684
|
"description": "Sort direction by dollar_value",
|
|
4319
4685
|
"alias": "s"
|
|
4320
4686
|
},
|
|
@@ -4324,6 +4690,7 @@
|
|
|
4324
4690
|
"required": false,
|
|
4325
4691
|
"type": "integer",
|
|
4326
4692
|
"default": 100,
|
|
4693
|
+
"example": 5,
|
|
4327
4694
|
"description": "Maximum number of holdings to return",
|
|
4328
4695
|
"alias": "l"
|
|
4329
4696
|
},
|
|
@@ -4333,6 +4700,7 @@
|
|
|
4333
4700
|
"required": false,
|
|
4334
4701
|
"type": "integer",
|
|
4335
4702
|
"default": 0,
|
|
4703
|
+
"example": 0,
|
|
4336
4704
|
"description": "Number of holdings to skip for pagination"
|
|
4337
4705
|
}
|
|
4338
4706
|
],
|
|
@@ -4379,6 +4747,7 @@
|
|
|
4379
4747
|
"in": "query",
|
|
4380
4748
|
"required": false,
|
|
4381
4749
|
"type": "string",
|
|
4750
|
+
"example": "1067983,102909",
|
|
4382
4751
|
"description": "Comma-separated list of CIKs (Central Index Keys)"
|
|
4383
4752
|
},
|
|
4384
4753
|
{
|
|
@@ -4387,6 +4756,7 @@
|
|
|
4387
4756
|
"required": false,
|
|
4388
4757
|
"type": "integer",
|
|
4389
4758
|
"default": 100,
|
|
4759
|
+
"example": 5,
|
|
4390
4760
|
"description": "Maximum number of institutions to return",
|
|
4391
4761
|
"alias": "l"
|
|
4392
4762
|
},
|
|
@@ -4396,6 +4766,7 @@
|
|
|
4396
4766
|
"required": false,
|
|
4397
4767
|
"type": "integer",
|
|
4398
4768
|
"default": 0,
|
|
4769
|
+
"example": 0,
|
|
4399
4770
|
"description": "Pagination offset"
|
|
4400
4771
|
},
|
|
4401
4772
|
{
|
|
@@ -4408,6 +4779,7 @@
|
|
|
4408
4779
|
"desc"
|
|
4409
4780
|
],
|
|
4410
4781
|
"default": "asc",
|
|
4782
|
+
"example": "desc",
|
|
4411
4783
|
"description": "Sort direction for institutions by name",
|
|
4412
4784
|
"alias": "s"
|
|
4413
4785
|
}
|
|
@@ -4443,6 +4815,7 @@
|
|
|
4443
4815
|
"in": "query",
|
|
4444
4816
|
"required": false,
|
|
4445
4817
|
"type": "string",
|
|
4818
|
+
"example": "1067983",
|
|
4446
4819
|
"description": "Institution CIK (at least one of cik or identifier required)"
|
|
4447
4820
|
},
|
|
4448
4821
|
{
|
|
@@ -4450,6 +4823,7 @@
|
|
|
4450
4823
|
"in": "query",
|
|
4451
4824
|
"required": false,
|
|
4452
4825
|
"type": "string",
|
|
4826
|
+
"example": "AAPL",
|
|
4453
4827
|
"description": "Company ticker symbol or CIK (at least one of cik or identifier required)",
|
|
4454
4828
|
"alias": "i"
|
|
4455
4829
|
},
|
|
@@ -4458,6 +4832,7 @@
|
|
|
4458
4832
|
"in": "query",
|
|
4459
4833
|
"required": false,
|
|
4460
4834
|
"type": "string",
|
|
4835
|
+
"example": "2025-01-01",
|
|
4461
4836
|
"description": "Filter transactions with period_end_new on or after this date (YYYY-MM-DD)"
|
|
4462
4837
|
},
|
|
4463
4838
|
{
|
|
@@ -4465,6 +4840,7 @@
|
|
|
4465
4840
|
"in": "query",
|
|
4466
4841
|
"required": false,
|
|
4467
4842
|
"type": "string",
|
|
4843
|
+
"example": "2025-12-31",
|
|
4468
4844
|
"description": "Filter transactions with period_end_new on or before this date (YYYY-MM-DD)"
|
|
4469
4845
|
},
|
|
4470
4846
|
{
|
|
@@ -4478,6 +4854,7 @@
|
|
|
4478
4854
|
"reduced",
|
|
4479
4855
|
"sold_out"
|
|
4480
4856
|
],
|
|
4857
|
+
"example": "new_buy",
|
|
4481
4858
|
"description": "Filter by transaction type: new_buy, added, reduced, sold_out"
|
|
4482
4859
|
},
|
|
4483
4860
|
{
|
|
@@ -4485,6 +4862,7 @@
|
|
|
4485
4862
|
"in": "query",
|
|
4486
4863
|
"required": false,
|
|
4487
4864
|
"type": "integer",
|
|
4865
|
+
"example": 2025,
|
|
4488
4866
|
"description": "Filter by calendar year (of new position)"
|
|
4489
4867
|
},
|
|
4490
4868
|
{
|
|
@@ -4492,6 +4870,7 @@
|
|
|
4492
4870
|
"in": "query",
|
|
4493
4871
|
"required": false,
|
|
4494
4872
|
"type": "integer",
|
|
4873
|
+
"example": 1,
|
|
4495
4874
|
"description": "Filter by calendar quarter (of new position)"
|
|
4496
4875
|
},
|
|
4497
4876
|
{
|
|
@@ -4504,6 +4883,7 @@
|
|
|
4504
4883
|
"desc"
|
|
4505
4884
|
],
|
|
4506
4885
|
"default": "desc",
|
|
4886
|
+
"example": "desc",
|
|
4507
4887
|
"description": "Sort direction by period_end_new: 'asc' (oldest first), 'desc' (newest first)",
|
|
4508
4888
|
"alias": "s"
|
|
4509
4889
|
},
|
|
@@ -4513,6 +4893,7 @@
|
|
|
4513
4893
|
"required": false,
|
|
4514
4894
|
"type": "integer",
|
|
4515
4895
|
"default": 100,
|
|
4896
|
+
"example": 5,
|
|
4516
4897
|
"description": "Maximum number of transactions to return (1-1000)",
|
|
4517
4898
|
"alias": "l"
|
|
4518
4899
|
},
|
|
@@ -4522,9 +4903,13 @@
|
|
|
4522
4903
|
"required": false,
|
|
4523
4904
|
"type": "integer",
|
|
4524
4905
|
"default": 0,
|
|
4906
|
+
"example": 0,
|
|
4525
4907
|
"description": "Number of transactions to skip for pagination"
|
|
4526
4908
|
}
|
|
4527
4909
|
],
|
|
4910
|
+
"exampleParams": [
|
|
4911
|
+
"cik"
|
|
4912
|
+
],
|
|
4528
4913
|
"view": "table",
|
|
4529
4914
|
"rowsPath": "transactions",
|
|
4530
4915
|
"columns": [
|
|
@@ -4572,6 +4957,7 @@
|
|
|
4572
4957
|
"in": "query",
|
|
4573
4958
|
"required": true,
|
|
4574
4959
|
"type": "string",
|
|
4960
|
+
"example": "AAPL",
|
|
4575
4961
|
"description": "Ticker symbol or CIK",
|
|
4576
4962
|
"alias": "i"
|
|
4577
4963
|
},
|
|
@@ -4586,6 +4972,7 @@
|
|
|
4586
4972
|
"ytd",
|
|
4587
4973
|
"ttm"
|
|
4588
4974
|
],
|
|
4975
|
+
"example": "annual",
|
|
4589
4976
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4590
4977
|
"alias": "p"
|
|
4591
4978
|
},
|
|
@@ -4603,6 +4990,7 @@
|
|
|
4603
4990
|
"seg_selling_and_marketing_expenses_business_segment",
|
|
4604
4991
|
"seg_general_and_administrative_expenses_business_segment"
|
|
4605
4992
|
],
|
|
4993
|
+
"example": "seg_revenue_product",
|
|
4606
4994
|
"description": "Filter by segment ID: seg_revenue_product, seg_revenue_geographic, seg_revenue_business_segment, seg_cost_of_revenue_business_segment, seg_research_and_development_expenses_business_segment, seg_selling_and_marketing_expenses_business_segment, seg_general_and_administrative_expenses_business_segment"
|
|
4607
4995
|
},
|
|
4608
4996
|
{
|
|
@@ -4615,6 +5003,7 @@
|
|
|
4615
5003
|
"desc"
|
|
4616
5004
|
],
|
|
4617
5005
|
"default": "desc",
|
|
5006
|
+
"example": "desc",
|
|
4618
5007
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4619
5008
|
"alias": "s"
|
|
4620
5009
|
},
|
|
@@ -4624,6 +5013,7 @@
|
|
|
4624
5013
|
"required": false,
|
|
4625
5014
|
"type": "integer",
|
|
4626
5015
|
"default": 10,
|
|
5016
|
+
"example": 5,
|
|
4627
5017
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4628
5018
|
"alias": "l"
|
|
4629
5019
|
},
|
|
@@ -4633,6 +5023,7 @@
|
|
|
4633
5023
|
"required": false,
|
|
4634
5024
|
"type": "integer",
|
|
4635
5025
|
"default": 0,
|
|
5026
|
+
"example": 0,
|
|
4636
5027
|
"description": "Number of periods to skip for pagination"
|
|
4637
5028
|
}
|
|
4638
5029
|
],
|
|
@@ -4656,6 +5047,7 @@
|
|
|
4656
5047
|
"in": "query",
|
|
4657
5048
|
"required": true,
|
|
4658
5049
|
"type": "string",
|
|
5050
|
+
"example": "AAPL",
|
|
4659
5051
|
"description": "Ticker symbol or CIK",
|
|
4660
5052
|
"alias": "i"
|
|
4661
5053
|
},
|
|
@@ -4670,6 +5062,7 @@
|
|
|
4670
5062
|
"ytd",
|
|
4671
5063
|
"ttm"
|
|
4672
5064
|
],
|
|
5065
|
+
"example": "annual",
|
|
4673
5066
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4674
5067
|
"alias": "p"
|
|
4675
5068
|
},
|
|
@@ -4687,6 +5080,7 @@
|
|
|
4687
5080
|
"seg_selling_and_marketing_expenses_business_segment",
|
|
4688
5081
|
"seg_general_and_administrative_expenses_business_segment"
|
|
4689
5082
|
],
|
|
5083
|
+
"example": "seg_revenue_product",
|
|
4690
5084
|
"description": "Filter by segment ID: seg_revenue_product, seg_revenue_geographic, seg_revenue_business_segment, seg_cost_of_revenue_business_segment, seg_research_and_development_expenses_business_segment, seg_selling_and_marketing_expenses_business_segment, seg_general_and_administrative_expenses_business_segment"
|
|
4691
5085
|
},
|
|
4692
5086
|
{
|
|
@@ -4699,6 +5093,7 @@
|
|
|
4699
5093
|
"desc"
|
|
4700
5094
|
],
|
|
4701
5095
|
"default": "desc",
|
|
5096
|
+
"example": "desc",
|
|
4702
5097
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4703
5098
|
"alias": "s"
|
|
4704
5099
|
},
|
|
@@ -4708,6 +5103,7 @@
|
|
|
4708
5103
|
"required": false,
|
|
4709
5104
|
"type": "integer",
|
|
4710
5105
|
"default": 10,
|
|
5106
|
+
"example": 5,
|
|
4711
5107
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4712
5108
|
"alias": "l"
|
|
4713
5109
|
},
|
|
@@ -4717,6 +5113,7 @@
|
|
|
4717
5113
|
"required": false,
|
|
4718
5114
|
"type": "integer",
|
|
4719
5115
|
"default": 0,
|
|
5116
|
+
"example": 0,
|
|
4720
5117
|
"description": "Number of periods to skip for pagination"
|
|
4721
5118
|
}
|
|
4722
5119
|
],
|
|
@@ -4778,6 +5175,7 @@
|
|
|
4778
5175
|
"90"
|
|
4779
5176
|
],
|
|
4780
5177
|
"default": 30,
|
|
5178
|
+
"example": 30,
|
|
4781
5179
|
"description": "Window in UTC days ending today (inclusive): 7, 30 or 90"
|
|
4782
5180
|
}
|
|
4783
5181
|
],
|
|
@@ -4804,7 +5202,20 @@
|
|
|
4804
5202
|
"params": [],
|
|
4805
5203
|
"body": {
|
|
4806
5204
|
"required": true,
|
|
4807
|
-
"contentType": "application/json"
|
|
5205
|
+
"contentType": "application/json",
|
|
5206
|
+
"example": {
|
|
5207
|
+
"url": "https://hooks.example.com/invinite",
|
|
5208
|
+
"events": [
|
|
5209
|
+
"earnings_call.transcript_ready",
|
|
5210
|
+
"earnings_call.ended"
|
|
5211
|
+
],
|
|
5212
|
+
"filters": {
|
|
5213
|
+
"ciks": [
|
|
5214
|
+
"0000789019",
|
|
5215
|
+
"0000320193"
|
|
5216
|
+
]
|
|
5217
|
+
}
|
|
5218
|
+
}
|
|
4808
5219
|
},
|
|
4809
5220
|
"view": "keyValue",
|
|
4810
5221
|
"columns": [
|
|
@@ -4835,6 +5246,7 @@
|
|
|
4835
5246
|
"in": "path",
|
|
4836
5247
|
"required": true,
|
|
4837
5248
|
"type": "string",
|
|
5249
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4838
5250
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4839
5251
|
}
|
|
4840
5252
|
],
|
|
@@ -4855,6 +5267,7 @@
|
|
|
4855
5267
|
"in": "path",
|
|
4856
5268
|
"required": true,
|
|
4857
5269
|
"type": "string",
|
|
5270
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4858
5271
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4859
5272
|
}
|
|
4860
5273
|
],
|
|
@@ -4910,6 +5323,7 @@
|
|
|
4910
5323
|
"in": "path",
|
|
4911
5324
|
"required": true,
|
|
4912
5325
|
"type": "string",
|
|
5326
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4913
5327
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4914
5328
|
}
|
|
4915
5329
|
],
|
|
@@ -4934,6 +5348,7 @@
|
|
|
4934
5348
|
"in": "path",
|
|
4935
5349
|
"required": true,
|
|
4936
5350
|
"type": "string",
|
|
5351
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4937
5352
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4938
5353
|
}
|
|
4939
5354
|
],
|
|
@@ -4958,12 +5373,19 @@
|
|
|
4958
5373
|
"in": "path",
|
|
4959
5374
|
"required": true,
|
|
4960
5375
|
"type": "string",
|
|
5376
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4961
5377
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4962
5378
|
}
|
|
4963
5379
|
],
|
|
4964
5380
|
"body": {
|
|
4965
5381
|
"required": false,
|
|
4966
|
-
"contentType": "application/json"
|
|
5382
|
+
"contentType": "application/json",
|
|
5383
|
+
"example": {
|
|
5384
|
+
"events": [
|
|
5385
|
+
"earnings_call.transcript_ready"
|
|
5386
|
+
],
|
|
5387
|
+
"active": true
|
|
5388
|
+
}
|
|
4967
5389
|
},
|
|
4968
5390
|
"view": "keyValue",
|
|
4969
5391
|
"columns": [
|