@invinite-org/invinite-data-cli 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "specVersion": "1.0.0",
3
- "specSha256": "587da531928006a2a7259d0f0ca16b340afffbf652b13603890f4579dcacea59",
3
+ "specSha256": "6c548f91ff9a962b3dd46e4059a57540f1bee64691c69d704d6de35cef78190b",
4
4
  "groups": [
5
5
  {
6
6
  "name": "company",
@@ -42,6 +42,10 @@
42
42
  "name": "metrics",
43
43
  "description": "Ratios, growth and CAGR derived from the statements"
44
44
  },
45
+ {
46
+ "name": "news",
47
+ "description": "News of US companies from SEC filings and their own newsrooms: items, full text with attribution, developments and files"
48
+ },
45
49
  {
46
50
  "name": "ownership",
47
51
  "description": "13F holdings, holders and position changes of institutional investors"
@@ -79,7 +83,7 @@
79
83
  "required": true,
80
84
  "type": "string",
81
85
  "example": "AAPL",
82
- "description": "Ticker symbol or CIK",
86
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
83
87
  "alias": "i"
84
88
  }
85
89
  ],
@@ -139,7 +143,7 @@
139
143
  "required": true,
140
144
  "type": "string",
141
145
  "example": "AAPL",
142
- "description": "Ticker symbol or CIK",
146
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
143
147
  "alias": "i"
144
148
  },
145
149
  {
@@ -223,7 +227,7 @@
223
227
  "required": true,
224
228
  "type": "string",
225
229
  "example": "AAPL",
226
- "description": "Ticker symbol or CIK",
230
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
227
231
  "alias": "i"
228
232
  },
229
233
  {
@@ -358,7 +362,7 @@
358
362
  "required": true,
359
363
  "type": "string",
360
364
  "example": "AAPL",
361
- "description": "Ticker symbol or CIK",
365
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
362
366
  "alias": "i"
363
367
  },
364
368
  {
@@ -1136,8 +1140,8 @@
1136
1140
  "in": "query",
1137
1141
  "required": true,
1138
1142
  "type": "string",
1139
- "example": "revenue",
1140
- "description": "Normalized metric (e.g. revenue, eps_non_gaap, segment:iphone)"
1143
+ "example": "revenue_growth",
1144
+ "description": "Normalized metric (e.g. revenue, eps_non_gaap, revenue_growth, segment:iphone)"
1141
1145
  },
1142
1146
  {
1143
1147
  "name": "period_kind",
@@ -2298,7 +2302,7 @@
2298
2302
  "required": true,
2299
2303
  "type": "string",
2300
2304
  "example": "AAPL",
2301
- "description": "Ticker symbol or CIK",
2305
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2302
2306
  "alias": "i"
2303
2307
  },
2304
2308
  {
@@ -2320,7 +2324,7 @@
2320
2324
  "required": false,
2321
2325
  "type": "string",
2322
2326
  "example": "part_i-item_1a",
2323
- "description": "Optional section ID. If not specified, all sections from the filing are returned."
2327
+ "description": "Optional section ID. If not specified, all sections from the filing are returned. A section the filing does not have answers 404 with the section IDs it has."
2324
2328
  },
2325
2329
  {
2326
2330
  "name": "accession_number",
@@ -2368,7 +2372,7 @@
2368
2372
  "required": true,
2369
2373
  "type": "string",
2370
2374
  "example": "AAPL",
2371
- "description": "Ticker symbol or CIK",
2375
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2372
2376
  "alias": "i"
2373
2377
  },
2374
2378
  {
@@ -2441,7 +2445,7 @@
2441
2445
  "required": true,
2442
2446
  "type": "string",
2443
2447
  "example": "AAPL",
2444
- "description": "Ticker symbol or CIK",
2448
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2445
2449
  "alias": "i"
2446
2450
  },
2447
2451
  {
@@ -2527,7 +2531,7 @@
2527
2531
  "required": true,
2528
2532
  "type": "string",
2529
2533
  "example": "AAPL",
2530
- "description": "Ticker symbol or CIK",
2534
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2531
2535
  "alias": "i"
2532
2536
  },
2533
2537
  {
@@ -2600,7 +2604,7 @@
2600
2604
  "required": true,
2601
2605
  "type": "string",
2602
2606
  "example": "AAPL",
2603
- "description": "Ticker symbol or CIK",
2607
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2604
2608
  "alias": "i"
2605
2609
  },
2606
2610
  {
@@ -2673,7 +2677,7 @@
2673
2677
  "required": true,
2674
2678
  "type": "string",
2675
2679
  "example": "AAPL",
2676
- "description": "Ticker symbol or CIK",
2680
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2677
2681
  "alias": "i"
2678
2682
  },
2679
2683
  {
@@ -2759,7 +2763,7 @@
2759
2763
  "required": true,
2760
2764
  "type": "string",
2761
2765
  "example": "AAPL",
2762
- "description": "Ticker symbol or CIK",
2766
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2763
2767
  "alias": "i"
2764
2768
  },
2765
2769
  {
@@ -2832,7 +2836,7 @@
2832
2836
  "required": true,
2833
2837
  "type": "string",
2834
2838
  "example": "AAPL",
2835
- "description": "Ticker symbol or CIK",
2839
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2836
2840
  "alias": "i"
2837
2841
  },
2838
2842
  {
@@ -2905,7 +2909,7 @@
2905
2909
  "required": true,
2906
2910
  "type": "string",
2907
2911
  "example": "AAPL",
2908
- "description": "Ticker symbol or CIK",
2912
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2909
2913
  "alias": "i"
2910
2914
  },
2911
2915
  {
@@ -2991,7 +2995,7 @@
2991
2995
  "required": true,
2992
2996
  "type": "string",
2993
2997
  "example": "AAPL",
2994
- "description": "Ticker symbol or CIK",
2998
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
2995
2999
  "alias": "i"
2996
3000
  },
2997
3001
  {
@@ -3064,7 +3068,7 @@
3064
3068
  "required": true,
3065
3069
  "type": "string",
3066
3070
  "example": "AAPL,MSFT",
3067
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
3071
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3068
3072
  "alias": "i"
3069
3073
  },
3070
3074
  {
@@ -3117,7 +3121,7 @@
3117
3121
  "required": true,
3118
3122
  "type": "string",
3119
3123
  "example": "AAPL,MSFT",
3120
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
3124
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3121
3125
  "alias": "i"
3122
3126
  },
3123
3127
  {
@@ -3183,7 +3187,7 @@
3183
3187
  "required": true,
3184
3188
  "type": "string",
3185
3189
  "example": "AAPL,MSFT",
3186
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
3190
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3187
3191
  "alias": "i"
3188
3192
  },
3189
3193
  {
@@ -3236,7 +3240,7 @@
3236
3240
  "required": true,
3237
3241
  "type": "string",
3238
3242
  "example": "AAPL",
3239
- "description": "Ticker symbol or CIK",
3243
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3240
3244
  "alias": "i"
3241
3245
  },
3242
3246
  {
@@ -3309,7 +3313,7 @@
3309
3313
  "required": true,
3310
3314
  "type": "string",
3311
3315
  "example": "AAPL",
3312
- "description": "Ticker symbol or CIK",
3316
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3313
3317
  "alias": "i"
3314
3318
  },
3315
3319
  {
@@ -3395,7 +3399,7 @@
3395
3399
  "required": true,
3396
3400
  "type": "string",
3397
3401
  "example": "AAPL",
3398
- "description": "Ticker symbol or CIK",
3402
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3399
3403
  "alias": "i"
3400
3404
  },
3401
3405
  {
@@ -3468,7 +3472,7 @@
3468
3472
  "required": true,
3469
3473
  "type": "string",
3470
3474
  "example": "AAPL",
3471
- "description": "Ticker symbol or CIK",
3475
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3472
3476
  "alias": "i"
3473
3477
  },
3474
3478
  {
@@ -3541,7 +3545,7 @@
3541
3545
  "required": true,
3542
3546
  "type": "string",
3543
3547
  "example": "AAPL",
3544
- "description": "Ticker symbol or CIK",
3548
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3545
3549
  "alias": "i"
3546
3550
  },
3547
3551
  {
@@ -3627,7 +3631,7 @@
3627
3631
  "required": true,
3628
3632
  "type": "string",
3629
3633
  "example": "AAPL",
3630
- "description": "Ticker symbol or CIK",
3634
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3631
3635
  "alias": "i"
3632
3636
  },
3633
3637
  {
@@ -3700,7 +3704,7 @@
3700
3704
  "required": true,
3701
3705
  "type": "string",
3702
3706
  "example": "AAPL",
3703
- "description": "Ticker symbol or CIK",
3707
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3704
3708
  "alias": "i"
3705
3709
  },
3706
3710
  {
@@ -3773,7 +3777,7 @@
3773
3777
  "required": true,
3774
3778
  "type": "string",
3775
3779
  "example": "AAPL",
3776
- "description": "Ticker symbol or CIK",
3780
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3777
3781
  "alias": "i"
3778
3782
  },
3779
3783
  {
@@ -3859,7 +3863,7 @@
3859
3863
  "required": true,
3860
3864
  "type": "string",
3861
3865
  "example": "AAPL",
3862
- "description": "Ticker symbol or CIK",
3866
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3863
3867
  "alias": "i"
3864
3868
  },
3865
3869
  {
@@ -3932,7 +3936,7 @@
3932
3936
  "required": true,
3933
3937
  "type": "string",
3934
3938
  "example": "AAPL,MSFT",
3935
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
3939
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3936
3940
  "alias": "i"
3937
3941
  },
3938
3942
  {
@@ -3985,7 +3989,7 @@
3985
3989
  "required": true,
3986
3990
  "type": "string",
3987
3991
  "example": "AAPL,MSFT",
3988
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
3992
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
3989
3993
  "alias": "i"
3990
3994
  },
3991
3995
  {
@@ -4051,7 +4055,7 @@
4051
4055
  "required": true,
4052
4056
  "type": "string",
4053
4057
  "example": "AAPL,MSFT",
4054
- "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers)",
4058
+ "description": "Comma-separated list of ticker symbols or CIKs (1-10 identifiers). Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4055
4059
  "alias": "i"
4056
4060
  },
4057
4061
  {
@@ -4120,7 +4124,7 @@
4120
4124
  "required": true,
4121
4125
  "type": "string",
4122
4126
  "example": "AAPL",
4123
- "description": "Company ticker symbol or CIK",
4127
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4124
4128
  "alias": "i"
4125
4129
  },
4126
4130
  {
@@ -4501,7 +4505,7 @@
4501
4505
  "required": true,
4502
4506
  "type": "string",
4503
4507
  "example": "AAPL",
4504
- "description": "Ticker symbol or CIK",
4508
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4505
4509
  "alias": "i"
4506
4510
  },
4507
4511
  {
@@ -4572,7 +4576,7 @@
4572
4576
  "required": true,
4573
4577
  "type": "string",
4574
4578
  "example": "AAPL",
4575
- "description": "Ticker symbol or CIK",
4579
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4576
4580
  "alias": "i"
4577
4581
  },
4578
4582
  {
@@ -4657,7 +4661,7 @@
4657
4661
  "required": true,
4658
4662
  "type": "string",
4659
4663
  "example": "AAPL",
4660
- "description": "Ticker symbol or CIK",
4664
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4661
4665
  "alias": "i"
4662
4666
  },
4663
4667
  {
@@ -4729,6 +4733,568 @@
4729
4733
  "periods"
4730
4734
  ]
4731
4735
  },
4736
+ {
4737
+ "operationId": "newsAssetDownload",
4738
+ "group": "news",
4739
+ "action": "asset-download",
4740
+ "method": "get",
4741
+ "path": "/v1/news/{id}/assets/{asset_id}/download",
4742
+ "auth": true,
4743
+ "summary": "Get a short-lived URL of a news image or file",
4744
+ "params": [
4745
+ {
4746
+ "name": "id",
4747
+ "in": "path",
4748
+ "required": true,
4749
+ "type": "string",
4750
+ "example": "4c1d9e62-3b7a-4f2e-8d1c-9e0a7b6c5d4f",
4751
+ "description": "News item id"
4752
+ },
4753
+ {
4754
+ "name": "asset_id",
4755
+ "in": "path",
4756
+ "required": true,
4757
+ "type": "string",
4758
+ "example": "7e2f0c19-5a8b-4d3e-9f1a-2b6c8d0e4a7b",
4759
+ "description": "Asset id (`assets[].id` of the item)"
4760
+ }
4761
+ ],
4762
+ "view": "keyValue",
4763
+ "columns": [
4764
+ "purpose",
4765
+ "url",
4766
+ "expires_at",
4767
+ "content_type",
4768
+ "credit"
4769
+ ],
4770
+ "pagination": "none"
4771
+ },
4772
+ {
4773
+ "operationId": "newsDevelopments",
4774
+ "group": "news",
4775
+ "action": "developments",
4776
+ "method": "get",
4777
+ "path": "/v1/news/developments",
4778
+ "auth": true,
4779
+ "summary": "List company developments from news",
4780
+ "params": [
4781
+ {
4782
+ "name": "publisher",
4783
+ "in": "query",
4784
+ "required": false,
4785
+ "type": "array",
4786
+ "items": "string",
4787
+ "example": [
4788
+ "1045810"
4789
+ ],
4790
+ "description": "Published by these companies (CIK, padded or not; ≤ 20): an item with a verified issuer-newsroom publication of one of them — not a mention, not the item's first source. The CIK namespace is the SEC's"
4791
+ },
4792
+ {
4793
+ "name": "topic",
4794
+ "in": "query",
4795
+ "required": false,
4796
+ "type": "array",
4797
+ "items": "string",
4798
+ "example": [
4799
+ "product_launch"
4800
+ ],
4801
+ "description": "Only these topics, comma-separated or repeated: product_launch, product_update, availability, partnership, customer_contract, capacity_expansion, regulatory, research"
4802
+ },
4803
+ {
4804
+ "name": "item_id",
4805
+ "in": "query",
4806
+ "required": false,
4807
+ "type": "string",
4808
+ "example": "4c1d9e62-3b7a-4f2e-8d1c-9e0a7b6c5d4f",
4809
+ "description": "Only the developments of this news item"
4810
+ },
4811
+ {
4812
+ "name": "from",
4813
+ "in": "query",
4814
+ "required": false,
4815
+ "type": "string",
4816
+ "example": "2026-10-22",
4817
+ "description": "Start of the announcement window: an ISO 8601 instant or a day (YYYY-MM-DD, from its UTC midnight). Default: `to` minus 7 days"
4818
+ },
4819
+ {
4820
+ "name": "to",
4821
+ "in": "query",
4822
+ "required": false,
4823
+ "type": "string",
4824
+ "example": "2026-10-29",
4825
+ "description": "End of the announcement window: an ISO 8601 instant (exclusive) or a day (inclusive). Default: now. At most 92 days after `from` (400 otherwise)"
4826
+ },
4827
+ {
4828
+ "name": "effective_from",
4829
+ "in": "query",
4830
+ "required": false,
4831
+ "type": "string",
4832
+ "example": "2026-10-01",
4833
+ "description": "Effective on or after this day (developments without an effective date are left out)"
4834
+ },
4835
+ {
4836
+ "name": "effective_to",
4837
+ "in": "query",
4838
+ "required": false,
4839
+ "type": "string",
4840
+ "example": "2026-12-31",
4841
+ "description": "Effective on or before this day (developments without an effective date are left out)"
4842
+ },
4843
+ {
4844
+ "name": "limit",
4845
+ "in": "query",
4846
+ "required": false,
4847
+ "type": "integer",
4848
+ "default": 50,
4849
+ "example": 20,
4850
+ "description": "Developments per page"
4851
+ },
4852
+ {
4853
+ "name": "cursor",
4854
+ "in": "query",
4855
+ "required": false,
4856
+ "type": "string",
4857
+ "example": "WyIyMDI2LTEwLTI5VDIwOjMwOjA1LjEyMzQ1NloiLCI0YzFkOWU2Mi0zYjdhLTRmMmUtOGQxYy05ZTBhN2I2YzVkNGYiXQ",
4858
+ "description": "`next_cursor` of the previous page (with the same filters); an altered or foreign cursor is a 400 `invalid_cursor`"
4859
+ }
4860
+ ],
4861
+ "view": "table",
4862
+ "rowsPath": "developments",
4863
+ "columns": [
4864
+ "announced_at",
4865
+ "topic",
4866
+ "claim_status",
4867
+ "title",
4868
+ "item.attribution.publisher"
4869
+ ],
4870
+ "pagination": "top",
4871
+ "allItemsPath": [
4872
+ "developments"
4873
+ ]
4874
+ },
4875
+ {
4876
+ "operationId": "newsItem",
4877
+ "group": "news",
4878
+ "action": "get",
4879
+ "method": "get",
4880
+ "path": "/v1/news/{id}",
4881
+ "auth": true,
4882
+ "summary": "Get a news item",
4883
+ "params": [
4884
+ {
4885
+ "name": "id",
4886
+ "in": "path",
4887
+ "required": true,
4888
+ "type": "string",
4889
+ "example": "4c1d9e62-3b7a-4f2e-8d1c-9e0a7b6c5d4f",
4890
+ "description": "News item id"
4891
+ }
4892
+ ],
4893
+ "view": "keyValue",
4894
+ "columns": [
4895
+ "id",
4896
+ "published_at",
4897
+ "title",
4898
+ "kind",
4899
+ "source.id",
4900
+ "url",
4901
+ "content_status",
4902
+ "attribution.publisher",
4903
+ "attribution.publisher_host",
4904
+ "attribution.source_url",
4905
+ "attribution.published_at",
4906
+ "attribution.rights",
4907
+ "attribution.edgar.form",
4908
+ "attribution.edgar.accession",
4909
+ "attribution.statement",
4910
+ "body_text"
4911
+ ],
4912
+ "pagination": "none"
4913
+ },
4914
+ {
4915
+ "operationId": "newsItems",
4916
+ "group": "news",
4917
+ "action": "list",
4918
+ "method": "get",
4919
+ "path": "/v1/news",
4920
+ "auth": true,
4921
+ "summary": "List news items",
4922
+ "params": [
4923
+ {
4924
+ "name": "ticker",
4925
+ "in": "query",
4926
+ "required": false,
4927
+ "type": "array",
4928
+ "items": "string",
4929
+ "example": [
4930
+ "NVDA"
4931
+ ],
4932
+ "description": "Items mentioning these tickers (≤ 20, comma-separated or repeated). `BRK.B` and `BRK-B` both match; responses carry the stored dash spelling. With `cik`, either matches"
4933
+ },
4934
+ {
4935
+ "name": "cik",
4936
+ "in": "query",
4937
+ "required": false,
4938
+ "type": "array",
4939
+ "items": "string",
4940
+ "example": [
4941
+ "1045810"
4942
+ ],
4943
+ "description": "Items mentioning these companies by CIK (padded or not, ≤ 20). With `ticker`, either matches"
4944
+ },
4945
+ {
4946
+ "name": "from",
4947
+ "in": "query",
4948
+ "required": false,
4949
+ "type": "string",
4950
+ "example": "2026-10-22",
4951
+ "description": "Start of the publication window: an ISO 8601 instant or a day (YYYY-MM-DD, from its UTC midnight). Default: `to` minus 7 days"
4952
+ },
4953
+ {
4954
+ "name": "to",
4955
+ "in": "query",
4956
+ "required": false,
4957
+ "type": "string",
4958
+ "example": "2026-10-29",
4959
+ "description": "End of the publication window: an ISO 8601 instant (exclusive) or a day (inclusive). Default: now. At most 92 days after `from` (400 otherwise)"
4960
+ },
4961
+ {
4962
+ "name": "source",
4963
+ "in": "query",
4964
+ "required": false,
4965
+ "type": "array",
4966
+ "items": "string",
4967
+ "example": [
4968
+ "edgar"
4969
+ ],
4970
+ "description": "The item's FIRST source: `edgar` (an SEC filing) or `ir` (any company newsroom), comma-separated or repeated"
4971
+ },
4972
+ {
4973
+ "name": "kind",
4974
+ "in": "query",
4975
+ "required": false,
4976
+ "type": "array",
4977
+ "items": "string",
4978
+ "example": [
4979
+ "earnings_results"
4980
+ ],
4981
+ "description": "Only these kinds, comma-separated or repeated: earnings_results, results_date, call_announcement, event_announcement, guidance, m_and_a, material_agreement, management_change, dividend, capital_markets, legal_spam, promo, other"
4982
+ },
4983
+ {
4984
+ "name": "topic",
4985
+ "in": "query",
4986
+ "required": false,
4987
+ "type": "array",
4988
+ "items": "string",
4989
+ "example": [
4990
+ "product_launch"
4991
+ ],
4992
+ "description": "Only these topics (any of them), comma-separated or repeated: product_launch, product_update, availability, partnership, customer_contract, capacity_expansion, regulatory, research, other"
4993
+ },
4994
+ {
4995
+ "name": "earnings",
4996
+ "in": "query",
4997
+ "required": false,
4998
+ "type": "string",
4999
+ "enum": [
5000
+ "true",
5001
+ "false"
5002
+ ],
5003
+ "example": "true",
5004
+ "description": "true = only earnings news (results, results dates, call announcements, guidance); false = none of it"
5005
+ },
5006
+ {
5007
+ "name": "publisher",
5008
+ "in": "query",
5009
+ "required": false,
5010
+ "type": "array",
5011
+ "items": "string",
5012
+ "example": [
5013
+ "1045810"
5014
+ ],
5015
+ "description": "Published by these companies (CIK, padded or not; ≤ 20): an item with a verified issuer-newsroom publication of one of them — not a mention, not the item's first source. The CIK namespace is the SEC's"
5016
+ },
5017
+ {
5018
+ "name": "publication_type",
5019
+ "in": "query",
5020
+ "required": false,
5021
+ "type": "array",
5022
+ "items": "string",
5023
+ "example": [
5024
+ "press_release"
5025
+ ],
5026
+ "description": "Only these publication types of the issuer's own publication, comma-separated or repeated: press_release, company_blog, company_update"
5027
+ },
5028
+ {
5029
+ "name": "issuer_category",
5030
+ "in": "query",
5031
+ "required": false,
5032
+ "type": "array",
5033
+ "items": "string",
5034
+ "example": [
5035
+ "Press Releases"
5036
+ ],
5037
+ "description": "The publisher's own newsroom category, by exact label or by the publisher's category id (≤ 10); needs exactly one `publisher` — labels and ids are per newsroom"
5038
+ },
5039
+ {
5040
+ "name": "issuer_tag",
5041
+ "in": "query",
5042
+ "required": false,
5043
+ "type": "array",
5044
+ "items": "string",
5045
+ "example": [
5046
+ "Data Center"
5047
+ ],
5048
+ "description": "The publisher's own newsroom tag, by exact label or id (≤ 10); needs exactly one `publisher`"
5049
+ },
5050
+ {
5051
+ "name": "limit",
5052
+ "in": "query",
5053
+ "required": false,
5054
+ "type": "integer",
5055
+ "default": 50,
5056
+ "example": 20,
5057
+ "description": "Items per page"
5058
+ },
5059
+ {
5060
+ "name": "cursor",
5061
+ "in": "query",
5062
+ "required": false,
5063
+ "type": "string",
5064
+ "example": "WyIyMDI2LTEwLTI5VDIwOjMwOjA1LjEyMzQ1NloiLCI0YzFkOWU2Mi0zYjdhLTRmMmUtOGQxYy05ZTBhN2I2YzVkNGYiXQ",
5065
+ "description": "`next_cursor` of the previous page (with the same filters); an altered or foreign cursor is a 400 `invalid_cursor`"
5066
+ }
5067
+ ],
5068
+ "view": "table",
5069
+ "rowsPath": "items",
5070
+ "columns": [
5071
+ "published_at",
5072
+ "source.id",
5073
+ "kind",
5074
+ "is_earnings_news",
5075
+ "symbols",
5076
+ "title",
5077
+ "attribution.publisher"
5078
+ ],
5079
+ "pagination": "top",
5080
+ "allItemsPath": [
5081
+ "items"
5082
+ ]
5083
+ },
5084
+ {
5085
+ "operationId": "newsSearch",
5086
+ "group": "news",
5087
+ "action": "search",
5088
+ "method": "get",
5089
+ "path": "/v1/news/search",
5090
+ "auth": true,
5091
+ "summary": "Search news",
5092
+ "params": [
5093
+ {
5094
+ "name": "q",
5095
+ "in": "query",
5096
+ "required": true,
5097
+ "type": "string",
5098
+ "example": "data center revenue",
5099
+ "description": "The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for",
5100
+ "alias": "q"
5101
+ },
5102
+ {
5103
+ "name": "mode",
5104
+ "in": "query",
5105
+ "required": false,
5106
+ "type": "string",
5107
+ "enum": [
5108
+ "lexical",
5109
+ "literal"
5110
+ ],
5111
+ "default": "lexical",
5112
+ "example": "lexical",
5113
+ "description": "lexical (keywords and phrases, default) or literal (exact characters)",
5114
+ "alias": "m"
5115
+ },
5116
+ {
5117
+ "name": "case_sensitive",
5118
+ "in": "query",
5119
+ "required": false,
5120
+ "type": "string",
5121
+ "enum": [
5122
+ "true",
5123
+ "false"
5124
+ ],
5125
+ "example": "false",
5126
+ "description": "mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)"
5127
+ },
5128
+ {
5129
+ "name": "field",
5130
+ "in": "query",
5131
+ "required": false,
5132
+ "type": "string",
5133
+ "enum": [
5134
+ "title",
5135
+ "body",
5136
+ "any"
5137
+ ],
5138
+ "default": "any",
5139
+ "example": "any",
5140
+ "description": "title = headlines and ledes, body = the item text, any = both"
5141
+ },
5142
+ {
5143
+ "name": "ticker",
5144
+ "in": "query",
5145
+ "required": false,
5146
+ "type": "array",
5147
+ "items": "string",
5148
+ "example": [
5149
+ "NVDA"
5150
+ ],
5151
+ "description": "Items mentioning these tickers (≤ 20, comma-separated or repeated). `BRK.B` and `BRK-B` both match; responses carry the stored dash spelling. With `cik`, either matches",
5152
+ "alias": "t"
5153
+ },
5154
+ {
5155
+ "name": "cik",
5156
+ "in": "query",
5157
+ "required": false,
5158
+ "type": "array",
5159
+ "items": "string",
5160
+ "example": [
5161
+ "1045810"
5162
+ ],
5163
+ "description": "Items mentioning these companies by CIK (padded or not, ≤ 20). With `ticker`, either matches"
5164
+ },
5165
+ {
5166
+ "name": "publisher",
5167
+ "in": "query",
5168
+ "required": false,
5169
+ "type": "array",
5170
+ "items": "string",
5171
+ "example": [
5172
+ "1045810"
5173
+ ],
5174
+ "description": "Published by these companies (CIK, padded or not; ≤ 20): an item with a verified issuer-newsroom publication of one of them — not a mention, not the item's first source. The CIK namespace is the SEC's"
5175
+ },
5176
+ {
5177
+ "name": "kind",
5178
+ "in": "query",
5179
+ "required": false,
5180
+ "type": "array",
5181
+ "items": "string",
5182
+ "example": [
5183
+ "earnings_results"
5184
+ ],
5185
+ "description": "Only these kinds, comma-separated or repeated: earnings_results, results_date, call_announcement, event_announcement, guidance, m_and_a, material_agreement, management_change, dividend, capital_markets, legal_spam, promo, other"
5186
+ },
5187
+ {
5188
+ "name": "topic",
5189
+ "in": "query",
5190
+ "required": false,
5191
+ "type": "array",
5192
+ "items": "string",
5193
+ "example": [
5194
+ "product_launch"
5195
+ ],
5196
+ "description": "Only these topics (any of them), comma-separated or repeated: product_launch, product_update, availability, partnership, customer_contract, capacity_expansion, regulatory, research, other"
5197
+ },
5198
+ {
5199
+ "name": "from",
5200
+ "in": "query",
5201
+ "required": false,
5202
+ "type": "string",
5203
+ "example": "2026-07-01",
5204
+ "description": "Start of the publication window: an ISO 8601 instant or a day (YYYY-MM-DD, from its UTC midnight). Default: `to` minus 365 days"
5205
+ },
5206
+ {
5207
+ "name": "to",
5208
+ "in": "query",
5209
+ "required": false,
5210
+ "type": "string",
5211
+ "example": "2026-10-29",
5212
+ "description": "End of the publication window: an ISO 8601 instant (exclusive) or a day (inclusive). Default: now. At most 731 days after `from` (400 otherwise)"
5213
+ },
5214
+ {
5215
+ "name": "limit",
5216
+ "in": "query",
5217
+ "required": false,
5218
+ "type": "integer",
5219
+ "default": 5,
5220
+ "example": 5,
5221
+ "description": "Maximum number of passages (at most 8)",
5222
+ "alias": "l"
5223
+ }
5224
+ ],
5225
+ "exampleParams": [
5226
+ "ticker",
5227
+ "mode"
5228
+ ],
5229
+ "view": "table",
5230
+ "rowsPath": "hits",
5231
+ "columns": [
5232
+ "score",
5233
+ "match.type",
5234
+ "field",
5235
+ "item.published_at",
5236
+ "item.symbols",
5237
+ "item.title",
5238
+ "text"
5239
+ ],
5240
+ "pagination": "none"
5241
+ },
5242
+ {
5243
+ "operationId": "newsItemText",
5244
+ "group": "news",
5245
+ "action": "text",
5246
+ "method": "get",
5247
+ "path": "/v1/news/{id}/text",
5248
+ "auth": true,
5249
+ "summary": "Get a news item's text in blocks",
5250
+ "params": [
5251
+ {
5252
+ "name": "limit",
5253
+ "in": "query",
5254
+ "required": false,
5255
+ "type": "integer",
5256
+ "default": 10,
5257
+ "example": 20,
5258
+ "description": "Blocks per page"
5259
+ },
5260
+ {
5261
+ "name": "max_chars",
5262
+ "in": "query",
5263
+ "required": false,
5264
+ "type": "integer",
5265
+ "default": 12000,
5266
+ "example": 12000,
5267
+ "description": "Unicode code points per page; a block is never split (the minimum is the largest block)"
5268
+ },
5269
+ {
5270
+ "name": "cursor",
5271
+ "in": "query",
5272
+ "required": false,
5273
+ "type": "string",
5274
+ "example": "WyIyMDI2LTEwLTI5VDIwOjMwOjA1LjEyMzQ1NloiLCI0YzFkOWU2Mi0zYjdhLTRmMmUtOGQxYy05ZTBhN2I2YzVkNGYiXQ",
5275
+ "description": "`next_cursor` of the previous page (with the same filters); an altered or foreign cursor is a 400 `invalid_cursor`"
5276
+ },
5277
+ {
5278
+ "name": "id",
5279
+ "in": "path",
5280
+ "required": true,
5281
+ "type": "string",
5282
+ "example": "4c1d9e62-3b7a-4f2e-8d1c-9e0a7b6c5d4f",
5283
+ "description": "News item id"
5284
+ }
5285
+ ],
5286
+ "view": "table",
5287
+ "rowsPath": "blocks",
5288
+ "columns": [
5289
+ "index",
5290
+ "heading",
5291
+ "text"
5292
+ ],
5293
+ "pagination": "top",
5294
+ "allItemsPath": [
5295
+ "blocks"
5296
+ ]
5297
+ },
4732
5298
  {
4733
5299
  "operationId": "institutionalOwnershipHoldingsByCompany",
4734
5300
  "group": "ownership",
@@ -4744,7 +5310,7 @@
4744
5310
  "required": true,
4745
5311
  "type": "string",
4746
5312
  "example": "AAPL",
4747
- "description": "Company ticker symbol or CIK",
5313
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
4748
5314
  "alias": "i"
4749
5315
  },
4750
5316
  {
@@ -4989,7 +5555,7 @@
4989
5555
  "required": false,
4990
5556
  "type": "string",
4991
5557
  "example": "AAPL",
4992
- "description": "Company ticker symbol or CIK (at least one of cik or identifier required)",
5558
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. At least one of cik or identifier is required.",
4993
5559
  "alias": "i"
4994
5560
  },
4995
5561
  {
@@ -5123,7 +5689,7 @@
5123
5689
  "required": true,
5124
5690
  "type": "string",
5125
5691
  "example": "AAPL",
5126
- "description": "Ticker symbol or CIK",
5692
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
5127
5693
  "alias": "i"
5128
5694
  },
5129
5695
  {
@@ -5213,7 +5779,7 @@
5213
5779
  "required": true,
5214
5780
  "type": "string",
5215
5781
  "example": "AAPL",
5216
- "description": "Ticker symbol or CIK",
5782
+ "description": "Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404.",
5217
5783
  "alias": "i"
5218
5784
  },
5219
5785
  {