@invinite-org/invinite-data-cli 0.5.1 → 0.5.2
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/claude-plugin/skills/invinite-data-cli/SKILL.md +64 -64
- package/dist/src/generated/cli-manifest.json +424 -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 +44 -0
- 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": "1ede43bc2f7efe0a60e1891d063c0038638d0d0e1e967199a9c22ae4f4114e32",
|
|
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,10 +768,14 @@
|
|
|
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": [
|
|
@@ -752,6 +808,9 @@
|
|
|
752
808
|
"enum": [
|
|
753
809
|
"observations"
|
|
754
810
|
],
|
|
811
|
+
"example": [
|
|
812
|
+
"observations"
|
|
813
|
+
],
|
|
755
814
|
"description": "Extra data (repeatable): `observations` = the date / time observations behind the call time"
|
|
756
815
|
},
|
|
757
816
|
{
|
|
@@ -759,6 +818,7 @@
|
|
|
759
818
|
"in": "path",
|
|
760
819
|
"required": true,
|
|
761
820
|
"type": "string",
|
|
821
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
762
822
|
"description": "Event identifier (event_id of any earnings-calls response)"
|
|
763
823
|
}
|
|
764
824
|
],
|
|
@@ -803,6 +863,7 @@
|
|
|
803
863
|
"in": "query",
|
|
804
864
|
"required": true,
|
|
805
865
|
"type": "string",
|
|
866
|
+
"example": "MSFT",
|
|
806
867
|
"description": "Company ticker symbol or CIK (US companies only)",
|
|
807
868
|
"alias": "i"
|
|
808
869
|
},
|
|
@@ -811,6 +872,7 @@
|
|
|
811
872
|
"in": "query",
|
|
812
873
|
"required": false,
|
|
813
874
|
"type": "string",
|
|
875
|
+
"example": "2026-01-01",
|
|
814
876
|
"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
877
|
},
|
|
816
878
|
{
|
|
@@ -818,6 +880,7 @@
|
|
|
818
880
|
"in": "query",
|
|
819
881
|
"required": false,
|
|
820
882
|
"type": "string",
|
|
883
|
+
"example": "2026-09-30",
|
|
821
884
|
"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
885
|
},
|
|
823
886
|
{
|
|
@@ -829,6 +892,9 @@
|
|
|
829
892
|
"enum": [
|
|
830
893
|
"observations"
|
|
831
894
|
],
|
|
895
|
+
"example": [
|
|
896
|
+
"observations"
|
|
897
|
+
],
|
|
832
898
|
"description": "Extra data per event (repeatable): `observations` = the date / time observations"
|
|
833
899
|
},
|
|
834
900
|
{
|
|
@@ -837,6 +903,7 @@
|
|
|
837
903
|
"required": false,
|
|
838
904
|
"type": "string",
|
|
839
905
|
"default": "all",
|
|
906
|
+
"example": "earnings_call",
|
|
840
907
|
"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
908
|
},
|
|
842
909
|
{
|
|
@@ -849,6 +916,7 @@
|
|
|
849
916
|
"desc"
|
|
850
917
|
],
|
|
851
918
|
"default": "desc",
|
|
919
|
+
"example": "desc",
|
|
852
920
|
"description": "Sort direction by scheduled start",
|
|
853
921
|
"alias": "s"
|
|
854
922
|
},
|
|
@@ -858,6 +926,7 @@
|
|
|
858
926
|
"required": false,
|
|
859
927
|
"type": "integer",
|
|
860
928
|
"default": 50,
|
|
929
|
+
"example": 5,
|
|
861
930
|
"description": "Maximum number of events to return",
|
|
862
931
|
"alias": "l"
|
|
863
932
|
},
|
|
@@ -867,6 +936,7 @@
|
|
|
867
936
|
"required": false,
|
|
868
937
|
"type": "integer",
|
|
869
938
|
"default": 0,
|
|
939
|
+
"example": 0,
|
|
870
940
|
"description": "Number of events to skip for pagination"
|
|
871
941
|
}
|
|
872
942
|
],
|
|
@@ -907,6 +977,7 @@
|
|
|
907
977
|
"in": "query",
|
|
908
978
|
"required": false,
|
|
909
979
|
"type": "string",
|
|
980
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
910
981
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
911
982
|
},
|
|
912
983
|
{
|
|
@@ -914,6 +985,7 @@
|
|
|
914
985
|
"in": "query",
|
|
915
986
|
"required": false,
|
|
916
987
|
"type": "string",
|
|
988
|
+
"example": "MSFT",
|
|
917
989
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
918
990
|
"alias": "i"
|
|
919
991
|
},
|
|
@@ -922,6 +994,7 @@
|
|
|
922
994
|
"in": "query",
|
|
923
995
|
"required": false,
|
|
924
996
|
"type": "integer",
|
|
997
|
+
"example": 2026,
|
|
925
998
|
"description": "Fiscal year of the call (with quarter)"
|
|
926
999
|
},
|
|
927
1000
|
{
|
|
@@ -929,6 +1002,7 @@
|
|
|
929
1002
|
"in": "query",
|
|
930
1003
|
"required": false,
|
|
931
1004
|
"type": "integer",
|
|
1005
|
+
"example": 4,
|
|
932
1006
|
"description": "Fiscal quarter of the call (with year)"
|
|
933
1007
|
},
|
|
934
1008
|
{
|
|
@@ -936,6 +1010,7 @@
|
|
|
936
1010
|
"in": "query",
|
|
937
1011
|
"required": false,
|
|
938
1012
|
"type": "string",
|
|
1013
|
+
"example": "2026-07-29",
|
|
939
1014
|
"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
1015
|
},
|
|
941
1016
|
{
|
|
@@ -950,6 +1025,7 @@
|
|
|
950
1025
|
"agm",
|
|
951
1026
|
"other"
|
|
952
1027
|
],
|
|
1028
|
+
"example": "earnings_call",
|
|
953
1029
|
"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
1030
|
},
|
|
955
1031
|
{
|
|
@@ -962,6 +1038,7 @@
|
|
|
962
1038
|
"kpi"
|
|
963
1039
|
],
|
|
964
1040
|
"default": "guidance",
|
|
1041
|
+
"example": "guidance",
|
|
965
1042
|
"description": "guidance = consolidated forward guidance; kpi = every reported KPI figure"
|
|
966
1043
|
},
|
|
967
1044
|
{
|
|
@@ -975,6 +1052,7 @@
|
|
|
975
1052
|
"all"
|
|
976
1053
|
],
|
|
977
1054
|
"default": "all",
|
|
1055
|
+
"example": "all",
|
|
978
1056
|
"description": "Guidance review filter: approved (human-approved only), auto, or all (auto + needs_review + approved)"
|
|
979
1057
|
},
|
|
980
1058
|
{
|
|
@@ -983,6 +1061,7 @@
|
|
|
983
1061
|
"required": false,
|
|
984
1062
|
"type": "integer",
|
|
985
1063
|
"default": 200,
|
|
1064
|
+
"example": 5,
|
|
986
1065
|
"description": "Maximum number of items to return",
|
|
987
1066
|
"alias": "l"
|
|
988
1067
|
},
|
|
@@ -992,9 +1071,13 @@
|
|
|
992
1071
|
"required": false,
|
|
993
1072
|
"type": "integer",
|
|
994
1073
|
"default": 0,
|
|
1074
|
+
"example": 0,
|
|
995
1075
|
"description": "Number of items to skip for pagination"
|
|
996
1076
|
}
|
|
997
1077
|
],
|
|
1078
|
+
"exampleParams": [
|
|
1079
|
+
"event_id"
|
|
1080
|
+
],
|
|
998
1081
|
"view": "json",
|
|
999
1082
|
"pagination": "top",
|
|
1000
1083
|
"allItemsPath": [
|
|
@@ -1016,6 +1099,7 @@
|
|
|
1016
1099
|
"in": "query",
|
|
1017
1100
|
"required": true,
|
|
1018
1101
|
"type": "string",
|
|
1102
|
+
"example": "MSFT",
|
|
1019
1103
|
"description": "Company ticker symbol or CIK (US companies only)",
|
|
1020
1104
|
"alias": "i"
|
|
1021
1105
|
},
|
|
@@ -1024,6 +1108,7 @@
|
|
|
1024
1108
|
"in": "query",
|
|
1025
1109
|
"required": true,
|
|
1026
1110
|
"type": "string",
|
|
1111
|
+
"example": "revenue",
|
|
1027
1112
|
"description": "Normalized metric (e.g. revenue, eps_non_gaap, segment:iphone)"
|
|
1028
1113
|
},
|
|
1029
1114
|
{
|
|
@@ -1037,6 +1122,7 @@
|
|
|
1037
1122
|
"half",
|
|
1038
1123
|
"other"
|
|
1039
1124
|
],
|
|
1125
|
+
"example": "quarter",
|
|
1040
1126
|
"description": "Only this kind of guided period"
|
|
1041
1127
|
},
|
|
1042
1128
|
{
|
|
@@ -1049,6 +1135,7 @@
|
|
|
1049
1135
|
"non_gaap",
|
|
1050
1136
|
"unknown"
|
|
1051
1137
|
],
|
|
1138
|
+
"example": "gaap",
|
|
1052
1139
|
"description": "Only this accounting basis"
|
|
1053
1140
|
},
|
|
1054
1141
|
{
|
|
@@ -1057,6 +1144,7 @@
|
|
|
1057
1144
|
"required": false,
|
|
1058
1145
|
"type": "integer",
|
|
1059
1146
|
"default": 12,
|
|
1147
|
+
"example": 5,
|
|
1060
1148
|
"description": "Maximum number of series entries to return",
|
|
1061
1149
|
"alias": "l"
|
|
1062
1150
|
}
|
|
@@ -1120,6 +1208,7 @@
|
|
|
1120
1208
|
"in": "query",
|
|
1121
1209
|
"required": false,
|
|
1122
1210
|
"type": "string",
|
|
1211
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1123
1212
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1124
1213
|
},
|
|
1125
1214
|
{
|
|
@@ -1127,6 +1216,7 @@
|
|
|
1127
1216
|
"in": "query",
|
|
1128
1217
|
"required": false,
|
|
1129
1218
|
"type": "string",
|
|
1219
|
+
"example": "MSFT",
|
|
1130
1220
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1131
1221
|
"alias": "i"
|
|
1132
1222
|
},
|
|
@@ -1135,6 +1225,7 @@
|
|
|
1135
1225
|
"in": "query",
|
|
1136
1226
|
"required": false,
|
|
1137
1227
|
"type": "integer",
|
|
1228
|
+
"example": 2026,
|
|
1138
1229
|
"description": "Fiscal year of the call (with quarter)"
|
|
1139
1230
|
},
|
|
1140
1231
|
{
|
|
@@ -1142,6 +1233,7 @@
|
|
|
1142
1233
|
"in": "query",
|
|
1143
1234
|
"required": false,
|
|
1144
1235
|
"type": "integer",
|
|
1236
|
+
"example": 4,
|
|
1145
1237
|
"description": "Fiscal quarter of the call (with year)"
|
|
1146
1238
|
},
|
|
1147
1239
|
{
|
|
@@ -1149,6 +1241,7 @@
|
|
|
1149
1241
|
"in": "query",
|
|
1150
1242
|
"required": false,
|
|
1151
1243
|
"type": "string",
|
|
1244
|
+
"example": "2026-07-29",
|
|
1152
1245
|
"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
1246
|
},
|
|
1154
1247
|
{
|
|
@@ -1163,9 +1256,13 @@
|
|
|
1163
1256
|
"agm",
|
|
1164
1257
|
"other"
|
|
1165
1258
|
],
|
|
1259
|
+
"example": "earnings_call",
|
|
1166
1260
|
"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
1261
|
}
|
|
1168
1262
|
],
|
|
1263
|
+
"exampleParams": [
|
|
1264
|
+
"event_id"
|
|
1265
|
+
],
|
|
1169
1266
|
"view": "keyValue",
|
|
1170
1267
|
"columns": [
|
|
1171
1268
|
"event.symbol",
|
|
@@ -1200,6 +1297,7 @@
|
|
|
1200
1297
|
"in": "query",
|
|
1201
1298
|
"required": false,
|
|
1202
1299
|
"type": "string",
|
|
1300
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1203
1301
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1204
1302
|
},
|
|
1205
1303
|
{
|
|
@@ -1207,6 +1305,7 @@
|
|
|
1207
1305
|
"in": "query",
|
|
1208
1306
|
"required": false,
|
|
1209
1307
|
"type": "string",
|
|
1308
|
+
"example": "MSFT",
|
|
1210
1309
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1211
1310
|
"alias": "i"
|
|
1212
1311
|
},
|
|
@@ -1215,6 +1314,7 @@
|
|
|
1215
1314
|
"in": "query",
|
|
1216
1315
|
"required": false,
|
|
1217
1316
|
"type": "integer",
|
|
1317
|
+
"example": 2026,
|
|
1218
1318
|
"description": "Fiscal year of the call (with quarter)"
|
|
1219
1319
|
},
|
|
1220
1320
|
{
|
|
@@ -1222,6 +1322,7 @@
|
|
|
1222
1322
|
"in": "query",
|
|
1223
1323
|
"required": false,
|
|
1224
1324
|
"type": "integer",
|
|
1325
|
+
"example": 4,
|
|
1225
1326
|
"description": "Fiscal quarter of the call (with year)"
|
|
1226
1327
|
},
|
|
1227
1328
|
{
|
|
@@ -1229,6 +1330,7 @@
|
|
|
1229
1330
|
"in": "query",
|
|
1230
1331
|
"required": false,
|
|
1231
1332
|
"type": "string",
|
|
1333
|
+
"example": "2026-07-29",
|
|
1232
1334
|
"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
1335
|
},
|
|
1234
1336
|
{
|
|
@@ -1243,6 +1345,7 @@
|
|
|
1243
1345
|
"agm",
|
|
1244
1346
|
"other"
|
|
1245
1347
|
],
|
|
1348
|
+
"example": "earnings_call",
|
|
1246
1349
|
"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
1350
|
},
|
|
1248
1351
|
{
|
|
@@ -1254,9 +1357,15 @@
|
|
|
1254
1357
|
"enum": [
|
|
1255
1358
|
"evidence"
|
|
1256
1359
|
],
|
|
1360
|
+
"example": [
|
|
1361
|
+
"evidence"
|
|
1362
|
+
],
|
|
1257
1363
|
"description": "Extra data (repeatable): `evidence` = the quotes each name was resolved from"
|
|
1258
1364
|
}
|
|
1259
1365
|
],
|
|
1366
|
+
"exampleParams": [
|
|
1367
|
+
"event_id"
|
|
1368
|
+
],
|
|
1260
1369
|
"view": "table",
|
|
1261
1370
|
"rowsPath": "participants",
|
|
1262
1371
|
"columns": [
|
|
@@ -1286,6 +1395,7 @@
|
|
|
1286
1395
|
"required": false,
|
|
1287
1396
|
"type": "integer",
|
|
1288
1397
|
"default": 50,
|
|
1398
|
+
"example": 5,
|
|
1289
1399
|
"description": "Maximum number of appearances to return",
|
|
1290
1400
|
"alias": "l"
|
|
1291
1401
|
},
|
|
@@ -1295,6 +1405,7 @@
|
|
|
1295
1405
|
"required": false,
|
|
1296
1406
|
"type": "integer",
|
|
1297
1407
|
"default": 0,
|
|
1408
|
+
"example": 0,
|
|
1298
1409
|
"description": "Number of appearances to skip for pagination"
|
|
1299
1410
|
},
|
|
1300
1411
|
{
|
|
@@ -1302,6 +1413,7 @@
|
|
|
1302
1413
|
"in": "path",
|
|
1303
1414
|
"required": true,
|
|
1304
1415
|
"type": "string",
|
|
1416
|
+
"example": "9b135e05-d7c2-4d23-9c89-728501ad8e58",
|
|
1305
1417
|
"description": "Person identifier (person_id of participants / qa / analysts)"
|
|
1306
1418
|
}
|
|
1307
1419
|
],
|
|
@@ -1339,6 +1451,7 @@
|
|
|
1339
1451
|
"in": "query",
|
|
1340
1452
|
"required": false,
|
|
1341
1453
|
"type": "string",
|
|
1454
|
+
"example": "dd04abe1-f83f-4e92-8ddf-1f8864e7db30",
|
|
1342
1455
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1343
1456
|
},
|
|
1344
1457
|
{
|
|
@@ -1346,6 +1459,7 @@
|
|
|
1346
1459
|
"in": "query",
|
|
1347
1460
|
"required": false,
|
|
1348
1461
|
"type": "string",
|
|
1462
|
+
"example": "JPM",
|
|
1349
1463
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1350
1464
|
"alias": "i"
|
|
1351
1465
|
},
|
|
@@ -1354,6 +1468,7 @@
|
|
|
1354
1468
|
"in": "query",
|
|
1355
1469
|
"required": false,
|
|
1356
1470
|
"type": "integer",
|
|
1471
|
+
"example": 2026,
|
|
1357
1472
|
"description": "Fiscal year of the call (with quarter)"
|
|
1358
1473
|
},
|
|
1359
1474
|
{
|
|
@@ -1361,6 +1476,7 @@
|
|
|
1361
1476
|
"in": "query",
|
|
1362
1477
|
"required": false,
|
|
1363
1478
|
"type": "integer",
|
|
1479
|
+
"example": 3,
|
|
1364
1480
|
"description": "Fiscal quarter of the call (with year)"
|
|
1365
1481
|
},
|
|
1366
1482
|
{
|
|
@@ -1368,6 +1484,7 @@
|
|
|
1368
1484
|
"in": "query",
|
|
1369
1485
|
"required": false,
|
|
1370
1486
|
"type": "string",
|
|
1487
|
+
"example": "2026-10-13",
|
|
1371
1488
|
"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
1489
|
},
|
|
1373
1490
|
{
|
|
@@ -1382,9 +1499,13 @@
|
|
|
1382
1499
|
"agm",
|
|
1383
1500
|
"other"
|
|
1384
1501
|
],
|
|
1502
|
+
"example": "earnings_call",
|
|
1385
1503
|
"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
1504
|
}
|
|
1387
1505
|
],
|
|
1506
|
+
"exampleParams": [
|
|
1507
|
+
"event_id"
|
|
1508
|
+
],
|
|
1388
1509
|
"view": "json",
|
|
1389
1510
|
"pagination": "none"
|
|
1390
1511
|
},
|
|
@@ -1402,6 +1523,7 @@
|
|
|
1402
1523
|
"in": "query",
|
|
1403
1524
|
"required": false,
|
|
1404
1525
|
"type": "string",
|
|
1526
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1405
1527
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1406
1528
|
},
|
|
1407
1529
|
{
|
|
@@ -1409,6 +1531,7 @@
|
|
|
1409
1531
|
"in": "query",
|
|
1410
1532
|
"required": false,
|
|
1411
1533
|
"type": "string",
|
|
1534
|
+
"example": "MSFT",
|
|
1412
1535
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1413
1536
|
"alias": "i"
|
|
1414
1537
|
},
|
|
@@ -1417,6 +1540,7 @@
|
|
|
1417
1540
|
"in": "query",
|
|
1418
1541
|
"required": false,
|
|
1419
1542
|
"type": "integer",
|
|
1543
|
+
"example": 2026,
|
|
1420
1544
|
"description": "Fiscal year of the call (with quarter)"
|
|
1421
1545
|
},
|
|
1422
1546
|
{
|
|
@@ -1424,6 +1548,7 @@
|
|
|
1424
1548
|
"in": "query",
|
|
1425
1549
|
"required": false,
|
|
1426
1550
|
"type": "integer",
|
|
1551
|
+
"example": 4,
|
|
1427
1552
|
"description": "Fiscal quarter of the call (with year)"
|
|
1428
1553
|
},
|
|
1429
1554
|
{
|
|
@@ -1431,6 +1556,7 @@
|
|
|
1431
1556
|
"in": "query",
|
|
1432
1557
|
"required": false,
|
|
1433
1558
|
"type": "string",
|
|
1559
|
+
"example": "2026-07-29",
|
|
1434
1560
|
"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
1561
|
},
|
|
1436
1562
|
{
|
|
@@ -1445,6 +1571,7 @@
|
|
|
1445
1571
|
"agm",
|
|
1446
1572
|
"other"
|
|
1447
1573
|
],
|
|
1574
|
+
"example": "earnings_call",
|
|
1448
1575
|
"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
1576
|
},
|
|
1450
1577
|
{
|
|
@@ -1458,9 +1585,13 @@
|
|
|
1458
1585
|
"all"
|
|
1459
1586
|
],
|
|
1460
1587
|
"default": "all",
|
|
1588
|
+
"example": "qa",
|
|
1461
1589
|
"description": "prepared (remarks), qa, or all (the whole call)"
|
|
1462
1590
|
}
|
|
1463
1591
|
],
|
|
1592
|
+
"exampleParams": [
|
|
1593
|
+
"event_id"
|
|
1594
|
+
],
|
|
1464
1595
|
"view": "table",
|
|
1465
1596
|
"rowsPath": "speakers",
|
|
1466
1597
|
"columns": [
|
|
@@ -1494,6 +1625,7 @@
|
|
|
1494
1625
|
"in": "query",
|
|
1495
1626
|
"required": false,
|
|
1496
1627
|
"type": "string",
|
|
1628
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1497
1629
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1498
1630
|
},
|
|
1499
1631
|
{
|
|
@@ -1501,6 +1633,7 @@
|
|
|
1501
1633
|
"in": "query",
|
|
1502
1634
|
"required": false,
|
|
1503
1635
|
"type": "string",
|
|
1636
|
+
"example": "MSFT",
|
|
1504
1637
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1505
1638
|
"alias": "i"
|
|
1506
1639
|
},
|
|
@@ -1509,6 +1642,7 @@
|
|
|
1509
1642
|
"in": "query",
|
|
1510
1643
|
"required": false,
|
|
1511
1644
|
"type": "integer",
|
|
1645
|
+
"example": 2026,
|
|
1512
1646
|
"description": "Fiscal year of the call (with quarter)"
|
|
1513
1647
|
},
|
|
1514
1648
|
{
|
|
@@ -1516,6 +1650,7 @@
|
|
|
1516
1650
|
"in": "query",
|
|
1517
1651
|
"required": false,
|
|
1518
1652
|
"type": "integer",
|
|
1653
|
+
"example": 4,
|
|
1519
1654
|
"description": "Fiscal quarter of the call (with year)"
|
|
1520
1655
|
},
|
|
1521
1656
|
{
|
|
@@ -1523,6 +1658,7 @@
|
|
|
1523
1658
|
"in": "query",
|
|
1524
1659
|
"required": false,
|
|
1525
1660
|
"type": "string",
|
|
1661
|
+
"example": "2026-07-29",
|
|
1526
1662
|
"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
1663
|
},
|
|
1528
1664
|
{
|
|
@@ -1537,6 +1673,7 @@
|
|
|
1537
1673
|
"agm",
|
|
1538
1674
|
"other"
|
|
1539
1675
|
],
|
|
1676
|
+
"example": "earnings_call",
|
|
1540
1677
|
"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
1678
|
},
|
|
1542
1679
|
{
|
|
@@ -1545,6 +1682,7 @@
|
|
|
1545
1682
|
"required": false,
|
|
1546
1683
|
"type": "integer",
|
|
1547
1684
|
"default": 50,
|
|
1685
|
+
"example": 5,
|
|
1548
1686
|
"description": "Maximum number of Q&A pairs to return",
|
|
1549
1687
|
"alias": "l"
|
|
1550
1688
|
},
|
|
@@ -1554,6 +1692,7 @@
|
|
|
1554
1692
|
"required": false,
|
|
1555
1693
|
"type": "integer",
|
|
1556
1694
|
"default": 0,
|
|
1695
|
+
"example": 0,
|
|
1557
1696
|
"description": "Number of Q&A pairs to skip for pagination"
|
|
1558
1697
|
},
|
|
1559
1698
|
{
|
|
@@ -1564,9 +1703,13 @@
|
|
|
1564
1703
|
"enum": [
|
|
1565
1704
|
"scores"
|
|
1566
1705
|
],
|
|
1706
|
+
"example": "scores",
|
|
1567
1707
|
"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
1708
|
}
|
|
1569
1709
|
],
|
|
1710
|
+
"exampleParams": [
|
|
1711
|
+
"event_id"
|
|
1712
|
+
],
|
|
1570
1713
|
"view": "table",
|
|
1571
1714
|
"rowsPath": "pairs",
|
|
1572
1715
|
"columns": [
|
|
@@ -1597,6 +1740,7 @@
|
|
|
1597
1740
|
"in": "query",
|
|
1598
1741
|
"required": true,
|
|
1599
1742
|
"type": "string",
|
|
1743
|
+
"example": "Azure growth",
|
|
1600
1744
|
"description": "The question or phrase to search for",
|
|
1601
1745
|
"alias": "q"
|
|
1602
1746
|
},
|
|
@@ -1605,6 +1749,7 @@
|
|
|
1605
1749
|
"in": "query",
|
|
1606
1750
|
"required": false,
|
|
1607
1751
|
"type": "string",
|
|
1752
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1608
1753
|
"description": "Search one call"
|
|
1609
1754
|
},
|
|
1610
1755
|
{
|
|
@@ -1612,6 +1757,7 @@
|
|
|
1612
1757
|
"in": "query",
|
|
1613
1758
|
"required": false,
|
|
1614
1759
|
"type": "string",
|
|
1760
|
+
"example": "MSFT",
|
|
1615
1761
|
"description": "Search one company's calls (ticker or CIK, US only)",
|
|
1616
1762
|
"alias": "i"
|
|
1617
1763
|
},
|
|
@@ -1620,6 +1766,7 @@
|
|
|
1620
1766
|
"in": "query",
|
|
1621
1767
|
"required": false,
|
|
1622
1768
|
"type": "string",
|
|
1769
|
+
"example": "2026-07-01",
|
|
1623
1770
|
"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
1771
|
},
|
|
1625
1772
|
{
|
|
@@ -1627,6 +1774,7 @@
|
|
|
1627
1774
|
"in": "query",
|
|
1628
1775
|
"required": false,
|
|
1629
1776
|
"type": "string",
|
|
1777
|
+
"example": "2026-07-31",
|
|
1630
1778
|
"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
1779
|
},
|
|
1632
1780
|
{
|
|
@@ -1640,6 +1788,7 @@
|
|
|
1640
1788
|
"preparedRemarks",
|
|
1641
1789
|
"presentation"
|
|
1642
1790
|
],
|
|
1791
|
+
"example": "qa",
|
|
1643
1792
|
"description": "transcript (all speech), qa, preparedRemarks or presentation (slide text)"
|
|
1644
1793
|
},
|
|
1645
1794
|
{
|
|
@@ -1648,6 +1797,7 @@
|
|
|
1648
1797
|
"required": false,
|
|
1649
1798
|
"type": "string",
|
|
1650
1799
|
"default": "earnings_call",
|
|
1800
|
+
"example": "earnings_call",
|
|
1651
1801
|
"description": "Events searched, as a comma list of earnings_call, investor_day, conference, agm, other; `all` = every event type (default earnings calls)"
|
|
1652
1802
|
},
|
|
1653
1803
|
{
|
|
@@ -1656,10 +1806,14 @@
|
|
|
1656
1806
|
"required": false,
|
|
1657
1807
|
"type": "integer",
|
|
1658
1808
|
"default": 5,
|
|
1809
|
+
"example": 5,
|
|
1659
1810
|
"description": "Maximum number of passages (at most 8)",
|
|
1660
1811
|
"alias": "l"
|
|
1661
1812
|
}
|
|
1662
1813
|
],
|
|
1814
|
+
"exampleParams": [
|
|
1815
|
+
"identifier"
|
|
1816
|
+
],
|
|
1663
1817
|
"view": "table",
|
|
1664
1818
|
"rowsPath": "hits",
|
|
1665
1819
|
"columns": [
|
|
@@ -1688,6 +1842,7 @@
|
|
|
1688
1842
|
"in": "query",
|
|
1689
1843
|
"required": false,
|
|
1690
1844
|
"type": "string",
|
|
1845
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1691
1846
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1692
1847
|
},
|
|
1693
1848
|
{
|
|
@@ -1695,6 +1850,7 @@
|
|
|
1695
1850
|
"in": "query",
|
|
1696
1851
|
"required": false,
|
|
1697
1852
|
"type": "string",
|
|
1853
|
+
"example": "MSFT",
|
|
1698
1854
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1699
1855
|
"alias": "i"
|
|
1700
1856
|
},
|
|
@@ -1703,6 +1859,7 @@
|
|
|
1703
1859
|
"in": "query",
|
|
1704
1860
|
"required": false,
|
|
1705
1861
|
"type": "integer",
|
|
1862
|
+
"example": 2026,
|
|
1706
1863
|
"description": "Fiscal year of the call (with quarter)"
|
|
1707
1864
|
},
|
|
1708
1865
|
{
|
|
@@ -1710,6 +1867,7 @@
|
|
|
1710
1867
|
"in": "query",
|
|
1711
1868
|
"required": false,
|
|
1712
1869
|
"type": "integer",
|
|
1870
|
+
"example": 4,
|
|
1713
1871
|
"description": "Fiscal quarter of the call (with year)"
|
|
1714
1872
|
},
|
|
1715
1873
|
{
|
|
@@ -1717,6 +1875,7 @@
|
|
|
1717
1875
|
"in": "query",
|
|
1718
1876
|
"required": false,
|
|
1719
1877
|
"type": "string",
|
|
1878
|
+
"example": "2026-07-29",
|
|
1720
1879
|
"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
1880
|
},
|
|
1722
1881
|
{
|
|
@@ -1731,9 +1890,13 @@
|
|
|
1731
1890
|
"agm",
|
|
1732
1891
|
"other"
|
|
1733
1892
|
],
|
|
1893
|
+
"example": "earnings_call",
|
|
1734
1894
|
"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
1895
|
}
|
|
1736
1896
|
],
|
|
1897
|
+
"exampleParams": [
|
|
1898
|
+
"event_id"
|
|
1899
|
+
],
|
|
1737
1900
|
"view": "keyValue",
|
|
1738
1901
|
"columns": [
|
|
1739
1902
|
"event.symbol",
|
|
@@ -1761,6 +1924,7 @@
|
|
|
1761
1924
|
"in": "query",
|
|
1762
1925
|
"required": false,
|
|
1763
1926
|
"type": "string",
|
|
1927
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1764
1928
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1765
1929
|
},
|
|
1766
1930
|
{
|
|
@@ -1768,6 +1932,7 @@
|
|
|
1768
1932
|
"in": "query",
|
|
1769
1933
|
"required": false,
|
|
1770
1934
|
"type": "string",
|
|
1935
|
+
"example": "MSFT",
|
|
1771
1936
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1772
1937
|
"alias": "i"
|
|
1773
1938
|
},
|
|
@@ -1776,6 +1941,7 @@
|
|
|
1776
1941
|
"in": "query",
|
|
1777
1942
|
"required": false,
|
|
1778
1943
|
"type": "integer",
|
|
1944
|
+
"example": 2026,
|
|
1779
1945
|
"description": "Fiscal year of the call (with quarter)"
|
|
1780
1946
|
},
|
|
1781
1947
|
{
|
|
@@ -1783,6 +1949,7 @@
|
|
|
1783
1949
|
"in": "query",
|
|
1784
1950
|
"required": false,
|
|
1785
1951
|
"type": "integer",
|
|
1952
|
+
"example": 4,
|
|
1786
1953
|
"description": "Fiscal quarter of the call (with year)"
|
|
1787
1954
|
},
|
|
1788
1955
|
{
|
|
@@ -1790,6 +1957,7 @@
|
|
|
1790
1957
|
"in": "query",
|
|
1791
1958
|
"required": false,
|
|
1792
1959
|
"type": "string",
|
|
1960
|
+
"example": "2026-07-29",
|
|
1793
1961
|
"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
1962
|
},
|
|
1795
1963
|
{
|
|
@@ -1804,6 +1972,7 @@
|
|
|
1804
1972
|
"agm",
|
|
1805
1973
|
"other"
|
|
1806
1974
|
],
|
|
1975
|
+
"example": "earnings_call",
|
|
1807
1976
|
"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
1977
|
},
|
|
1809
1978
|
{
|
|
@@ -1811,6 +1980,7 @@
|
|
|
1811
1980
|
"in": "query",
|
|
1812
1981
|
"required": true,
|
|
1813
1982
|
"type": "integer",
|
|
1983
|
+
"example": 3,
|
|
1814
1984
|
"description": "Older version (one listed by transcript/versions)"
|
|
1815
1985
|
},
|
|
1816
1986
|
{
|
|
@@ -1818,9 +1988,13 @@
|
|
|
1818
1988
|
"in": "query",
|
|
1819
1989
|
"required": false,
|
|
1820
1990
|
"type": "integer",
|
|
1991
|
+
"example": 6,
|
|
1821
1992
|
"description": "Newer version; default = the current one"
|
|
1822
1993
|
}
|
|
1823
1994
|
],
|
|
1995
|
+
"exampleParams": [
|
|
1996
|
+
"event_id"
|
|
1997
|
+
],
|
|
1824
1998
|
"view": "table",
|
|
1825
1999
|
"rowsPath": "changes",
|
|
1826
2000
|
"columns": [
|
|
@@ -1844,6 +2018,7 @@
|
|
|
1844
2018
|
"in": "query",
|
|
1845
2019
|
"required": false,
|
|
1846
2020
|
"type": "string",
|
|
2021
|
+
"example": "cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c",
|
|
1847
2022
|
"description": "Event identifier (event_id of any earnings-calls response); wins over the other selectors"
|
|
1848
2023
|
},
|
|
1849
2024
|
{
|
|
@@ -1851,6 +2026,7 @@
|
|
|
1851
2026
|
"in": "query",
|
|
1852
2027
|
"required": false,
|
|
1853
2028
|
"type": "string",
|
|
2029
|
+
"example": "MSFT",
|
|
1854
2030
|
"description": "Company ticker symbol or CIK (US companies only), with year+quarter or date",
|
|
1855
2031
|
"alias": "i"
|
|
1856
2032
|
},
|
|
@@ -1859,6 +2035,7 @@
|
|
|
1859
2035
|
"in": "query",
|
|
1860
2036
|
"required": false,
|
|
1861
2037
|
"type": "integer",
|
|
2038
|
+
"example": 2026,
|
|
1862
2039
|
"description": "Fiscal year of the call (with quarter)"
|
|
1863
2040
|
},
|
|
1864
2041
|
{
|
|
@@ -1866,6 +2043,7 @@
|
|
|
1866
2043
|
"in": "query",
|
|
1867
2044
|
"required": false,
|
|
1868
2045
|
"type": "integer",
|
|
2046
|
+
"example": 4,
|
|
1869
2047
|
"description": "Fiscal quarter of the call (with year)"
|
|
1870
2048
|
},
|
|
1871
2049
|
{
|
|
@@ -1873,6 +2051,7 @@
|
|
|
1873
2051
|
"in": "query",
|
|
1874
2052
|
"required": false,
|
|
1875
2053
|
"type": "string",
|
|
2054
|
+
"example": "2026-07-29",
|
|
1876
2055
|
"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
2056
|
},
|
|
1878
2057
|
{
|
|
@@ -1887,9 +2066,13 @@
|
|
|
1887
2066
|
"agm",
|
|
1888
2067
|
"other"
|
|
1889
2068
|
],
|
|
2069
|
+
"example": "earnings_call",
|
|
1890
2070
|
"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
2071
|
}
|
|
1892
2072
|
],
|
|
2073
|
+
"exampleParams": [
|
|
2074
|
+
"event_id"
|
|
2075
|
+
],
|
|
1893
2076
|
"view": "table",
|
|
1894
2077
|
"rowsPath": "versions",
|
|
1895
2078
|
"columns": [
|
|
@@ -1916,6 +2099,7 @@
|
|
|
1916
2099
|
"in": "query",
|
|
1917
2100
|
"required": false,
|
|
1918
2101
|
"type": "string",
|
|
2102
|
+
"example": "AAPL",
|
|
1919
2103
|
"description": "Optional ticker symbol or CIK. If omitted, returns form types across all filings.",
|
|
1920
2104
|
"alias": "i"
|
|
1921
2105
|
}
|
|
@@ -1937,6 +2121,7 @@
|
|
|
1937
2121
|
"in": "query",
|
|
1938
2122
|
"required": true,
|
|
1939
2123
|
"type": "string",
|
|
2124
|
+
"example": "AAPL",
|
|
1940
2125
|
"description": "Ticker symbol or CIK",
|
|
1941
2126
|
"alias": "i"
|
|
1942
2127
|
},
|
|
@@ -1945,6 +2130,7 @@
|
|
|
1945
2130
|
"in": "query",
|
|
1946
2131
|
"required": false,
|
|
1947
2132
|
"type": "string",
|
|
2133
|
+
"example": "10-K",
|
|
1948
2134
|
"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
2135
|
},
|
|
1950
2136
|
{
|
|
@@ -1957,6 +2143,7 @@
|
|
|
1957
2143
|
"desc"
|
|
1958
2144
|
],
|
|
1959
2145
|
"default": "desc",
|
|
2146
|
+
"example": "desc",
|
|
1960
2147
|
"description": "Sort direction for filings by filing_date",
|
|
1961
2148
|
"alias": "s"
|
|
1962
2149
|
},
|
|
@@ -1966,6 +2153,7 @@
|
|
|
1966
2153
|
"required": false,
|
|
1967
2154
|
"type": "integer",
|
|
1968
2155
|
"default": 40,
|
|
2156
|
+
"example": 5,
|
|
1969
2157
|
"description": "Maximum number of filings to return",
|
|
1970
2158
|
"alias": "l"
|
|
1971
2159
|
},
|
|
@@ -1975,6 +2163,7 @@
|
|
|
1975
2163
|
"required": false,
|
|
1976
2164
|
"type": "integer",
|
|
1977
2165
|
"default": 0,
|
|
2166
|
+
"example": 0,
|
|
1978
2167
|
"description": "Number of filings to skip for pagination"
|
|
1979
2168
|
}
|
|
1980
2169
|
],
|
|
@@ -2010,6 +2199,7 @@
|
|
|
2010
2199
|
"in": "query",
|
|
2011
2200
|
"required": true,
|
|
2012
2201
|
"type": "string",
|
|
2202
|
+
"example": "What are Apple's main risk factors?",
|
|
2013
2203
|
"description": "Natural language search request for SEC filing information (e.g., 'What are Apple's main risk factors?')",
|
|
2014
2204
|
"alias": "r"
|
|
2015
2205
|
},
|
|
@@ -2018,6 +2208,7 @@
|
|
|
2018
2208
|
"in": "query",
|
|
2019
2209
|
"required": false,
|
|
2020
2210
|
"type": "string",
|
|
2211
|
+
"example": "AAPL",
|
|
2021
2212
|
"description": "Ticker symbol or CIK to filter search results to a specific company",
|
|
2022
2213
|
"alias": "i"
|
|
2023
2214
|
},
|
|
@@ -2026,9 +2217,13 @@
|
|
|
2026
2217
|
"in": "query",
|
|
2027
2218
|
"required": false,
|
|
2028
2219
|
"type": "string",
|
|
2220
|
+
"example": "0000320193-25-000079",
|
|
2029
2221
|
"description": "Accession number to filter search results to a specific filing"
|
|
2030
2222
|
}
|
|
2031
2223
|
],
|
|
2224
|
+
"exampleParams": [
|
|
2225
|
+
"identifier"
|
|
2226
|
+
],
|
|
2032
2227
|
"view": "json",
|
|
2033
2228
|
"pagination": "none"
|
|
2034
2229
|
},
|
|
@@ -2046,6 +2241,7 @@
|
|
|
2046
2241
|
"in": "query",
|
|
2047
2242
|
"required": true,
|
|
2048
2243
|
"type": "string",
|
|
2244
|
+
"example": "AAPL",
|
|
2049
2245
|
"description": "Ticker symbol or CIK",
|
|
2050
2246
|
"alias": "i"
|
|
2051
2247
|
},
|
|
@@ -2059,6 +2255,7 @@
|
|
|
2059
2255
|
"10-K",
|
|
2060
2256
|
"8-K"
|
|
2061
2257
|
],
|
|
2258
|
+
"example": "10-K",
|
|
2062
2259
|
"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
2260
|
},
|
|
2064
2261
|
{
|
|
@@ -2066,6 +2263,7 @@
|
|
|
2066
2263
|
"in": "query",
|
|
2067
2264
|
"required": false,
|
|
2068
2265
|
"type": "string",
|
|
2266
|
+
"example": "part_i-item_1a",
|
|
2069
2267
|
"description": "Optional section ID. If not specified, all sections from the filing are returned."
|
|
2070
2268
|
},
|
|
2071
2269
|
{
|
|
@@ -2073,6 +2271,7 @@
|
|
|
2073
2271
|
"in": "query",
|
|
2074
2272
|
"required": false,
|
|
2075
2273
|
"type": "string",
|
|
2274
|
+
"example": "0000320193-25-000079",
|
|
2076
2275
|
"description": "SEC accession number of the filing"
|
|
2077
2276
|
},
|
|
2078
2277
|
{
|
|
@@ -2080,6 +2279,7 @@
|
|
|
2080
2279
|
"in": "query",
|
|
2081
2280
|
"required": false,
|
|
2082
2281
|
"type": "integer",
|
|
2282
|
+
"example": 2025,
|
|
2083
2283
|
"description": "Fiscal year"
|
|
2084
2284
|
},
|
|
2085
2285
|
{
|
|
@@ -2087,9 +2287,13 @@
|
|
|
2087
2287
|
"in": "query",
|
|
2088
2288
|
"required": false,
|
|
2089
2289
|
"type": "integer",
|
|
2290
|
+
"example": 4,
|
|
2090
2291
|
"description": "Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter."
|
|
2091
2292
|
}
|
|
2092
2293
|
],
|
|
2294
|
+
"exampleParams": [
|
|
2295
|
+
"fiscal_year"
|
|
2296
|
+
],
|
|
2093
2297
|
"view": "json",
|
|
2094
2298
|
"pagination": "none"
|
|
2095
2299
|
},
|
|
@@ -2107,6 +2311,7 @@
|
|
|
2107
2311
|
"in": "query",
|
|
2108
2312
|
"required": true,
|
|
2109
2313
|
"type": "string",
|
|
2314
|
+
"example": "AAPL",
|
|
2110
2315
|
"description": "Ticker symbol or CIK",
|
|
2111
2316
|
"alias": "i"
|
|
2112
2317
|
},
|
|
@@ -2121,6 +2326,7 @@
|
|
|
2121
2326
|
"ytd",
|
|
2122
2327
|
"ttm"
|
|
2123
2328
|
],
|
|
2329
|
+
"example": "annual",
|
|
2124
2330
|
"description": "Type of fiscal period",
|
|
2125
2331
|
"alias": "p"
|
|
2126
2332
|
},
|
|
@@ -2134,6 +2340,7 @@
|
|
|
2134
2340
|
"desc"
|
|
2135
2341
|
],
|
|
2136
2342
|
"default": "desc",
|
|
2343
|
+
"example": "desc",
|
|
2137
2344
|
"description": "Sort direction for periods by period_end",
|
|
2138
2345
|
"alias": "s"
|
|
2139
2346
|
},
|
|
@@ -2143,6 +2350,7 @@
|
|
|
2143
2350
|
"required": false,
|
|
2144
2351
|
"type": "integer",
|
|
2145
2352
|
"default": 10,
|
|
2353
|
+
"example": 5,
|
|
2146
2354
|
"description": "Maximum number of periods per ticker",
|
|
2147
2355
|
"alias": "l"
|
|
2148
2356
|
},
|
|
@@ -2152,6 +2360,7 @@
|
|
|
2152
2360
|
"required": false,
|
|
2153
2361
|
"type": "integer",
|
|
2154
2362
|
"default": 0,
|
|
2363
|
+
"example": 0,
|
|
2155
2364
|
"description": "Number of periods to skip for pagination"
|
|
2156
2365
|
}
|
|
2157
2366
|
],
|
|
@@ -2175,6 +2384,7 @@
|
|
|
2175
2384
|
"in": "query",
|
|
2176
2385
|
"required": true,
|
|
2177
2386
|
"type": "string",
|
|
2387
|
+
"example": "AAPL",
|
|
2178
2388
|
"description": "Ticker symbol or CIK",
|
|
2179
2389
|
"alias": "i"
|
|
2180
2390
|
},
|
|
@@ -2189,6 +2399,7 @@
|
|
|
2189
2399
|
"ytd",
|
|
2190
2400
|
"ttm"
|
|
2191
2401
|
],
|
|
2402
|
+
"example": "annual",
|
|
2192
2403
|
"description": "Type of fiscal period",
|
|
2193
2404
|
"alias": "p"
|
|
2194
2405
|
},
|
|
@@ -2202,6 +2413,7 @@
|
|
|
2202
2413
|
"desc"
|
|
2203
2414
|
],
|
|
2204
2415
|
"default": "desc",
|
|
2416
|
+
"example": "desc",
|
|
2205
2417
|
"description": "Sort direction for periods by period_end",
|
|
2206
2418
|
"alias": "s"
|
|
2207
2419
|
},
|
|
@@ -2211,6 +2423,7 @@
|
|
|
2211
2423
|
"required": false,
|
|
2212
2424
|
"type": "integer",
|
|
2213
2425
|
"default": 10,
|
|
2426
|
+
"example": 5,
|
|
2214
2427
|
"description": "Maximum number of periods per ticker",
|
|
2215
2428
|
"alias": "l"
|
|
2216
2429
|
},
|
|
@@ -2220,6 +2433,7 @@
|
|
|
2220
2433
|
"required": false,
|
|
2221
2434
|
"type": "integer",
|
|
2222
2435
|
"default": 0,
|
|
2436
|
+
"example": 0,
|
|
2223
2437
|
"description": "Number of periods to skip for pagination"
|
|
2224
2438
|
},
|
|
2225
2439
|
{
|
|
@@ -2232,6 +2446,7 @@
|
|
|
2232
2446
|
"false"
|
|
2233
2447
|
],
|
|
2234
2448
|
"default": "false",
|
|
2449
|
+
"example": "true",
|
|
2235
2450
|
"description": "Include formula in response"
|
|
2236
2451
|
}
|
|
2237
2452
|
],
|
|
@@ -2255,6 +2470,7 @@
|
|
|
2255
2470
|
"in": "query",
|
|
2256
2471
|
"required": true,
|
|
2257
2472
|
"type": "string",
|
|
2473
|
+
"example": "AAPL",
|
|
2258
2474
|
"description": "Ticker symbol or CIK",
|
|
2259
2475
|
"alias": "i"
|
|
2260
2476
|
},
|
|
@@ -2269,6 +2485,7 @@
|
|
|
2269
2485
|
"ytd",
|
|
2270
2486
|
"ttm"
|
|
2271
2487
|
],
|
|
2488
|
+
"example": "annual",
|
|
2272
2489
|
"description": "Type of fiscal period",
|
|
2273
2490
|
"alias": "p"
|
|
2274
2491
|
},
|
|
@@ -2282,6 +2499,7 @@
|
|
|
2282
2499
|
"desc"
|
|
2283
2500
|
],
|
|
2284
2501
|
"default": "desc",
|
|
2502
|
+
"example": "desc",
|
|
2285
2503
|
"description": "Sort direction for periods by period_end",
|
|
2286
2504
|
"alias": "s"
|
|
2287
2505
|
},
|
|
@@ -2291,6 +2509,7 @@
|
|
|
2291
2509
|
"required": false,
|
|
2292
2510
|
"type": "integer",
|
|
2293
2511
|
"default": 10,
|
|
2512
|
+
"example": 5,
|
|
2294
2513
|
"description": "Maximum number of periods per ticker",
|
|
2295
2514
|
"alias": "l"
|
|
2296
2515
|
},
|
|
@@ -2300,6 +2519,7 @@
|
|
|
2300
2519
|
"required": false,
|
|
2301
2520
|
"type": "integer",
|
|
2302
2521
|
"default": 0,
|
|
2522
|
+
"example": 0,
|
|
2303
2523
|
"description": "Number of periods to skip for pagination"
|
|
2304
2524
|
}
|
|
2305
2525
|
],
|
|
@@ -2323,6 +2543,7 @@
|
|
|
2323
2543
|
"in": "query",
|
|
2324
2544
|
"required": true,
|
|
2325
2545
|
"type": "string",
|
|
2546
|
+
"example": "AAPL",
|
|
2326
2547
|
"description": "Ticker symbol or CIK",
|
|
2327
2548
|
"alias": "i"
|
|
2328
2549
|
},
|
|
@@ -2337,6 +2558,7 @@
|
|
|
2337
2558
|
"ytd",
|
|
2338
2559
|
"ttm"
|
|
2339
2560
|
],
|
|
2561
|
+
"example": "annual",
|
|
2340
2562
|
"description": "Type of fiscal period",
|
|
2341
2563
|
"alias": "p"
|
|
2342
2564
|
},
|
|
@@ -2350,6 +2572,7 @@
|
|
|
2350
2572
|
"desc"
|
|
2351
2573
|
],
|
|
2352
2574
|
"default": "desc",
|
|
2575
|
+
"example": "desc",
|
|
2353
2576
|
"description": "Sort direction for periods by period_end",
|
|
2354
2577
|
"alias": "s"
|
|
2355
2578
|
},
|
|
@@ -2359,6 +2582,7 @@
|
|
|
2359
2582
|
"required": false,
|
|
2360
2583
|
"type": "integer",
|
|
2361
2584
|
"default": 10,
|
|
2585
|
+
"example": 5,
|
|
2362
2586
|
"description": "Maximum number of periods per ticker",
|
|
2363
2587
|
"alias": "l"
|
|
2364
2588
|
},
|
|
@@ -2368,6 +2592,7 @@
|
|
|
2368
2592
|
"required": false,
|
|
2369
2593
|
"type": "integer",
|
|
2370
2594
|
"default": 0,
|
|
2595
|
+
"example": 0,
|
|
2371
2596
|
"description": "Number of periods to skip for pagination"
|
|
2372
2597
|
}
|
|
2373
2598
|
],
|
|
@@ -2391,6 +2616,7 @@
|
|
|
2391
2616
|
"in": "query",
|
|
2392
2617
|
"required": true,
|
|
2393
2618
|
"type": "string",
|
|
2619
|
+
"example": "AAPL",
|
|
2394
2620
|
"description": "Ticker symbol or CIK",
|
|
2395
2621
|
"alias": "i"
|
|
2396
2622
|
},
|
|
@@ -2405,6 +2631,7 @@
|
|
|
2405
2631
|
"ytd",
|
|
2406
2632
|
"ttm"
|
|
2407
2633
|
],
|
|
2634
|
+
"example": "annual",
|
|
2408
2635
|
"description": "Type of fiscal period",
|
|
2409
2636
|
"alias": "p"
|
|
2410
2637
|
},
|
|
@@ -2418,6 +2645,7 @@
|
|
|
2418
2645
|
"desc"
|
|
2419
2646
|
],
|
|
2420
2647
|
"default": "desc",
|
|
2648
|
+
"example": "desc",
|
|
2421
2649
|
"description": "Sort direction for periods by period_end",
|
|
2422
2650
|
"alias": "s"
|
|
2423
2651
|
},
|
|
@@ -2427,6 +2655,7 @@
|
|
|
2427
2655
|
"required": false,
|
|
2428
2656
|
"type": "integer",
|
|
2429
2657
|
"default": 10,
|
|
2658
|
+
"example": 5,
|
|
2430
2659
|
"description": "Maximum number of periods per ticker",
|
|
2431
2660
|
"alias": "l"
|
|
2432
2661
|
},
|
|
@@ -2436,6 +2665,7 @@
|
|
|
2436
2665
|
"required": false,
|
|
2437
2666
|
"type": "integer",
|
|
2438
2667
|
"default": 0,
|
|
2668
|
+
"example": 0,
|
|
2439
2669
|
"description": "Number of periods to skip for pagination"
|
|
2440
2670
|
},
|
|
2441
2671
|
{
|
|
@@ -2448,6 +2678,7 @@
|
|
|
2448
2678
|
"false"
|
|
2449
2679
|
],
|
|
2450
2680
|
"default": "false",
|
|
2681
|
+
"example": "true",
|
|
2451
2682
|
"description": "Include formula in response"
|
|
2452
2683
|
}
|
|
2453
2684
|
],
|
|
@@ -2471,6 +2702,7 @@
|
|
|
2471
2702
|
"in": "query",
|
|
2472
2703
|
"required": true,
|
|
2473
2704
|
"type": "string",
|
|
2705
|
+
"example": "AAPL",
|
|
2474
2706
|
"description": "Ticker symbol or CIK",
|
|
2475
2707
|
"alias": "i"
|
|
2476
2708
|
},
|
|
@@ -2485,6 +2717,7 @@
|
|
|
2485
2717
|
"ytd",
|
|
2486
2718
|
"ttm"
|
|
2487
2719
|
],
|
|
2720
|
+
"example": "annual",
|
|
2488
2721
|
"description": "Type of fiscal period",
|
|
2489
2722
|
"alias": "p"
|
|
2490
2723
|
},
|
|
@@ -2498,6 +2731,7 @@
|
|
|
2498
2731
|
"desc"
|
|
2499
2732
|
],
|
|
2500
2733
|
"default": "desc",
|
|
2734
|
+
"example": "desc",
|
|
2501
2735
|
"description": "Sort direction for periods by period_end",
|
|
2502
2736
|
"alias": "s"
|
|
2503
2737
|
},
|
|
@@ -2507,6 +2741,7 @@
|
|
|
2507
2741
|
"required": false,
|
|
2508
2742
|
"type": "integer",
|
|
2509
2743
|
"default": 10,
|
|
2744
|
+
"example": 5,
|
|
2510
2745
|
"description": "Maximum number of periods per ticker",
|
|
2511
2746
|
"alias": "l"
|
|
2512
2747
|
},
|
|
@@ -2516,6 +2751,7 @@
|
|
|
2516
2751
|
"required": false,
|
|
2517
2752
|
"type": "integer",
|
|
2518
2753
|
"default": 0,
|
|
2754
|
+
"example": 0,
|
|
2519
2755
|
"description": "Number of periods to skip for pagination"
|
|
2520
2756
|
}
|
|
2521
2757
|
],
|
|
@@ -2539,6 +2775,7 @@
|
|
|
2539
2775
|
"in": "query",
|
|
2540
2776
|
"required": true,
|
|
2541
2777
|
"type": "string",
|
|
2778
|
+
"example": "AAPL",
|
|
2542
2779
|
"description": "Ticker symbol or CIK",
|
|
2543
2780
|
"alias": "i"
|
|
2544
2781
|
},
|
|
@@ -2553,6 +2790,7 @@
|
|
|
2553
2790
|
"ytd",
|
|
2554
2791
|
"ttm"
|
|
2555
2792
|
],
|
|
2793
|
+
"example": "annual",
|
|
2556
2794
|
"description": "Type of fiscal period",
|
|
2557
2795
|
"alias": "p"
|
|
2558
2796
|
},
|
|
@@ -2566,6 +2804,7 @@
|
|
|
2566
2804
|
"desc"
|
|
2567
2805
|
],
|
|
2568
2806
|
"default": "desc",
|
|
2807
|
+
"example": "desc",
|
|
2569
2808
|
"description": "Sort direction for periods by period_end",
|
|
2570
2809
|
"alias": "s"
|
|
2571
2810
|
},
|
|
@@ -2575,6 +2814,7 @@
|
|
|
2575
2814
|
"required": false,
|
|
2576
2815
|
"type": "integer",
|
|
2577
2816
|
"default": 10,
|
|
2817
|
+
"example": 5,
|
|
2578
2818
|
"description": "Maximum number of periods per ticker",
|
|
2579
2819
|
"alias": "l"
|
|
2580
2820
|
},
|
|
@@ -2584,6 +2824,7 @@
|
|
|
2584
2824
|
"required": false,
|
|
2585
2825
|
"type": "integer",
|
|
2586
2826
|
"default": 0,
|
|
2827
|
+
"example": 0,
|
|
2587
2828
|
"description": "Number of periods to skip for pagination"
|
|
2588
2829
|
}
|
|
2589
2830
|
],
|
|
@@ -2607,6 +2848,7 @@
|
|
|
2607
2848
|
"in": "query",
|
|
2608
2849
|
"required": true,
|
|
2609
2850
|
"type": "string",
|
|
2851
|
+
"example": "AAPL",
|
|
2610
2852
|
"description": "Ticker symbol or CIK",
|
|
2611
2853
|
"alias": "i"
|
|
2612
2854
|
},
|
|
@@ -2621,6 +2863,7 @@
|
|
|
2621
2863
|
"ytd",
|
|
2622
2864
|
"ttm"
|
|
2623
2865
|
],
|
|
2866
|
+
"example": "annual",
|
|
2624
2867
|
"description": "Type of fiscal period",
|
|
2625
2868
|
"alias": "p"
|
|
2626
2869
|
},
|
|
@@ -2634,6 +2877,7 @@
|
|
|
2634
2877
|
"desc"
|
|
2635
2878
|
],
|
|
2636
2879
|
"default": "desc",
|
|
2880
|
+
"example": "desc",
|
|
2637
2881
|
"description": "Sort direction for periods by period_end",
|
|
2638
2882
|
"alias": "s"
|
|
2639
2883
|
},
|
|
@@ -2643,6 +2887,7 @@
|
|
|
2643
2887
|
"required": false,
|
|
2644
2888
|
"type": "integer",
|
|
2645
2889
|
"default": 10,
|
|
2890
|
+
"example": 5,
|
|
2646
2891
|
"description": "Maximum number of periods per ticker",
|
|
2647
2892
|
"alias": "l"
|
|
2648
2893
|
},
|
|
@@ -2652,6 +2897,7 @@
|
|
|
2652
2897
|
"required": false,
|
|
2653
2898
|
"type": "integer",
|
|
2654
2899
|
"default": 0,
|
|
2900
|
+
"example": 0,
|
|
2655
2901
|
"description": "Number of periods to skip for pagination"
|
|
2656
2902
|
},
|
|
2657
2903
|
{
|
|
@@ -2664,6 +2910,7 @@
|
|
|
2664
2910
|
"false"
|
|
2665
2911
|
],
|
|
2666
2912
|
"default": "false",
|
|
2913
|
+
"example": "true",
|
|
2667
2914
|
"description": "Include formula in response"
|
|
2668
2915
|
}
|
|
2669
2916
|
],
|
|
@@ -2687,6 +2934,7 @@
|
|
|
2687
2934
|
"in": "query",
|
|
2688
2935
|
"required": true,
|
|
2689
2936
|
"type": "string",
|
|
2937
|
+
"example": "AAPL",
|
|
2690
2938
|
"description": "Ticker symbol or CIK",
|
|
2691
2939
|
"alias": "i"
|
|
2692
2940
|
},
|
|
@@ -2701,6 +2949,7 @@
|
|
|
2701
2949
|
"ytd",
|
|
2702
2950
|
"ttm"
|
|
2703
2951
|
],
|
|
2952
|
+
"example": "annual",
|
|
2704
2953
|
"description": "Type of fiscal period",
|
|
2705
2954
|
"alias": "p"
|
|
2706
2955
|
},
|
|
@@ -2714,6 +2963,7 @@
|
|
|
2714
2963
|
"desc"
|
|
2715
2964
|
],
|
|
2716
2965
|
"default": "desc",
|
|
2966
|
+
"example": "desc",
|
|
2717
2967
|
"description": "Sort direction for periods by period_end",
|
|
2718
2968
|
"alias": "s"
|
|
2719
2969
|
},
|
|
@@ -2723,6 +2973,7 @@
|
|
|
2723
2973
|
"required": false,
|
|
2724
2974
|
"type": "integer",
|
|
2725
2975
|
"default": 10,
|
|
2976
|
+
"example": 5,
|
|
2726
2977
|
"description": "Maximum number of periods per ticker",
|
|
2727
2978
|
"alias": "l"
|
|
2728
2979
|
},
|
|
@@ -2732,6 +2983,7 @@
|
|
|
2732
2983
|
"required": false,
|
|
2733
2984
|
"type": "integer",
|
|
2734
2985
|
"default": 0,
|
|
2986
|
+
"example": 0,
|
|
2735
2987
|
"description": "Number of periods to skip for pagination"
|
|
2736
2988
|
}
|
|
2737
2989
|
],
|
|
@@ -2755,6 +3007,7 @@
|
|
|
2755
3007
|
"in": "query",
|
|
2756
3008
|
"required": true,
|
|
2757
3009
|
"type": "string",
|
|
3010
|
+
"example": "AAPL,MSFT",
|
|
2758
3011
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2759
3012
|
"alias": "i"
|
|
2760
3013
|
},
|
|
@@ -2769,6 +3022,7 @@
|
|
|
2769
3022
|
"ytd",
|
|
2770
3023
|
"ttm"
|
|
2771
3024
|
],
|
|
3025
|
+
"example": "annual",
|
|
2772
3026
|
"description": "Type of fiscal period",
|
|
2773
3027
|
"alias": "p"
|
|
2774
3028
|
},
|
|
@@ -2777,6 +3031,7 @@
|
|
|
2777
3031
|
"in": "query",
|
|
2778
3032
|
"required": false,
|
|
2779
3033
|
"type": "integer",
|
|
3034
|
+
"example": 2024,
|
|
2780
3035
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2781
3036
|
},
|
|
2782
3037
|
{
|
|
@@ -2784,6 +3039,7 @@
|
|
|
2784
3039
|
"in": "query",
|
|
2785
3040
|
"required": false,
|
|
2786
3041
|
"type": "integer",
|
|
3042
|
+
"example": 4,
|
|
2787
3043
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2788
3044
|
}
|
|
2789
3045
|
],
|
|
@@ -2804,6 +3060,7 @@
|
|
|
2804
3060
|
"in": "query",
|
|
2805
3061
|
"required": true,
|
|
2806
3062
|
"type": "string",
|
|
3063
|
+
"example": "AAPL,MSFT",
|
|
2807
3064
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2808
3065
|
"alias": "i"
|
|
2809
3066
|
},
|
|
@@ -2818,6 +3075,7 @@
|
|
|
2818
3075
|
"ytd",
|
|
2819
3076
|
"ttm"
|
|
2820
3077
|
],
|
|
3078
|
+
"example": "annual",
|
|
2821
3079
|
"description": "Type of fiscal period",
|
|
2822
3080
|
"alias": "p"
|
|
2823
3081
|
},
|
|
@@ -2826,6 +3084,7 @@
|
|
|
2826
3084
|
"in": "query",
|
|
2827
3085
|
"required": false,
|
|
2828
3086
|
"type": "integer",
|
|
3087
|
+
"example": 2024,
|
|
2829
3088
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2830
3089
|
},
|
|
2831
3090
|
{
|
|
@@ -2833,6 +3092,7 @@
|
|
|
2833
3092
|
"in": "query",
|
|
2834
3093
|
"required": false,
|
|
2835
3094
|
"type": "integer",
|
|
3095
|
+
"example": 4,
|
|
2836
3096
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2837
3097
|
},
|
|
2838
3098
|
{
|
|
@@ -2845,6 +3105,7 @@
|
|
|
2845
3105
|
"false"
|
|
2846
3106
|
],
|
|
2847
3107
|
"default": "false",
|
|
3108
|
+
"example": "true",
|
|
2848
3109
|
"description": "Include formula in response"
|
|
2849
3110
|
}
|
|
2850
3111
|
],
|
|
@@ -2865,6 +3126,7 @@
|
|
|
2865
3126
|
"in": "query",
|
|
2866
3127
|
"required": true,
|
|
2867
3128
|
"type": "string",
|
|
3129
|
+
"example": "AAPL,MSFT",
|
|
2868
3130
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
2869
3131
|
"alias": "i"
|
|
2870
3132
|
},
|
|
@@ -2879,6 +3141,7 @@
|
|
|
2879
3141
|
"ytd",
|
|
2880
3142
|
"ttm"
|
|
2881
3143
|
],
|
|
3144
|
+
"example": "annual",
|
|
2882
3145
|
"description": "Type of fiscal period",
|
|
2883
3146
|
"alias": "p"
|
|
2884
3147
|
},
|
|
@@ -2887,6 +3150,7 @@
|
|
|
2887
3150
|
"in": "query",
|
|
2888
3151
|
"required": false,
|
|
2889
3152
|
"type": "integer",
|
|
3153
|
+
"example": 2024,
|
|
2890
3154
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
2891
3155
|
},
|
|
2892
3156
|
{
|
|
@@ -2894,6 +3158,7 @@
|
|
|
2894
3158
|
"in": "query",
|
|
2895
3159
|
"required": false,
|
|
2896
3160
|
"type": "integer",
|
|
3161
|
+
"example": 4,
|
|
2897
3162
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
2898
3163
|
}
|
|
2899
3164
|
],
|
|
@@ -2914,6 +3179,7 @@
|
|
|
2914
3179
|
"in": "query",
|
|
2915
3180
|
"required": true,
|
|
2916
3181
|
"type": "string",
|
|
3182
|
+
"example": "AAPL",
|
|
2917
3183
|
"description": "Ticker symbol or CIK",
|
|
2918
3184
|
"alias": "i"
|
|
2919
3185
|
},
|
|
@@ -2928,6 +3194,7 @@
|
|
|
2928
3194
|
"ytd",
|
|
2929
3195
|
"ttm"
|
|
2930
3196
|
],
|
|
3197
|
+
"example": "annual",
|
|
2931
3198
|
"description": "Type of fiscal period",
|
|
2932
3199
|
"alias": "p"
|
|
2933
3200
|
},
|
|
@@ -2941,6 +3208,7 @@
|
|
|
2941
3208
|
"desc"
|
|
2942
3209
|
],
|
|
2943
3210
|
"default": "desc",
|
|
3211
|
+
"example": "desc",
|
|
2944
3212
|
"description": "Sort direction for periods by period_end",
|
|
2945
3213
|
"alias": "s"
|
|
2946
3214
|
},
|
|
@@ -2950,6 +3218,7 @@
|
|
|
2950
3218
|
"required": false,
|
|
2951
3219
|
"type": "integer",
|
|
2952
3220
|
"default": 10,
|
|
3221
|
+
"example": 5,
|
|
2953
3222
|
"description": "Maximum number of periods per ticker",
|
|
2954
3223
|
"alias": "l"
|
|
2955
3224
|
},
|
|
@@ -2959,6 +3228,7 @@
|
|
|
2959
3228
|
"required": false,
|
|
2960
3229
|
"type": "integer",
|
|
2961
3230
|
"default": 0,
|
|
3231
|
+
"example": 0,
|
|
2962
3232
|
"description": "Number of periods to skip for pagination"
|
|
2963
3233
|
}
|
|
2964
3234
|
],
|
|
@@ -2982,6 +3252,7 @@
|
|
|
2982
3252
|
"in": "query",
|
|
2983
3253
|
"required": true,
|
|
2984
3254
|
"type": "string",
|
|
3255
|
+
"example": "AAPL",
|
|
2985
3256
|
"description": "Ticker symbol or CIK",
|
|
2986
3257
|
"alias": "i"
|
|
2987
3258
|
},
|
|
@@ -2996,6 +3267,7 @@
|
|
|
2996
3267
|
"ytd",
|
|
2997
3268
|
"ttm"
|
|
2998
3269
|
],
|
|
3270
|
+
"example": "annual",
|
|
2999
3271
|
"description": "Type of fiscal period",
|
|
3000
3272
|
"alias": "p"
|
|
3001
3273
|
},
|
|
@@ -3009,6 +3281,7 @@
|
|
|
3009
3281
|
"desc"
|
|
3010
3282
|
],
|
|
3011
3283
|
"default": "desc",
|
|
3284
|
+
"example": "desc",
|
|
3012
3285
|
"description": "Sort direction for periods by period_end",
|
|
3013
3286
|
"alias": "s"
|
|
3014
3287
|
},
|
|
@@ -3018,6 +3291,7 @@
|
|
|
3018
3291
|
"required": false,
|
|
3019
3292
|
"type": "integer",
|
|
3020
3293
|
"default": 10,
|
|
3294
|
+
"example": 5,
|
|
3021
3295
|
"description": "Maximum number of periods per ticker",
|
|
3022
3296
|
"alias": "l"
|
|
3023
3297
|
},
|
|
@@ -3027,6 +3301,7 @@
|
|
|
3027
3301
|
"required": false,
|
|
3028
3302
|
"type": "integer",
|
|
3029
3303
|
"default": 0,
|
|
3304
|
+
"example": 0,
|
|
3030
3305
|
"description": "Number of periods to skip for pagination"
|
|
3031
3306
|
},
|
|
3032
3307
|
{
|
|
@@ -3039,6 +3314,7 @@
|
|
|
3039
3314
|
"false"
|
|
3040
3315
|
],
|
|
3041
3316
|
"default": "false",
|
|
3317
|
+
"example": "true",
|
|
3042
3318
|
"description": "Include formula in response"
|
|
3043
3319
|
}
|
|
3044
3320
|
],
|
|
@@ -3062,6 +3338,7 @@
|
|
|
3062
3338
|
"in": "query",
|
|
3063
3339
|
"required": true,
|
|
3064
3340
|
"type": "string",
|
|
3341
|
+
"example": "AAPL",
|
|
3065
3342
|
"description": "Ticker symbol or CIK",
|
|
3066
3343
|
"alias": "i"
|
|
3067
3344
|
},
|
|
@@ -3076,6 +3353,7 @@
|
|
|
3076
3353
|
"ytd",
|
|
3077
3354
|
"ttm"
|
|
3078
3355
|
],
|
|
3356
|
+
"example": "annual",
|
|
3079
3357
|
"description": "Type of fiscal period",
|
|
3080
3358
|
"alias": "p"
|
|
3081
3359
|
},
|
|
@@ -3089,6 +3367,7 @@
|
|
|
3089
3367
|
"desc"
|
|
3090
3368
|
],
|
|
3091
3369
|
"default": "desc",
|
|
3370
|
+
"example": "desc",
|
|
3092
3371
|
"description": "Sort direction for periods by period_end",
|
|
3093
3372
|
"alias": "s"
|
|
3094
3373
|
},
|
|
@@ -3098,6 +3377,7 @@
|
|
|
3098
3377
|
"required": false,
|
|
3099
3378
|
"type": "integer",
|
|
3100
3379
|
"default": 10,
|
|
3380
|
+
"example": 5,
|
|
3101
3381
|
"description": "Maximum number of periods per ticker",
|
|
3102
3382
|
"alias": "l"
|
|
3103
3383
|
},
|
|
@@ -3107,6 +3387,7 @@
|
|
|
3107
3387
|
"required": false,
|
|
3108
3388
|
"type": "integer",
|
|
3109
3389
|
"default": 0,
|
|
3390
|
+
"example": 0,
|
|
3110
3391
|
"description": "Number of periods to skip for pagination"
|
|
3111
3392
|
}
|
|
3112
3393
|
],
|
|
@@ -3130,6 +3411,7 @@
|
|
|
3130
3411
|
"in": "query",
|
|
3131
3412
|
"required": true,
|
|
3132
3413
|
"type": "string",
|
|
3414
|
+
"example": "AAPL",
|
|
3133
3415
|
"description": "Ticker symbol or CIK",
|
|
3134
3416
|
"alias": "i"
|
|
3135
3417
|
},
|
|
@@ -3144,6 +3426,7 @@
|
|
|
3144
3426
|
"ytd",
|
|
3145
3427
|
"ttm"
|
|
3146
3428
|
],
|
|
3429
|
+
"example": "annual",
|
|
3147
3430
|
"description": "Type of fiscal period",
|
|
3148
3431
|
"alias": "p"
|
|
3149
3432
|
},
|
|
@@ -3157,6 +3440,7 @@
|
|
|
3157
3440
|
"desc"
|
|
3158
3441
|
],
|
|
3159
3442
|
"default": "desc",
|
|
3443
|
+
"example": "desc",
|
|
3160
3444
|
"description": "Sort direction for periods by period_end",
|
|
3161
3445
|
"alias": "s"
|
|
3162
3446
|
},
|
|
@@ -3166,6 +3450,7 @@
|
|
|
3166
3450
|
"required": false,
|
|
3167
3451
|
"type": "integer",
|
|
3168
3452
|
"default": 10,
|
|
3453
|
+
"example": 5,
|
|
3169
3454
|
"description": "Maximum number of periods per ticker",
|
|
3170
3455
|
"alias": "l"
|
|
3171
3456
|
},
|
|
@@ -3175,6 +3460,7 @@
|
|
|
3175
3460
|
"required": false,
|
|
3176
3461
|
"type": "integer",
|
|
3177
3462
|
"default": 0,
|
|
3463
|
+
"example": 0,
|
|
3178
3464
|
"description": "Number of periods to skip for pagination"
|
|
3179
3465
|
}
|
|
3180
3466
|
],
|
|
@@ -3198,6 +3484,7 @@
|
|
|
3198
3484
|
"in": "query",
|
|
3199
3485
|
"required": true,
|
|
3200
3486
|
"type": "string",
|
|
3487
|
+
"example": "AAPL",
|
|
3201
3488
|
"description": "Ticker symbol or CIK",
|
|
3202
3489
|
"alias": "i"
|
|
3203
3490
|
},
|
|
@@ -3212,6 +3499,7 @@
|
|
|
3212
3499
|
"ytd",
|
|
3213
3500
|
"ttm"
|
|
3214
3501
|
],
|
|
3502
|
+
"example": "annual",
|
|
3215
3503
|
"description": "Type of fiscal period",
|
|
3216
3504
|
"alias": "p"
|
|
3217
3505
|
},
|
|
@@ -3225,6 +3513,7 @@
|
|
|
3225
3513
|
"desc"
|
|
3226
3514
|
],
|
|
3227
3515
|
"default": "desc",
|
|
3516
|
+
"example": "desc",
|
|
3228
3517
|
"description": "Sort direction for periods by period_end",
|
|
3229
3518
|
"alias": "s"
|
|
3230
3519
|
},
|
|
@@ -3234,6 +3523,7 @@
|
|
|
3234
3523
|
"required": false,
|
|
3235
3524
|
"type": "integer",
|
|
3236
3525
|
"default": 10,
|
|
3526
|
+
"example": 5,
|
|
3237
3527
|
"description": "Maximum number of periods per ticker",
|
|
3238
3528
|
"alias": "l"
|
|
3239
3529
|
},
|
|
@@ -3243,6 +3533,7 @@
|
|
|
3243
3533
|
"required": false,
|
|
3244
3534
|
"type": "integer",
|
|
3245
3535
|
"default": 0,
|
|
3536
|
+
"example": 0,
|
|
3246
3537
|
"description": "Number of periods to skip for pagination"
|
|
3247
3538
|
},
|
|
3248
3539
|
{
|
|
@@ -3255,6 +3546,7 @@
|
|
|
3255
3546
|
"false"
|
|
3256
3547
|
],
|
|
3257
3548
|
"default": "false",
|
|
3549
|
+
"example": "true",
|
|
3258
3550
|
"description": "Include formula in response"
|
|
3259
3551
|
}
|
|
3260
3552
|
],
|
|
@@ -3278,6 +3570,7 @@
|
|
|
3278
3570
|
"in": "query",
|
|
3279
3571
|
"required": true,
|
|
3280
3572
|
"type": "string",
|
|
3573
|
+
"example": "AAPL",
|
|
3281
3574
|
"description": "Ticker symbol or CIK",
|
|
3282
3575
|
"alias": "i"
|
|
3283
3576
|
},
|
|
@@ -3292,6 +3585,7 @@
|
|
|
3292
3585
|
"ytd",
|
|
3293
3586
|
"ttm"
|
|
3294
3587
|
],
|
|
3588
|
+
"example": "annual",
|
|
3295
3589
|
"description": "Type of fiscal period",
|
|
3296
3590
|
"alias": "p"
|
|
3297
3591
|
},
|
|
@@ -3305,6 +3599,7 @@
|
|
|
3305
3599
|
"desc"
|
|
3306
3600
|
],
|
|
3307
3601
|
"default": "desc",
|
|
3602
|
+
"example": "desc",
|
|
3308
3603
|
"description": "Sort direction for periods by period_end",
|
|
3309
3604
|
"alias": "s"
|
|
3310
3605
|
},
|
|
@@ -3314,6 +3609,7 @@
|
|
|
3314
3609
|
"required": false,
|
|
3315
3610
|
"type": "integer",
|
|
3316
3611
|
"default": 10,
|
|
3612
|
+
"example": 5,
|
|
3317
3613
|
"description": "Maximum number of periods per ticker",
|
|
3318
3614
|
"alias": "l"
|
|
3319
3615
|
},
|
|
@@ -3323,6 +3619,7 @@
|
|
|
3323
3619
|
"required": false,
|
|
3324
3620
|
"type": "integer",
|
|
3325
3621
|
"default": 0,
|
|
3622
|
+
"example": 0,
|
|
3326
3623
|
"description": "Number of periods to skip for pagination"
|
|
3327
3624
|
}
|
|
3328
3625
|
],
|
|
@@ -3346,6 +3643,7 @@
|
|
|
3346
3643
|
"in": "query",
|
|
3347
3644
|
"required": true,
|
|
3348
3645
|
"type": "string",
|
|
3646
|
+
"example": "AAPL",
|
|
3349
3647
|
"description": "Ticker symbol or CIK",
|
|
3350
3648
|
"alias": "i"
|
|
3351
3649
|
},
|
|
@@ -3360,6 +3658,7 @@
|
|
|
3360
3658
|
"ytd",
|
|
3361
3659
|
"ttm"
|
|
3362
3660
|
],
|
|
3661
|
+
"example": "annual",
|
|
3363
3662
|
"description": "Type of fiscal period",
|
|
3364
3663
|
"alias": "p"
|
|
3365
3664
|
},
|
|
@@ -3373,6 +3672,7 @@
|
|
|
3373
3672
|
"desc"
|
|
3374
3673
|
],
|
|
3375
3674
|
"default": "desc",
|
|
3675
|
+
"example": "desc",
|
|
3376
3676
|
"description": "Sort direction for periods by period_end",
|
|
3377
3677
|
"alias": "s"
|
|
3378
3678
|
},
|
|
@@ -3382,6 +3682,7 @@
|
|
|
3382
3682
|
"required": false,
|
|
3383
3683
|
"type": "integer",
|
|
3384
3684
|
"default": 10,
|
|
3685
|
+
"example": 5,
|
|
3385
3686
|
"description": "Maximum number of periods per ticker",
|
|
3386
3687
|
"alias": "l"
|
|
3387
3688
|
},
|
|
@@ -3391,6 +3692,7 @@
|
|
|
3391
3692
|
"required": false,
|
|
3392
3693
|
"type": "integer",
|
|
3393
3694
|
"default": 0,
|
|
3695
|
+
"example": 0,
|
|
3394
3696
|
"description": "Number of periods to skip for pagination"
|
|
3395
3697
|
}
|
|
3396
3698
|
],
|
|
@@ -3414,6 +3716,7 @@
|
|
|
3414
3716
|
"in": "query",
|
|
3415
3717
|
"required": true,
|
|
3416
3718
|
"type": "string",
|
|
3719
|
+
"example": "AAPL",
|
|
3417
3720
|
"description": "Ticker symbol or CIK",
|
|
3418
3721
|
"alias": "i"
|
|
3419
3722
|
},
|
|
@@ -3428,6 +3731,7 @@
|
|
|
3428
3731
|
"ytd",
|
|
3429
3732
|
"ttm"
|
|
3430
3733
|
],
|
|
3734
|
+
"example": "annual",
|
|
3431
3735
|
"description": "Type of fiscal period",
|
|
3432
3736
|
"alias": "p"
|
|
3433
3737
|
},
|
|
@@ -3441,6 +3745,7 @@
|
|
|
3441
3745
|
"desc"
|
|
3442
3746
|
],
|
|
3443
3747
|
"default": "desc",
|
|
3748
|
+
"example": "desc",
|
|
3444
3749
|
"description": "Sort direction for periods by period_end",
|
|
3445
3750
|
"alias": "s"
|
|
3446
3751
|
},
|
|
@@ -3450,6 +3755,7 @@
|
|
|
3450
3755
|
"required": false,
|
|
3451
3756
|
"type": "integer",
|
|
3452
3757
|
"default": 10,
|
|
3758
|
+
"example": 5,
|
|
3453
3759
|
"description": "Maximum number of periods per ticker",
|
|
3454
3760
|
"alias": "l"
|
|
3455
3761
|
},
|
|
@@ -3459,6 +3765,7 @@
|
|
|
3459
3765
|
"required": false,
|
|
3460
3766
|
"type": "integer",
|
|
3461
3767
|
"default": 0,
|
|
3768
|
+
"example": 0,
|
|
3462
3769
|
"description": "Number of periods to skip for pagination"
|
|
3463
3770
|
},
|
|
3464
3771
|
{
|
|
@@ -3471,6 +3778,7 @@
|
|
|
3471
3778
|
"false"
|
|
3472
3779
|
],
|
|
3473
3780
|
"default": "false",
|
|
3781
|
+
"example": "true",
|
|
3474
3782
|
"description": "Include formula in response"
|
|
3475
3783
|
}
|
|
3476
3784
|
],
|
|
@@ -3494,6 +3802,7 @@
|
|
|
3494
3802
|
"in": "query",
|
|
3495
3803
|
"required": true,
|
|
3496
3804
|
"type": "string",
|
|
3805
|
+
"example": "AAPL",
|
|
3497
3806
|
"description": "Ticker symbol or CIK",
|
|
3498
3807
|
"alias": "i"
|
|
3499
3808
|
},
|
|
@@ -3508,6 +3817,7 @@
|
|
|
3508
3817
|
"ytd",
|
|
3509
3818
|
"ttm"
|
|
3510
3819
|
],
|
|
3820
|
+
"example": "annual",
|
|
3511
3821
|
"description": "Type of fiscal period",
|
|
3512
3822
|
"alias": "p"
|
|
3513
3823
|
},
|
|
@@ -3521,6 +3831,7 @@
|
|
|
3521
3831
|
"desc"
|
|
3522
3832
|
],
|
|
3523
3833
|
"default": "desc",
|
|
3834
|
+
"example": "desc",
|
|
3524
3835
|
"description": "Sort direction for periods by period_end",
|
|
3525
3836
|
"alias": "s"
|
|
3526
3837
|
},
|
|
@@ -3530,6 +3841,7 @@
|
|
|
3530
3841
|
"required": false,
|
|
3531
3842
|
"type": "integer",
|
|
3532
3843
|
"default": 10,
|
|
3844
|
+
"example": 5,
|
|
3533
3845
|
"description": "Maximum number of periods per ticker",
|
|
3534
3846
|
"alias": "l"
|
|
3535
3847
|
},
|
|
@@ -3539,6 +3851,7 @@
|
|
|
3539
3851
|
"required": false,
|
|
3540
3852
|
"type": "integer",
|
|
3541
3853
|
"default": 0,
|
|
3854
|
+
"example": 0,
|
|
3542
3855
|
"description": "Number of periods to skip for pagination"
|
|
3543
3856
|
}
|
|
3544
3857
|
],
|
|
@@ -3562,6 +3875,7 @@
|
|
|
3562
3875
|
"in": "query",
|
|
3563
3876
|
"required": true,
|
|
3564
3877
|
"type": "string",
|
|
3878
|
+
"example": "AAPL,MSFT",
|
|
3565
3879
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3566
3880
|
"alias": "i"
|
|
3567
3881
|
},
|
|
@@ -3576,6 +3890,7 @@
|
|
|
3576
3890
|
"ytd",
|
|
3577
3891
|
"ttm"
|
|
3578
3892
|
],
|
|
3893
|
+
"example": "annual",
|
|
3579
3894
|
"description": "Type of fiscal period",
|
|
3580
3895
|
"alias": "p"
|
|
3581
3896
|
},
|
|
@@ -3584,6 +3899,7 @@
|
|
|
3584
3899
|
"in": "query",
|
|
3585
3900
|
"required": false,
|
|
3586
3901
|
"type": "integer",
|
|
3902
|
+
"example": 2024,
|
|
3587
3903
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3588
3904
|
},
|
|
3589
3905
|
{
|
|
@@ -3591,6 +3907,7 @@
|
|
|
3591
3907
|
"in": "query",
|
|
3592
3908
|
"required": false,
|
|
3593
3909
|
"type": "integer",
|
|
3910
|
+
"example": 4,
|
|
3594
3911
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3595
3912
|
}
|
|
3596
3913
|
],
|
|
@@ -3611,6 +3928,7 @@
|
|
|
3611
3928
|
"in": "query",
|
|
3612
3929
|
"required": true,
|
|
3613
3930
|
"type": "string",
|
|
3931
|
+
"example": "AAPL,MSFT",
|
|
3614
3932
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3615
3933
|
"alias": "i"
|
|
3616
3934
|
},
|
|
@@ -3625,6 +3943,7 @@
|
|
|
3625
3943
|
"ytd",
|
|
3626
3944
|
"ttm"
|
|
3627
3945
|
],
|
|
3946
|
+
"example": "annual",
|
|
3628
3947
|
"description": "Type of fiscal period",
|
|
3629
3948
|
"alias": "p"
|
|
3630
3949
|
},
|
|
@@ -3633,6 +3952,7 @@
|
|
|
3633
3952
|
"in": "query",
|
|
3634
3953
|
"required": false,
|
|
3635
3954
|
"type": "integer",
|
|
3955
|
+
"example": 2024,
|
|
3636
3956
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3637
3957
|
},
|
|
3638
3958
|
{
|
|
@@ -3640,6 +3960,7 @@
|
|
|
3640
3960
|
"in": "query",
|
|
3641
3961
|
"required": false,
|
|
3642
3962
|
"type": "integer",
|
|
3963
|
+
"example": 4,
|
|
3643
3964
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3644
3965
|
},
|
|
3645
3966
|
{
|
|
@@ -3652,6 +3973,7 @@
|
|
|
3652
3973
|
"false"
|
|
3653
3974
|
],
|
|
3654
3975
|
"default": "false",
|
|
3976
|
+
"example": "true",
|
|
3655
3977
|
"description": "Include formula in response"
|
|
3656
3978
|
}
|
|
3657
3979
|
],
|
|
@@ -3672,6 +3994,7 @@
|
|
|
3672
3994
|
"in": "query",
|
|
3673
3995
|
"required": true,
|
|
3674
3996
|
"type": "string",
|
|
3997
|
+
"example": "AAPL,MSFT",
|
|
3675
3998
|
"description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
|
|
3676
3999
|
"alias": "i"
|
|
3677
4000
|
},
|
|
@@ -3686,6 +4009,7 @@
|
|
|
3686
4009
|
"ytd",
|
|
3687
4010
|
"ttm"
|
|
3688
4011
|
],
|
|
4012
|
+
"example": "annual",
|
|
3689
4013
|
"description": "Type of fiscal period",
|
|
3690
4014
|
"alias": "p"
|
|
3691
4015
|
},
|
|
@@ -3694,6 +4018,7 @@
|
|
|
3694
4018
|
"in": "query",
|
|
3695
4019
|
"required": false,
|
|
3696
4020
|
"type": "integer",
|
|
4021
|
+
"example": 2024,
|
|
3697
4022
|
"description": "Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter."
|
|
3698
4023
|
},
|
|
3699
4024
|
{
|
|
@@ -3701,6 +4026,7 @@
|
|
|
3701
4026
|
"in": "query",
|
|
3702
4027
|
"required": false,
|
|
3703
4028
|
"type": "integer",
|
|
4029
|
+
"example": 4,
|
|
3704
4030
|
"description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
|
|
3705
4031
|
}
|
|
3706
4032
|
],
|
|
@@ -3737,6 +4063,7 @@
|
|
|
3737
4063
|
"in": "query",
|
|
3738
4064
|
"required": true,
|
|
3739
4065
|
"type": "string",
|
|
4066
|
+
"example": "AAPL",
|
|
3740
4067
|
"description": "Company ticker symbol or CIK",
|
|
3741
4068
|
"alias": "i"
|
|
3742
4069
|
},
|
|
@@ -3745,6 +4072,7 @@
|
|
|
3745
4072
|
"in": "query",
|
|
3746
4073
|
"required": false,
|
|
3747
4074
|
"type": "string",
|
|
4075
|
+
"example": "2025-01-01",
|
|
3748
4076
|
"description": "Filter transactions filed on or after this date (YYYY-MM-DD)"
|
|
3749
4077
|
},
|
|
3750
4078
|
{
|
|
@@ -3752,6 +4080,7 @@
|
|
|
3752
4080
|
"in": "query",
|
|
3753
4081
|
"required": false,
|
|
3754
4082
|
"type": "string",
|
|
4083
|
+
"example": "2025-12-31",
|
|
3755
4084
|
"description": "Filter transactions filed on or before this date (YYYY-MM-DD)"
|
|
3756
4085
|
},
|
|
3757
4086
|
{
|
|
@@ -3763,6 +4092,7 @@
|
|
|
3763
4092
|
"A",
|
|
3764
4093
|
"D"
|
|
3765
4094
|
],
|
|
4095
|
+
"example": "D",
|
|
3766
4096
|
"description": "Filter by acquisition (A) or disposition (D)"
|
|
3767
4097
|
},
|
|
3768
4098
|
{
|
|
@@ -3775,6 +4105,7 @@
|
|
|
3775
4105
|
"desc"
|
|
3776
4106
|
],
|
|
3777
4107
|
"default": "desc",
|
|
4108
|
+
"example": "desc",
|
|
3778
4109
|
"description": "Sort direction by filed_at date",
|
|
3779
4110
|
"alias": "s"
|
|
3780
4111
|
},
|
|
@@ -3784,6 +4115,7 @@
|
|
|
3784
4115
|
"required": false,
|
|
3785
4116
|
"type": "integer",
|
|
3786
4117
|
"default": 100,
|
|
4118
|
+
"example": 5,
|
|
3787
4119
|
"description": "Maximum number of transactions to return",
|
|
3788
4120
|
"alias": "l"
|
|
3789
4121
|
},
|
|
@@ -3793,6 +4125,7 @@
|
|
|
3793
4125
|
"required": false,
|
|
3794
4126
|
"type": "integer",
|
|
3795
4127
|
"default": 0,
|
|
4128
|
+
"example": 0,
|
|
3796
4129
|
"description": "Number of transactions to skip for pagination"
|
|
3797
4130
|
}
|
|
3798
4131
|
],
|
|
@@ -3837,6 +4170,7 @@
|
|
|
3837
4170
|
"in": "query",
|
|
3838
4171
|
"required": false,
|
|
3839
4172
|
"type": "string",
|
|
4173
|
+
"example": "2025-01-01",
|
|
3840
4174
|
"description": "Filter IPOs with listing_date on or after this date (YYYY-MM-DD)"
|
|
3841
4175
|
},
|
|
3842
4176
|
{
|
|
@@ -3844,6 +4178,7 @@
|
|
|
3844
4178
|
"in": "query",
|
|
3845
4179
|
"required": false,
|
|
3846
4180
|
"type": "string",
|
|
4181
|
+
"example": "2025-12-31",
|
|
3847
4182
|
"description": "Filter IPOs with listing_date on or before this date (YYYY-MM-DD)"
|
|
3848
4183
|
},
|
|
3849
4184
|
{
|
|
@@ -3856,6 +4191,7 @@
|
|
|
3856
4191
|
"desc"
|
|
3857
4192
|
],
|
|
3858
4193
|
"default": "desc",
|
|
4194
|
+
"example": "desc",
|
|
3859
4195
|
"description": "Sort direction for IPOs by listing_date",
|
|
3860
4196
|
"alias": "s"
|
|
3861
4197
|
},
|
|
@@ -3865,6 +4201,7 @@
|
|
|
3865
4201
|
"required": false,
|
|
3866
4202
|
"type": "integer",
|
|
3867
4203
|
"default": 100,
|
|
4204
|
+
"example": 5,
|
|
3868
4205
|
"description": "Maximum number of IPOs to return",
|
|
3869
4206
|
"alias": "l"
|
|
3870
4207
|
},
|
|
@@ -3874,6 +4211,7 @@
|
|
|
3874
4211
|
"required": false,
|
|
3875
4212
|
"type": "integer",
|
|
3876
4213
|
"default": 0,
|
|
4214
|
+
"example": 0,
|
|
3877
4215
|
"description": "Number of IPOs to skip for pagination"
|
|
3878
4216
|
}
|
|
3879
4217
|
],
|
|
@@ -3916,6 +4254,7 @@
|
|
|
3916
4254
|
"desc"
|
|
3917
4255
|
],
|
|
3918
4256
|
"default": "asc",
|
|
4257
|
+
"example": "desc",
|
|
3919
4258
|
"description": "Sort direction for holidays by date",
|
|
3920
4259
|
"alias": "s"
|
|
3921
4260
|
},
|
|
@@ -3925,6 +4264,7 @@
|
|
|
3925
4264
|
"required": false,
|
|
3926
4265
|
"type": "integer",
|
|
3927
4266
|
"default": 100,
|
|
4267
|
+
"example": 5,
|
|
3928
4268
|
"description": "Maximum number of holidays to return",
|
|
3929
4269
|
"alias": "l"
|
|
3930
4270
|
},
|
|
@@ -3934,6 +4274,7 @@
|
|
|
3934
4274
|
"required": false,
|
|
3935
4275
|
"type": "integer",
|
|
3936
4276
|
"default": 0,
|
|
4277
|
+
"example": 0,
|
|
3937
4278
|
"description": "Number of holidays to skip for pagination"
|
|
3938
4279
|
}
|
|
3939
4280
|
],
|
|
@@ -3993,6 +4334,7 @@
|
|
|
3993
4334
|
"in": "query",
|
|
3994
4335
|
"required": true,
|
|
3995
4336
|
"type": "string",
|
|
4337
|
+
"example": "AAPL",
|
|
3996
4338
|
"description": "Ticker symbol or CIK",
|
|
3997
4339
|
"alias": "i"
|
|
3998
4340
|
},
|
|
@@ -4006,6 +4348,7 @@
|
|
|
4006
4348
|
"5",
|
|
4007
4349
|
"10"
|
|
4008
4350
|
],
|
|
4351
|
+
"example": "5",
|
|
4009
4352
|
"description": "CAGR calculation period in years: 3, 5, 10"
|
|
4010
4353
|
},
|
|
4011
4354
|
{
|
|
@@ -4018,6 +4361,7 @@
|
|
|
4018
4361
|
"desc"
|
|
4019
4362
|
],
|
|
4020
4363
|
"default": "desc",
|
|
4364
|
+
"example": "desc",
|
|
4021
4365
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4022
4366
|
"alias": "s"
|
|
4023
4367
|
},
|
|
@@ -4027,6 +4371,7 @@
|
|
|
4027
4371
|
"required": false,
|
|
4028
4372
|
"type": "integer",
|
|
4029
4373
|
"default": 10,
|
|
4374
|
+
"example": 5,
|
|
4030
4375
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4031
4376
|
"alias": "l"
|
|
4032
4377
|
},
|
|
@@ -4036,6 +4381,7 @@
|
|
|
4036
4381
|
"required": false,
|
|
4037
4382
|
"type": "integer",
|
|
4038
4383
|
"default": 0,
|
|
4384
|
+
"example": 0,
|
|
4039
4385
|
"description": "Number of periods to skip for pagination"
|
|
4040
4386
|
}
|
|
4041
4387
|
],
|
|
@@ -4059,6 +4405,7 @@
|
|
|
4059
4405
|
"in": "query",
|
|
4060
4406
|
"required": true,
|
|
4061
4407
|
"type": "string",
|
|
4408
|
+
"example": "AAPL",
|
|
4062
4409
|
"description": "Ticker symbol or CIK",
|
|
4063
4410
|
"alias": "i"
|
|
4064
4411
|
},
|
|
@@ -4073,6 +4420,7 @@
|
|
|
4073
4420
|
"ytd",
|
|
4074
4421
|
"ttm"
|
|
4075
4422
|
],
|
|
4423
|
+
"example": "annual",
|
|
4076
4424
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4077
4425
|
"alias": "p"
|
|
4078
4426
|
},
|
|
@@ -4085,6 +4433,7 @@
|
|
|
4085
4433
|
"year_over_year",
|
|
4086
4434
|
"quarter_over_quarter"
|
|
4087
4435
|
],
|
|
4436
|
+
"example": "year_over_year",
|
|
4088
4437
|
"description": "Filter by growth type: year_over_year, quarter_over_quarter"
|
|
4089
4438
|
},
|
|
4090
4439
|
{
|
|
@@ -4097,6 +4446,7 @@
|
|
|
4097
4446
|
"desc"
|
|
4098
4447
|
],
|
|
4099
4448
|
"default": "desc",
|
|
4449
|
+
"example": "desc",
|
|
4100
4450
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4101
4451
|
"alias": "s"
|
|
4102
4452
|
},
|
|
@@ -4106,6 +4456,7 @@
|
|
|
4106
4456
|
"required": false,
|
|
4107
4457
|
"type": "integer",
|
|
4108
4458
|
"default": 10,
|
|
4459
|
+
"example": 5,
|
|
4109
4460
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4110
4461
|
"alias": "l"
|
|
4111
4462
|
},
|
|
@@ -4115,6 +4466,7 @@
|
|
|
4115
4466
|
"required": false,
|
|
4116
4467
|
"type": "integer",
|
|
4117
4468
|
"default": 0,
|
|
4469
|
+
"example": 0,
|
|
4118
4470
|
"description": "Number of periods to skip for pagination"
|
|
4119
4471
|
}
|
|
4120
4472
|
],
|
|
@@ -4138,6 +4490,7 @@
|
|
|
4138
4490
|
"in": "query",
|
|
4139
4491
|
"required": true,
|
|
4140
4492
|
"type": "string",
|
|
4493
|
+
"example": "AAPL",
|
|
4141
4494
|
"description": "Ticker symbol or CIK",
|
|
4142
4495
|
"alias": "i"
|
|
4143
4496
|
},
|
|
@@ -4152,6 +4505,7 @@
|
|
|
4152
4505
|
"ytd",
|
|
4153
4506
|
"ttm"
|
|
4154
4507
|
],
|
|
4508
|
+
"example": "annual",
|
|
4155
4509
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4156
4510
|
"alias": "p"
|
|
4157
4511
|
},
|
|
@@ -4166,6 +4520,7 @@
|
|
|
4166
4520
|
"liquidity",
|
|
4167
4521
|
"solvency"
|
|
4168
4522
|
],
|
|
4523
|
+
"example": "profitability",
|
|
4169
4524
|
"description": "Filter by ratio category: valuation, profitability, liquidity, solvency"
|
|
4170
4525
|
},
|
|
4171
4526
|
{
|
|
@@ -4178,6 +4533,7 @@
|
|
|
4178
4533
|
"desc"
|
|
4179
4534
|
],
|
|
4180
4535
|
"default": "desc",
|
|
4536
|
+
"example": "desc",
|
|
4181
4537
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4182
4538
|
"alias": "s"
|
|
4183
4539
|
},
|
|
@@ -4187,6 +4543,7 @@
|
|
|
4187
4543
|
"required": false,
|
|
4188
4544
|
"type": "integer",
|
|
4189
4545
|
"default": 10,
|
|
4546
|
+
"example": 5,
|
|
4190
4547
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4191
4548
|
"alias": "l"
|
|
4192
4549
|
},
|
|
@@ -4196,6 +4553,7 @@
|
|
|
4196
4553
|
"required": false,
|
|
4197
4554
|
"type": "integer",
|
|
4198
4555
|
"default": 0,
|
|
4556
|
+
"example": 0,
|
|
4199
4557
|
"description": "Number of periods to skip for pagination"
|
|
4200
4558
|
}
|
|
4201
4559
|
],
|
|
@@ -4219,6 +4577,7 @@
|
|
|
4219
4577
|
"in": "query",
|
|
4220
4578
|
"required": true,
|
|
4221
4579
|
"type": "string",
|
|
4580
|
+
"example": "AAPL",
|
|
4222
4581
|
"description": "Company ticker symbol or CIK",
|
|
4223
4582
|
"alias": "i"
|
|
4224
4583
|
},
|
|
@@ -4227,6 +4586,7 @@
|
|
|
4227
4586
|
"in": "query",
|
|
4228
4587
|
"required": false,
|
|
4229
4588
|
"type": "number",
|
|
4589
|
+
"example": 1000000000,
|
|
4230
4590
|
"description": "Minimum dollar value filter"
|
|
4231
4591
|
},
|
|
4232
4592
|
{
|
|
@@ -4239,6 +4599,7 @@
|
|
|
4239
4599
|
"desc"
|
|
4240
4600
|
],
|
|
4241
4601
|
"default": "desc",
|
|
4602
|
+
"example": "desc",
|
|
4242
4603
|
"description": "Sort direction by dollar_value",
|
|
4243
4604
|
"alias": "s"
|
|
4244
4605
|
},
|
|
@@ -4248,6 +4609,7 @@
|
|
|
4248
4609
|
"required": false,
|
|
4249
4610
|
"type": "integer",
|
|
4250
4611
|
"default": 100,
|
|
4612
|
+
"example": 5,
|
|
4251
4613
|
"description": "Maximum number of holdings to return",
|
|
4252
4614
|
"alias": "l"
|
|
4253
4615
|
},
|
|
@@ -4257,6 +4619,7 @@
|
|
|
4257
4619
|
"required": false,
|
|
4258
4620
|
"type": "integer",
|
|
4259
4621
|
"default": 0,
|
|
4622
|
+
"example": 0,
|
|
4260
4623
|
"description": "Number of holdings to skip for pagination"
|
|
4261
4624
|
}
|
|
4262
4625
|
],
|
|
@@ -4303,6 +4666,7 @@
|
|
|
4303
4666
|
"in": "query",
|
|
4304
4667
|
"required": true,
|
|
4305
4668
|
"type": "string",
|
|
4669
|
+
"example": "1067983",
|
|
4306
4670
|
"description": "Institution CIK"
|
|
4307
4671
|
},
|
|
4308
4672
|
{
|
|
@@ -4315,6 +4679,7 @@
|
|
|
4315
4679
|
"desc"
|
|
4316
4680
|
],
|
|
4317
4681
|
"default": "desc",
|
|
4682
|
+
"example": "desc",
|
|
4318
4683
|
"description": "Sort direction by dollar_value",
|
|
4319
4684
|
"alias": "s"
|
|
4320
4685
|
},
|
|
@@ -4324,6 +4689,7 @@
|
|
|
4324
4689
|
"required": false,
|
|
4325
4690
|
"type": "integer",
|
|
4326
4691
|
"default": 100,
|
|
4692
|
+
"example": 5,
|
|
4327
4693
|
"description": "Maximum number of holdings to return",
|
|
4328
4694
|
"alias": "l"
|
|
4329
4695
|
},
|
|
@@ -4333,6 +4699,7 @@
|
|
|
4333
4699
|
"required": false,
|
|
4334
4700
|
"type": "integer",
|
|
4335
4701
|
"default": 0,
|
|
4702
|
+
"example": 0,
|
|
4336
4703
|
"description": "Number of holdings to skip for pagination"
|
|
4337
4704
|
}
|
|
4338
4705
|
],
|
|
@@ -4379,6 +4746,7 @@
|
|
|
4379
4746
|
"in": "query",
|
|
4380
4747
|
"required": false,
|
|
4381
4748
|
"type": "string",
|
|
4749
|
+
"example": "1067983,102909",
|
|
4382
4750
|
"description": "Comma-separated list of CIKs (Central Index Keys)"
|
|
4383
4751
|
},
|
|
4384
4752
|
{
|
|
@@ -4387,6 +4755,7 @@
|
|
|
4387
4755
|
"required": false,
|
|
4388
4756
|
"type": "integer",
|
|
4389
4757
|
"default": 100,
|
|
4758
|
+
"example": 5,
|
|
4390
4759
|
"description": "Maximum number of institutions to return",
|
|
4391
4760
|
"alias": "l"
|
|
4392
4761
|
},
|
|
@@ -4396,6 +4765,7 @@
|
|
|
4396
4765
|
"required": false,
|
|
4397
4766
|
"type": "integer",
|
|
4398
4767
|
"default": 0,
|
|
4768
|
+
"example": 0,
|
|
4399
4769
|
"description": "Pagination offset"
|
|
4400
4770
|
},
|
|
4401
4771
|
{
|
|
@@ -4408,6 +4778,7 @@
|
|
|
4408
4778
|
"desc"
|
|
4409
4779
|
],
|
|
4410
4780
|
"default": "asc",
|
|
4781
|
+
"example": "desc",
|
|
4411
4782
|
"description": "Sort direction for institutions by name",
|
|
4412
4783
|
"alias": "s"
|
|
4413
4784
|
}
|
|
@@ -4443,6 +4814,7 @@
|
|
|
4443
4814
|
"in": "query",
|
|
4444
4815
|
"required": false,
|
|
4445
4816
|
"type": "string",
|
|
4817
|
+
"example": "1067983",
|
|
4446
4818
|
"description": "Institution CIK (at least one of cik or identifier required)"
|
|
4447
4819
|
},
|
|
4448
4820
|
{
|
|
@@ -4450,6 +4822,7 @@
|
|
|
4450
4822
|
"in": "query",
|
|
4451
4823
|
"required": false,
|
|
4452
4824
|
"type": "string",
|
|
4825
|
+
"example": "AAPL",
|
|
4453
4826
|
"description": "Company ticker symbol or CIK (at least one of cik or identifier required)",
|
|
4454
4827
|
"alias": "i"
|
|
4455
4828
|
},
|
|
@@ -4458,6 +4831,7 @@
|
|
|
4458
4831
|
"in": "query",
|
|
4459
4832
|
"required": false,
|
|
4460
4833
|
"type": "string",
|
|
4834
|
+
"example": "2025-01-01",
|
|
4461
4835
|
"description": "Filter transactions with period_end_new on or after this date (YYYY-MM-DD)"
|
|
4462
4836
|
},
|
|
4463
4837
|
{
|
|
@@ -4465,6 +4839,7 @@
|
|
|
4465
4839
|
"in": "query",
|
|
4466
4840
|
"required": false,
|
|
4467
4841
|
"type": "string",
|
|
4842
|
+
"example": "2025-12-31",
|
|
4468
4843
|
"description": "Filter transactions with period_end_new on or before this date (YYYY-MM-DD)"
|
|
4469
4844
|
},
|
|
4470
4845
|
{
|
|
@@ -4478,6 +4853,7 @@
|
|
|
4478
4853
|
"reduced",
|
|
4479
4854
|
"sold_out"
|
|
4480
4855
|
],
|
|
4856
|
+
"example": "new_buy",
|
|
4481
4857
|
"description": "Filter by transaction type: new_buy, added, reduced, sold_out"
|
|
4482
4858
|
},
|
|
4483
4859
|
{
|
|
@@ -4485,6 +4861,7 @@
|
|
|
4485
4861
|
"in": "query",
|
|
4486
4862
|
"required": false,
|
|
4487
4863
|
"type": "integer",
|
|
4864
|
+
"example": 2025,
|
|
4488
4865
|
"description": "Filter by calendar year (of new position)"
|
|
4489
4866
|
},
|
|
4490
4867
|
{
|
|
@@ -4492,6 +4869,7 @@
|
|
|
4492
4869
|
"in": "query",
|
|
4493
4870
|
"required": false,
|
|
4494
4871
|
"type": "integer",
|
|
4872
|
+
"example": 1,
|
|
4495
4873
|
"description": "Filter by calendar quarter (of new position)"
|
|
4496
4874
|
},
|
|
4497
4875
|
{
|
|
@@ -4504,6 +4882,7 @@
|
|
|
4504
4882
|
"desc"
|
|
4505
4883
|
],
|
|
4506
4884
|
"default": "desc",
|
|
4885
|
+
"example": "desc",
|
|
4507
4886
|
"description": "Sort direction by period_end_new: 'asc' (oldest first), 'desc' (newest first)",
|
|
4508
4887
|
"alias": "s"
|
|
4509
4888
|
},
|
|
@@ -4513,6 +4892,7 @@
|
|
|
4513
4892
|
"required": false,
|
|
4514
4893
|
"type": "integer",
|
|
4515
4894
|
"default": 100,
|
|
4895
|
+
"example": 5,
|
|
4516
4896
|
"description": "Maximum number of transactions to return (1-1000)",
|
|
4517
4897
|
"alias": "l"
|
|
4518
4898
|
},
|
|
@@ -4522,9 +4902,13 @@
|
|
|
4522
4902
|
"required": false,
|
|
4523
4903
|
"type": "integer",
|
|
4524
4904
|
"default": 0,
|
|
4905
|
+
"example": 0,
|
|
4525
4906
|
"description": "Number of transactions to skip for pagination"
|
|
4526
4907
|
}
|
|
4527
4908
|
],
|
|
4909
|
+
"exampleParams": [
|
|
4910
|
+
"cik"
|
|
4911
|
+
],
|
|
4528
4912
|
"view": "table",
|
|
4529
4913
|
"rowsPath": "transactions",
|
|
4530
4914
|
"columns": [
|
|
@@ -4572,6 +4956,7 @@
|
|
|
4572
4956
|
"in": "query",
|
|
4573
4957
|
"required": true,
|
|
4574
4958
|
"type": "string",
|
|
4959
|
+
"example": "AAPL",
|
|
4575
4960
|
"description": "Ticker symbol or CIK",
|
|
4576
4961
|
"alias": "i"
|
|
4577
4962
|
},
|
|
@@ -4586,6 +4971,7 @@
|
|
|
4586
4971
|
"ytd",
|
|
4587
4972
|
"ttm"
|
|
4588
4973
|
],
|
|
4974
|
+
"example": "annual",
|
|
4589
4975
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4590
4976
|
"alias": "p"
|
|
4591
4977
|
},
|
|
@@ -4603,6 +4989,7 @@
|
|
|
4603
4989
|
"seg_selling_and_marketing_expenses_business_segment",
|
|
4604
4990
|
"seg_general_and_administrative_expenses_business_segment"
|
|
4605
4991
|
],
|
|
4992
|
+
"example": "seg_revenue_product",
|
|
4606
4993
|
"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
4994
|
},
|
|
4608
4995
|
{
|
|
@@ -4615,6 +5002,7 @@
|
|
|
4615
5002
|
"desc"
|
|
4616
5003
|
],
|
|
4617
5004
|
"default": "desc",
|
|
5005
|
+
"example": "desc",
|
|
4618
5006
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4619
5007
|
"alias": "s"
|
|
4620
5008
|
},
|
|
@@ -4624,6 +5012,7 @@
|
|
|
4624
5012
|
"required": false,
|
|
4625
5013
|
"type": "integer",
|
|
4626
5014
|
"default": 10,
|
|
5015
|
+
"example": 5,
|
|
4627
5016
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4628
5017
|
"alias": "l"
|
|
4629
5018
|
},
|
|
@@ -4633,6 +5022,7 @@
|
|
|
4633
5022
|
"required": false,
|
|
4634
5023
|
"type": "integer",
|
|
4635
5024
|
"default": 0,
|
|
5025
|
+
"example": 0,
|
|
4636
5026
|
"description": "Number of periods to skip for pagination"
|
|
4637
5027
|
}
|
|
4638
5028
|
],
|
|
@@ -4656,6 +5046,7 @@
|
|
|
4656
5046
|
"in": "query",
|
|
4657
5047
|
"required": true,
|
|
4658
5048
|
"type": "string",
|
|
5049
|
+
"example": "AAPL",
|
|
4659
5050
|
"description": "Ticker symbol or CIK",
|
|
4660
5051
|
"alias": "i"
|
|
4661
5052
|
},
|
|
@@ -4670,6 +5061,7 @@
|
|
|
4670
5061
|
"ytd",
|
|
4671
5062
|
"ttm"
|
|
4672
5063
|
],
|
|
5064
|
+
"example": "annual",
|
|
4673
5065
|
"description": "Type of fiscal period: 'quarterly' (Q1-Q4), 'annual' (full year), 'ytd' (year-to-date), 'ttm' (trailing twelve months)",
|
|
4674
5066
|
"alias": "p"
|
|
4675
5067
|
},
|
|
@@ -4687,6 +5079,7 @@
|
|
|
4687
5079
|
"seg_selling_and_marketing_expenses_business_segment",
|
|
4688
5080
|
"seg_general_and_administrative_expenses_business_segment"
|
|
4689
5081
|
],
|
|
5082
|
+
"example": "seg_revenue_product",
|
|
4690
5083
|
"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
5084
|
},
|
|
4692
5085
|
{
|
|
@@ -4699,6 +5092,7 @@
|
|
|
4699
5092
|
"desc"
|
|
4700
5093
|
],
|
|
4701
5094
|
"default": "desc",
|
|
5095
|
+
"example": "desc",
|
|
4702
5096
|
"description": "Sort direction for periods by period_end: 'asc' (oldest first), 'desc' (newest first)",
|
|
4703
5097
|
"alias": "s"
|
|
4704
5098
|
},
|
|
@@ -4708,6 +5102,7 @@
|
|
|
4708
5102
|
"required": false,
|
|
4709
5103
|
"type": "integer",
|
|
4710
5104
|
"default": 10,
|
|
5105
|
+
"example": 5,
|
|
4711
5106
|
"description": "Maximum number of periods per ticker (1-100)",
|
|
4712
5107
|
"alias": "l"
|
|
4713
5108
|
},
|
|
@@ -4717,6 +5112,7 @@
|
|
|
4717
5112
|
"required": false,
|
|
4718
5113
|
"type": "integer",
|
|
4719
5114
|
"default": 0,
|
|
5115
|
+
"example": 0,
|
|
4720
5116
|
"description": "Number of periods to skip for pagination"
|
|
4721
5117
|
}
|
|
4722
5118
|
],
|
|
@@ -4778,6 +5174,7 @@
|
|
|
4778
5174
|
"90"
|
|
4779
5175
|
],
|
|
4780
5176
|
"default": 30,
|
|
5177
|
+
"example": 30,
|
|
4781
5178
|
"description": "Window in UTC days ending today (inclusive): 7, 30 or 90"
|
|
4782
5179
|
}
|
|
4783
5180
|
],
|
|
@@ -4804,7 +5201,20 @@
|
|
|
4804
5201
|
"params": [],
|
|
4805
5202
|
"body": {
|
|
4806
5203
|
"required": true,
|
|
4807
|
-
"contentType": "application/json"
|
|
5204
|
+
"contentType": "application/json",
|
|
5205
|
+
"example": {
|
|
5206
|
+
"url": "https://hooks.example.com/invinite",
|
|
5207
|
+
"events": [
|
|
5208
|
+
"earnings_call.transcript_ready",
|
|
5209
|
+
"earnings_call.ended"
|
|
5210
|
+
],
|
|
5211
|
+
"filters": {
|
|
5212
|
+
"ciks": [
|
|
5213
|
+
"0000789019",
|
|
5214
|
+
"0000320193"
|
|
5215
|
+
]
|
|
5216
|
+
}
|
|
5217
|
+
}
|
|
4808
5218
|
},
|
|
4809
5219
|
"view": "keyValue",
|
|
4810
5220
|
"columns": [
|
|
@@ -4835,6 +5245,7 @@
|
|
|
4835
5245
|
"in": "path",
|
|
4836
5246
|
"required": true,
|
|
4837
5247
|
"type": "string",
|
|
5248
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4838
5249
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4839
5250
|
}
|
|
4840
5251
|
],
|
|
@@ -4855,6 +5266,7 @@
|
|
|
4855
5266
|
"in": "path",
|
|
4856
5267
|
"required": true,
|
|
4857
5268
|
"type": "string",
|
|
5269
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4858
5270
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4859
5271
|
}
|
|
4860
5272
|
],
|
|
@@ -4910,6 +5322,7 @@
|
|
|
4910
5322
|
"in": "path",
|
|
4911
5323
|
"required": true,
|
|
4912
5324
|
"type": "string",
|
|
5325
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4913
5326
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4914
5327
|
}
|
|
4915
5328
|
],
|
|
@@ -4934,6 +5347,7 @@
|
|
|
4934
5347
|
"in": "path",
|
|
4935
5348
|
"required": true,
|
|
4936
5349
|
"type": "string",
|
|
5350
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4937
5351
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4938
5352
|
}
|
|
4939
5353
|
],
|
|
@@ -4958,12 +5372,19 @@
|
|
|
4958
5372
|
"in": "path",
|
|
4959
5373
|
"required": true,
|
|
4960
5374
|
"type": "string",
|
|
5375
|
+
"example": "js7a2c9xq4m8v1k6t3w5r0n2b8gnd4fh",
|
|
4961
5376
|
"description": "Webhook subscription id (from the create / list response)"
|
|
4962
5377
|
}
|
|
4963
5378
|
],
|
|
4964
5379
|
"body": {
|
|
4965
5380
|
"required": false,
|
|
4966
|
-
"contentType": "application/json"
|
|
5381
|
+
"contentType": "application/json",
|
|
5382
|
+
"example": {
|
|
5383
|
+
"events": [
|
|
5384
|
+
"earnings_call.transcript_ready"
|
|
5385
|
+
],
|
|
5386
|
+
"active": true
|
|
5387
|
+
}
|
|
4967
5388
|
},
|
|
4968
5389
|
"view": "keyValue",
|
|
4969
5390
|
"columns": [
|