@invinite-org/invinite-data-cli 0.13.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +35 -3
  2. package/claude-plugin/agents/invinite-data.md +1 -1
  3. package/claude-plugin/skills/invinite-data-cli/SKILL.md +131 -27
  4. package/dist/src/cli.js +3 -1
  5. package/dist/src/cli.js.map +1 -1
  6. package/dist/src/client/api-client.d.ts +8 -0
  7. package/dist/src/client/api-client.js +16 -1
  8. package/dist/src/client/api-client.js.map +1 -1
  9. package/dist/src/client/download.d.ts +33 -0
  10. package/dist/src/client/download.js +101 -1
  11. package/dist/src/client/download.js.map +1 -1
  12. package/dist/src/commands/sec.d.ts +47 -0
  13. package/dist/src/commands/sec.js +191 -0
  14. package/dist/src/commands/sec.js.map +1 -0
  15. package/dist/src/formatters/table-formatter.d.ts +1 -0
  16. package/dist/src/formatters/table-formatter.js +12 -2
  17. package/dist/src/formatters/table-formatter.js.map +1 -1
  18. package/dist/src/generated/cli-manifest.json +1685 -217
  19. package/dist/src/hand-written-commands.d.ts +9 -0
  20. package/dist/src/hand-written-commands.js +3 -0
  21. package/dist/src/hand-written-commands.js.map +1 -1
  22. package/dist/src/shared/errors.d.ts +24 -1
  23. package/dist/src/shared/errors.js +41 -3
  24. package/dist/src/shared/errors.js.map +1 -1
  25. package/dist/src/shared/json-mode.d.ts +2 -0
  26. package/dist/src/shared/json-mode.js +12 -0
  27. package/dist/src/shared/json-mode.js.map +1 -0
  28. package/dist/src/shared/readiness.d.ts +4 -0
  29. package/dist/src/shared/readiness.js +46 -0
  30. package/dist/src/shared/readiness.js.map +1 -0
  31. package/dist/src/shared/spinner.js +2 -0
  32. package/dist/src/shared/spinner.js.map +1 -1
  33. package/dist/src/spec-commands.js +5 -1
  34. package/dist/src/spec-commands.js.map +1 -1
  35. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "specVersion": "1.0.0",
3
- "specSha256": "99044f5390ccb96f40ef3fd1b1b19cab54c7de89ec1000af86ed8b999ab57912",
3
+ "specSha256": "eeed886bbc63024fdde1a5a34fd91d022bc31359e93f2dc0ed2ce628bd252a48",
4
4
  "groups": [
5
5
  {
6
6
  "name": "company",
@@ -10,10 +10,6 @@
10
10
  "name": "earnings",
11
11
  "description": "Earnings calls: calendar, transcripts, Q&A, extractions, media, search and webhook subscriptions"
12
12
  },
13
- {
14
- "name": "filings",
15
- "description": "SEC filings, their parsed sections and natural-language filing search"
16
- },
17
13
  {
18
14
  "name": "financials",
19
15
  "description": "Financial statements (standardized & as-reported)"
@@ -50,6 +46,10 @@
50
46
  "name": "ownership",
51
47
  "description": "13F holdings, holders and position changes of institutional investors"
52
48
  },
49
+ {
50
+ "name": "sec",
51
+ "description": "Invinite's SEC document store: filers and issuer lifecycle, filings with their documents, immutable cited document versions (blocks, pages, figures, sections, XBRL fact places), lexical / literal search, 13F holdings research, standardized-statement provenance and metric exports"
52
+ },
53
53
  {
54
54
  "name": "segments",
55
55
  "description": "Financial facts broken down by business and geographic segment"
@@ -570,6 +570,37 @@
570
570
  "default": 0,
571
571
  "example": 0,
572
572
  "description": "Number of events to skip for pagination"
573
+ },
574
+ {
575
+ "name": "date_kind",
576
+ "in": "query",
577
+ "required": false,
578
+ "type": "string",
579
+ "enum": [
580
+ "call",
581
+ "report"
582
+ ],
583
+ "example": "call",
584
+ "description": "Which day `from` / `to` select: `call` (the default: the call day, as described above) or `report` (the results release day, `calendar.report.date`; ordered by it)"
585
+ },
586
+ {
587
+ "name": "calendar_status",
588
+ "in": "query",
589
+ "required": false,
590
+ "type": "array",
591
+ "items": "string",
592
+ "enum": [
593
+ "cancelled",
594
+ "postponed",
595
+ "reported",
596
+ "confirmed",
597
+ "announced",
598
+ "estimated"
599
+ ],
600
+ "example": [
601
+ "confirmed"
602
+ ],
603
+ "description": "Filter by `calendar.status` (repeatable), applied beside `status`"
573
604
  }
574
605
  ],
575
606
  "view": "table",
@@ -2146,218 +2177,6 @@
2146
2177
  ],
2147
2178
  "pagination": "none"
2148
2179
  },
2149
- {
2150
- "operationId": "secFilingsAvailableFormTypes",
2151
- "group": "filings",
2152
- "action": "form-types",
2153
- "method": "get",
2154
- "path": "/v1/sec-filings/available-form-types",
2155
- "auth": true,
2156
- "summary": "Available SEC form types",
2157
- "params": [
2158
- {
2159
- "name": "identifier",
2160
- "in": "query",
2161
- "required": false,
2162
- "type": "string",
2163
- "example": "AAPL",
2164
- "description": "Optional ticker symbol or CIK. If omitted, returns form types across all filings.",
2165
- "alias": "i"
2166
- }
2167
- ],
2168
- "view": "json",
2169
- "pagination": "none"
2170
- },
2171
- {
2172
- "operationId": "secFilingsList",
2173
- "group": "filings",
2174
- "action": "list",
2175
- "method": "get",
2176
- "path": "/v1/sec-filings/filings",
2177
- "auth": true,
2178
- "summary": "SEC filings",
2179
- "params": [
2180
- {
2181
- "name": "identifier",
2182
- "in": "query",
2183
- "required": true,
2184
- "type": "string",
2185
- "example": "AAPL",
2186
- "description": "Ticker symbol or CIK. A CIK also finds a registrant that is not listed yet (pre-IPO).",
2187
- "alias": "i"
2188
- },
2189
- {
2190
- "name": "form_type",
2191
- "in": "query",
2192
- "required": false,
2193
- "type": "string",
2194
- "example": "10-K",
2195
- "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."
2196
- },
2197
- {
2198
- "name": "sort",
2199
- "in": "query",
2200
- "required": false,
2201
- "type": "string",
2202
- "enum": [
2203
- "asc",
2204
- "desc"
2205
- ],
2206
- "default": "desc",
2207
- "example": "desc",
2208
- "description": "Sort direction for filings by filing_date",
2209
- "alias": "s"
2210
- },
2211
- {
2212
- "name": "limit",
2213
- "in": "query",
2214
- "required": false,
2215
- "type": "integer",
2216
- "default": 40,
2217
- "example": 5,
2218
- "description": "Maximum number of filings to return",
2219
- "alias": "l"
2220
- },
2221
- {
2222
- "name": "offset",
2223
- "in": "query",
2224
- "required": false,
2225
- "type": "integer",
2226
- "default": 0,
2227
- "example": 0,
2228
- "description": "Number of filings to skip for pagination"
2229
- }
2230
- ],
2231
- "view": "table",
2232
- "rowsPath": "companies.0.filings",
2233
- "columns": [
2234
- "filing_date",
2235
- "form_type",
2236
- "fiscal_year",
2237
- "fiscal_quarter",
2238
- "calendar_year",
2239
- "calendar_quarter",
2240
- "period_end",
2241
- "accession_number",
2242
- "html_url"
2243
- ],
2244
- "pagination": "perCompany",
2245
- "allItemsPath": [
2246
- "filings"
2247
- ]
2248
- },
2249
- {
2250
- "operationId": "secFilingsSearch",
2251
- "group": "filings",
2252
- "action": "search",
2253
- "method": "get",
2254
- "path": "/v1/sec-filings/search",
2255
- "auth": true,
2256
- "summary": "Search SEC filings",
2257
- "params": [
2258
- {
2259
- "name": "request",
2260
- "in": "query",
2261
- "required": true,
2262
- "type": "string",
2263
- "example": "What are Apple's main risk factors?",
2264
- "description": "Natural language search request for SEC filing information (e.g., 'What are Apple's main risk factors?')",
2265
- "alias": "r"
2266
- },
2267
- {
2268
- "name": "identifier",
2269
- "in": "query",
2270
- "required": false,
2271
- "type": "string",
2272
- "example": "AAPL",
2273
- "description": "Ticker symbol or CIK to filter search results to a specific company",
2274
- "alias": "i"
2275
- },
2276
- {
2277
- "name": "accession_number",
2278
- "in": "query",
2279
- "required": false,
2280
- "type": "string",
2281
- "example": "0000320193-25-000079",
2282
- "description": "Accession number to filter search results to a specific filing"
2283
- }
2284
- ],
2285
- "exampleParams": [
2286
- "identifier"
2287
- ],
2288
- "view": "json",
2289
- "pagination": "none"
2290
- },
2291
- {
2292
- "operationId": "secFilingsSections",
2293
- "group": "filings",
2294
- "action": "sections",
2295
- "method": "get",
2296
- "path": "/v1/sec-filings/sections",
2297
- "auth": true,
2298
- "summary": "SEC filing sections",
2299
- "params": [
2300
- {
2301
- "name": "identifier",
2302
- "in": "query",
2303
- "required": true,
2304
- "type": "string",
2305
- "example": "AAPL",
2306
- "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.",
2307
- "alias": "i"
2308
- },
2309
- {
2310
- "name": "form_type",
2311
- "in": "query",
2312
- "required": true,
2313
- "type": "string",
2314
- "enum": [
2315
- "10-Q",
2316
- "10-K",
2317
- "8-K"
2318
- ],
2319
- "example": "10-K",
2320
- "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."
2321
- },
2322
- {
2323
- "name": "section_id",
2324
- "in": "query",
2325
- "required": false,
2326
- "type": "string",
2327
- "example": "part_i-item_1a",
2328
- "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."
2329
- },
2330
- {
2331
- "name": "accession_number",
2332
- "in": "query",
2333
- "required": false,
2334
- "type": "string",
2335
- "example": "0000320193-25-000079",
2336
- "description": "SEC accession number of the filing"
2337
- },
2338
- {
2339
- "name": "fiscal_year",
2340
- "in": "query",
2341
- "required": false,
2342
- "type": "integer",
2343
- "example": 2025,
2344
- "description": "Fiscal year"
2345
- },
2346
- {
2347
- "name": "fiscal_quarter",
2348
- "in": "query",
2349
- "required": false,
2350
- "type": "integer",
2351
- "example": 4,
2352
- "description": "Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter."
2353
- }
2354
- ],
2355
- "exampleParams": [
2356
- "fiscal_year"
2357
- ],
2358
- "view": "json",
2359
- "pagination": "none"
2360
- },
2361
2180
  {
2362
2181
  "operationId": "asReportedBalanceSheet",
2363
2182
  "group": "financials",
@@ -4354,6 +4173,18 @@
4354
4173
  "example": "false",
4355
4174
  "description": "true = blank-check companies (SPACs) only, false = no SPACs. Default: both"
4356
4175
  },
4176
+ {
4177
+ "name": "pending",
4178
+ "in": "query",
4179
+ "required": false,
4180
+ "type": "string",
4181
+ "enum": [
4182
+ "true",
4183
+ "false"
4184
+ ],
4185
+ "example": "true",
4186
+ "description": "true = tracks with an open IPO-pending entry (`ipo_pending.status` open), false = tracks without one. Default: both"
4187
+ },
4357
4188
  {
4358
4189
  "name": "sort",
4359
4190
  "in": "query",
@@ -5669,6 +5500,1643 @@
5669
5500
  "transactions"
5670
5501
  ]
5671
5502
  },
5503
+ {
5504
+ "operationId": "secDatasets",
5505
+ "group": "sec",
5506
+ "action": "datasets",
5507
+ "method": "get",
5508
+ "path": "/v1/sec/datasets",
5509
+ "auth": true,
5510
+ "summary": "SEC dataset releases",
5511
+ "params": [],
5512
+ "view": "json",
5513
+ "pagination": "none"
5514
+ },
5515
+ {
5516
+ "operationId": "secDocument",
5517
+ "group": "sec",
5518
+ "action": "document",
5519
+ "method": "get",
5520
+ "path": "/v1/sec/documents/{accession}/{filename}",
5521
+ "auth": true,
5522
+ "summary": "SEC document (current version)",
5523
+ "params": [
5524
+ {
5525
+ "name": "blocks",
5526
+ "in": "query",
5527
+ "required": false,
5528
+ "type": "string",
5529
+ "example": "b00107-b00244",
5530
+ "description": "A block id or range (`b00107` or `b00107-b00244`; a section's `blocks` selector)",
5531
+ "alias": "b"
5532
+ },
5533
+ {
5534
+ "name": "pages",
5535
+ "in": "query",
5536
+ "required": false,
5537
+ "type": "string",
5538
+ "example": "1-3",
5539
+ "description": "Physical page ordinals (`3` or `3-5`)",
5540
+ "alias": "p"
5541
+ },
5542
+ {
5543
+ "name": "printed",
5544
+ "in": "query",
5545
+ "required": false,
5546
+ "type": "string",
5547
+ "example": "17",
5548
+ "description": "An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number"
5549
+ },
5550
+ {
5551
+ "name": "printed_occurrence",
5552
+ "in": "query",
5553
+ "required": false,
5554
+ "type": "integer",
5555
+ "example": 1,
5556
+ "description": "Which page carrying a repeated printed label (1-based, page order)"
5557
+ },
5558
+ {
5559
+ "name": "neighbors",
5560
+ "in": "query",
5561
+ "required": false,
5562
+ "type": "integer",
5563
+ "example": 1,
5564
+ "description": "Widen the selection by this many blocks on each side (same version)"
5565
+ },
5566
+ {
5567
+ "name": "footnotes",
5568
+ "in": "query",
5569
+ "required": false,
5570
+ "type": "string",
5571
+ "enum": [
5572
+ "true",
5573
+ "false"
5574
+ ],
5575
+ "example": "true",
5576
+ "description": "Add the footnote blocks the selection links to (same version) (`true` or `false`)"
5577
+ },
5578
+ {
5579
+ "name": "limit",
5580
+ "in": "query",
5581
+ "required": false,
5582
+ "type": "integer",
5583
+ "example": 5,
5584
+ "description": "At most this many blocks (1-1000); the answer names the next block when cut",
5585
+ "alias": "l"
5586
+ },
5587
+ {
5588
+ "name": "accession",
5589
+ "in": "path",
5590
+ "required": true,
5591
+ "type": "string",
5592
+ "example": "0000320193-26-000026",
5593
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
5594
+ },
5595
+ {
5596
+ "name": "filename",
5597
+ "in": "path",
5598
+ "required": true,
5599
+ "type": "string",
5600
+ "example": "aapl-20260926.htm",
5601
+ "description": "The document's file name in the filing (a manifest's `filename`)"
5602
+ }
5603
+ ],
5604
+ "view": "json",
5605
+ "pagination": "none"
5606
+ },
5607
+ {
5608
+ "operationId": "secExport",
5609
+ "group": "sec",
5610
+ "action": "export",
5611
+ "method": "get",
5612
+ "path": "/v1/sec/exports/{export_id}",
5613
+ "auth": true,
5614
+ "summary": "Metric export manifest",
5615
+ "params": [
5616
+ {
5617
+ "name": "export_id",
5618
+ "in": "path",
5619
+ "required": true,
5620
+ "type": "string",
5621
+ "example": "6a7350b9-df18-517b-b553-96601b1e0508",
5622
+ "description": "Export id"
5623
+ }
5624
+ ],
5625
+ "view": "json",
5626
+ "pagination": "none"
5627
+ },
5628
+ {
5629
+ "operationId": "secDocumentFactPlaces",
5630
+ "group": "sec",
5631
+ "action": "fact-places",
5632
+ "method": "get",
5633
+ "path": "/v1/sec/versions/{version_id}/fact-places",
5634
+ "auth": true,
5635
+ "summary": "XBRL fact places in a document version",
5636
+ "params": [
5637
+ {
5638
+ "name": "fact_id",
5639
+ "in": "query",
5640
+ "required": false,
5641
+ "type": "string",
5642
+ "example": "320193|is_total_revenue|annual|2026|4",
5643
+ "description": "One fact id"
5644
+ },
5645
+ {
5646
+ "name": "status",
5647
+ "in": "query",
5648
+ "required": false,
5649
+ "type": "string",
5650
+ "enum": [
5651
+ "exact",
5652
+ "ambiguous",
5653
+ "hidden",
5654
+ "not_in_document",
5655
+ "derived",
5656
+ "unmatched"
5657
+ ],
5658
+ "example": "exact",
5659
+ "description": "Places of this status only"
5660
+ },
5661
+ {
5662
+ "name": "cursor",
5663
+ "in": "query",
5664
+ "required": false,
5665
+ "type": "string",
5666
+ "example": "MTIz",
5667
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
5668
+ },
5669
+ {
5670
+ "name": "limit",
5671
+ "in": "query",
5672
+ "required": false,
5673
+ "type": "integer",
5674
+ "default": 100,
5675
+ "example": 5,
5676
+ "description": "Places per page (1-500, default 100)"
5677
+ },
5678
+ {
5679
+ "name": "version_id",
5680
+ "in": "path",
5681
+ "required": true,
5682
+ "type": "string",
5683
+ "example": "8be0b759-1a9d-5f89-8308-bd86185f5e1f",
5684
+ "description": "An immutable document version (`version.version_id` of a document read, a search hit's citation)"
5685
+ }
5686
+ ],
5687
+ "view": "json",
5688
+ "pagination": "top",
5689
+ "allItemsPath": [
5690
+ "places"
5691
+ ]
5692
+ },
5693
+ {
5694
+ "operationId": "secDocumentFigure",
5695
+ "group": "sec",
5696
+ "action": "figure",
5697
+ "method": "get",
5698
+ "path": "/v1/sec/versions/{version_id}/figures/{block_id}",
5699
+ "auth": true,
5700
+ "summary": "SEC document figure",
5701
+ "params": [
5702
+ {
5703
+ "name": "version_id",
5704
+ "in": "path",
5705
+ "required": true,
5706
+ "type": "string",
5707
+ "example": "8be0b759-1a9d-5f89-8308-bd86185f5e1f",
5708
+ "description": "An immutable document version (`version.version_id` of a document read, a search hit's citation)"
5709
+ },
5710
+ {
5711
+ "name": "block_id",
5712
+ "in": "path",
5713
+ "required": true,
5714
+ "type": "string",
5715
+ "example": "b00107",
5716
+ "description": "The figure's block id (`b00042`)"
5717
+ }
5718
+ ],
5719
+ "view": "json",
5720
+ "pagination": "none"
5721
+ },
5722
+ {
5723
+ "operationId": "secFiler",
5724
+ "group": "sec",
5725
+ "action": "filer",
5726
+ "method": "get",
5727
+ "path": "/v1/sec/filers/{cik}",
5728
+ "auth": true,
5729
+ "summary": "SEC filer",
5730
+ "params": [
5731
+ {
5732
+ "name": "cik",
5733
+ "in": "path",
5734
+ "required": true,
5735
+ "type": "string",
5736
+ "example": "320193",
5737
+ "description": "SEC CIK of the filer (any zero padding)"
5738
+ }
5739
+ ],
5740
+ "view": "json",
5741
+ "pagination": "none"
5742
+ },
5743
+ {
5744
+ "operationId": "secFilerCoverage",
5745
+ "group": "sec",
5746
+ "action": "filer-coverage",
5747
+ "method": "get",
5748
+ "path": "/v1/sec/filers/{cik}/coverage",
5749
+ "auth": true,
5750
+ "summary": "SEC filer document coverage",
5751
+ "params": [
5752
+ {
5753
+ "name": "since",
5754
+ "in": "query",
5755
+ "required": false,
5756
+ "type": "string",
5757
+ "example": "2025-11-01",
5758
+ "description": "First filing day of the window (YYYY-MM-DD, at most 3 years back)",
5759
+ "alias": "s"
5760
+ },
5761
+ {
5762
+ "name": "cik",
5763
+ "in": "path",
5764
+ "required": true,
5765
+ "type": "string",
5766
+ "example": "320193",
5767
+ "description": "SEC CIK of the filer (any zero padding)"
5768
+ }
5769
+ ],
5770
+ "view": "json",
5771
+ "pagination": "none"
5772
+ },
5773
+ {
5774
+ "operationId": "secFilers",
5775
+ "group": "sec",
5776
+ "action": "filers",
5777
+ "method": "get",
5778
+ "path": "/v1/sec/filers",
5779
+ "auth": true,
5780
+ "summary": "Find SEC filers",
5781
+ "params": [
5782
+ {
5783
+ "name": "name",
5784
+ "in": "query",
5785
+ "required": false,
5786
+ "type": "string",
5787
+ "example": "Apple",
5788
+ "description": "Name or former name (substring)",
5789
+ "alias": "n"
5790
+ },
5791
+ {
5792
+ "name": "ticker",
5793
+ "in": "query",
5794
+ "required": false,
5795
+ "type": "string",
5796
+ "example": "AAPL",
5797
+ "description": "A ticker the filer stated to the SEC",
5798
+ "alias": "t"
5799
+ },
5800
+ {
5801
+ "name": "form",
5802
+ "in": "query",
5803
+ "required": false,
5804
+ "type": "string",
5805
+ "example": "13F-HR",
5806
+ "description": "A form type the filer filed (exact, e.g. 13F-HR)",
5807
+ "alias": "f"
5808
+ },
5809
+ {
5810
+ "name": "limit",
5811
+ "in": "query",
5812
+ "required": false,
5813
+ "type": "integer",
5814
+ "default": 20,
5815
+ "example": 5,
5816
+ "description": "Matches (1-50, default 20)",
5817
+ "alias": "l"
5818
+ }
5819
+ ],
5820
+ "view": "table",
5821
+ "rowsPath": "matches",
5822
+ "columns": [
5823
+ "cik",
5824
+ "name",
5825
+ "entity_type",
5826
+ "sic"
5827
+ ],
5828
+ "pagination": "none"
5829
+ },
5830
+ {
5831
+ "operationId": "secFiling",
5832
+ "group": "sec",
5833
+ "action": "filing",
5834
+ "method": "get",
5835
+ "path": "/v1/sec/filings/{accession}",
5836
+ "auth": true,
5837
+ "summary": "SEC filing and its documents",
5838
+ "params": [
5839
+ {
5840
+ "name": "accession",
5841
+ "in": "path",
5842
+ "required": true,
5843
+ "type": "string",
5844
+ "example": "0000320193-26-000026",
5845
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits",
5846
+ "alias": "a"
5847
+ }
5848
+ ],
5849
+ "view": "json",
5850
+ "pagination": "none"
5851
+ },
5852
+ {
5853
+ "operationId": "secFilingFacts",
5854
+ "group": "sec",
5855
+ "action": "filing-facts",
5856
+ "method": "get",
5857
+ "path": "/v1/sec/filings/{accession}/facts",
5858
+ "auth": true,
5859
+ "summary": "SEC dataset facts of a filing",
5860
+ "params": [
5861
+ {
5862
+ "name": "tag",
5863
+ "in": "query",
5864
+ "required": false,
5865
+ "type": "string",
5866
+ "example": "Revenues",
5867
+ "description": "One XBRL tag (e.g. Revenues)",
5868
+ "alias": "t"
5869
+ },
5870
+ {
5871
+ "name": "accession",
5872
+ "in": "path",
5873
+ "required": true,
5874
+ "type": "string",
5875
+ "example": "0000320193-26-000026",
5876
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
5877
+ }
5878
+ ],
5879
+ "view": "json",
5880
+ "pagination": "none"
5881
+ },
5882
+ {
5883
+ "operationId": "secFilingHoldings",
5884
+ "group": "sec",
5885
+ "action": "filing-holdings",
5886
+ "method": "get",
5887
+ "path": "/v1/sec/filings/{accession}/holdings",
5888
+ "auth": true,
5889
+ "summary": "Holdings of a 13F filing",
5890
+ "params": [
5891
+ {
5892
+ "name": "after",
5893
+ "in": "query",
5894
+ "required": false,
5895
+ "type": "integer",
5896
+ "example": 0,
5897
+ "description": "Row key of the previous page (`next_after`; follow `next_url`)"
5898
+ },
5899
+ {
5900
+ "name": "limit",
5901
+ "in": "query",
5902
+ "required": false,
5903
+ "type": "integer",
5904
+ "default": 500,
5905
+ "example": 5,
5906
+ "description": "Positions per page (1-1000, default 500)",
5907
+ "alias": "l"
5908
+ },
5909
+ {
5910
+ "name": "accession",
5911
+ "in": "path",
5912
+ "required": true,
5913
+ "type": "string",
5914
+ "example": "0000320193-26-000026",
5915
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
5916
+ }
5917
+ ],
5918
+ "view": "json",
5919
+ "pagination": "top",
5920
+ "allItemsPath": [
5921
+ "rows"
5922
+ ]
5923
+ },
5924
+ {
5925
+ "operationId": "secFilingNotes",
5926
+ "group": "sec",
5927
+ "action": "filing-notes",
5928
+ "method": "get",
5929
+ "path": "/v1/sec/filings/{accession}/notes",
5930
+ "auth": true,
5931
+ "summary": "SEC dataset text notes of a filing",
5932
+ "params": [
5933
+ {
5934
+ "name": "tag",
5935
+ "in": "query",
5936
+ "required": false,
5937
+ "type": "string",
5938
+ "example": "Revenues",
5939
+ "description": "One XBRL tag",
5940
+ "alias": "t"
5941
+ },
5942
+ {
5943
+ "name": "accession",
5944
+ "in": "path",
5945
+ "required": true,
5946
+ "type": "string",
5947
+ "example": "0000320193-26-000026",
5948
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
5949
+ }
5950
+ ],
5951
+ "view": "json",
5952
+ "pagination": "none"
5953
+ },
5954
+ {
5955
+ "operationId": "secFilings",
5956
+ "group": "sec",
5957
+ "action": "filings",
5958
+ "method": "get",
5959
+ "path": "/v1/sec/filings",
5960
+ "auth": true,
5961
+ "summary": "SEC filings of a filer",
5962
+ "params": [
5963
+ {
5964
+ "name": "identifier",
5965
+ "in": "query",
5966
+ "required": true,
5967
+ "type": "string",
5968
+ "example": "AAPL",
5969
+ "description": "A ticker the filer stated to the SEC, or a CIK (a CIK also finds a pre-IPO issuer)",
5970
+ "alias": "i"
5971
+ },
5972
+ {
5973
+ "name": "form",
5974
+ "in": "query",
5975
+ "required": false,
5976
+ "type": "string",
5977
+ "example": "10-K,10-K/A",
5978
+ "description": "Form types, a comma list (e.g. `10-K,10-K/A`)",
5979
+ "alias": "f"
5980
+ },
5981
+ {
5982
+ "name": "filed_from",
5983
+ "in": "query",
5984
+ "required": false,
5985
+ "type": "string",
5986
+ "example": "2025-01-01",
5987
+ "description": "First filing day (YYYY-MM-DD)"
5988
+ },
5989
+ {
5990
+ "name": "filed_to",
5991
+ "in": "query",
5992
+ "required": false,
5993
+ "type": "string",
5994
+ "example": "2026-11-05",
5995
+ "description": "Last filing day (YYYY-MM-DD)"
5996
+ },
5997
+ {
5998
+ "name": "order",
5999
+ "in": "query",
6000
+ "required": false,
6001
+ "type": "string",
6002
+ "enum": [
6003
+ "desc",
6004
+ "asc"
6005
+ ],
6006
+ "example": "desc",
6007
+ "description": "By filing date (default desc)"
6008
+ },
6009
+ {
6010
+ "name": "cursor",
6011
+ "in": "query",
6012
+ "required": false,
6013
+ "type": "string",
6014
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6015
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6016
+ },
6017
+ {
6018
+ "name": "limit",
6019
+ "in": "query",
6020
+ "required": false,
6021
+ "type": "integer",
6022
+ "default": 50,
6023
+ "example": 5,
6024
+ "description": "Filings per page (1-100, default 50)",
6025
+ "alias": "l"
6026
+ }
6027
+ ],
6028
+ "view": "table",
6029
+ "rowsPath": "filings",
6030
+ "columns": [
6031
+ "filing_date",
6032
+ "form",
6033
+ "accession",
6034
+ "report_date",
6035
+ "primary_document"
6036
+ ],
6037
+ "pagination": "top",
6038
+ "allItemsPath": [
6039
+ "filings"
6040
+ ]
6041
+ },
6042
+ {
6043
+ "operationId": "secFinancialsFact",
6044
+ "group": "sec",
6045
+ "action": "financial-fact",
6046
+ "method": "get",
6047
+ "path": "/v1/sec/financials/facts",
6048
+ "auth": true,
6049
+ "summary": "Explain a standardized fact",
6050
+ "params": [
6051
+ {
6052
+ "name": "id",
6053
+ "in": "query",
6054
+ "required": true,
6055
+ "type": "string",
6056
+ "example": "320193|is_total_revenue|annual|2026|4",
6057
+ "description": "Fact id `cik|metric_id|period type|fiscal year|fiscal quarter` (the `id` of a standardized row)"
6058
+ },
6059
+ {
6060
+ "name": "max_depth",
6061
+ "in": "query",
6062
+ "required": false,
6063
+ "type": "integer",
6064
+ "example": 3,
6065
+ "description": "Formula depth (1-6, default 4)"
6066
+ },
6067
+ {
6068
+ "name": "max_members",
6069
+ "in": "query",
6070
+ "required": false,
6071
+ "type": "integer",
6072
+ "example": 64,
6073
+ "description": "Formula members at most (1-200, default 64)"
6074
+ },
6075
+ {
6076
+ "name": "places",
6077
+ "in": "query",
6078
+ "required": false,
6079
+ "type": "string",
6080
+ "enum": [
6081
+ "true",
6082
+ "false"
6083
+ ],
6084
+ "example": "true",
6085
+ "description": "Resolve the source facts' places (default true) (`true` or `false`)"
6086
+ }
6087
+ ],
6088
+ "view": "json",
6089
+ "pagination": "none"
6090
+ },
6091
+ {
6092
+ "operationId": "secFinancialsCatalog",
6093
+ "group": "sec",
6094
+ "action": "financials-catalog",
6095
+ "method": "get",
6096
+ "path": "/v1/sec/financials/catalog",
6097
+ "auth": true,
6098
+ "summary": "Standardization rule catalog",
6099
+ "params": [
6100
+ {
6101
+ "name": "statement",
6102
+ "in": "query",
6103
+ "required": false,
6104
+ "type": "string",
6105
+ "enum": [
6106
+ "income_statement",
6107
+ "balance_sheet",
6108
+ "cash_flow_statement"
6109
+ ],
6110
+ "example": "income_statement",
6111
+ "description": "One statement",
6112
+ "alias": "s"
6113
+ },
6114
+ {
6115
+ "name": "metric_id",
6116
+ "in": "query",
6117
+ "required": false,
6118
+ "type": "string",
6119
+ "example": "is_total_revenue",
6120
+ "description": "One standardized metric"
6121
+ }
6122
+ ],
6123
+ "view": "json",
6124
+ "pagination": "none"
6125
+ },
6126
+ {
6127
+ "operationId": "secHoldingsFormFilers",
6128
+ "group": "sec",
6129
+ "action": "form-filers",
6130
+ "method": "get",
6131
+ "path": "/v1/sec/holdings/form-filers",
6132
+ "auth": true,
6133
+ "summary": "Filers of an SEC form",
6134
+ "params": [
6135
+ {
6136
+ "name": "form",
6137
+ "in": "query",
6138
+ "required": true,
6139
+ "type": "string",
6140
+ "example": "13F-HR",
6141
+ "description": "The form type (e.g. 13F-HR)",
6142
+ "alias": "f"
6143
+ },
6144
+ {
6145
+ "name": "exact",
6146
+ "in": "query",
6147
+ "required": false,
6148
+ "type": "string",
6149
+ "enum": [
6150
+ "true",
6151
+ "false"
6152
+ ],
6153
+ "example": "false",
6154
+ "description": "Only this exact form (not its amendments) (`true` or `false`)"
6155
+ },
6156
+ {
6157
+ "name": "name",
6158
+ "in": "query",
6159
+ "required": false,
6160
+ "type": "string",
6161
+ "example": "Berkshire",
6162
+ "description": "Filer name (substring)",
6163
+ "alias": "n"
6164
+ },
6165
+ {
6166
+ "name": "cik",
6167
+ "in": "query",
6168
+ "required": false,
6169
+ "type": "string",
6170
+ "example": "1067983",
6171
+ "description": "One filer CIK"
6172
+ },
6173
+ {
6174
+ "name": "cursor",
6175
+ "in": "query",
6176
+ "required": false,
6177
+ "type": "string",
6178
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6179
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6180
+ },
6181
+ {
6182
+ "name": "limit",
6183
+ "in": "query",
6184
+ "required": false,
6185
+ "type": "integer",
6186
+ "default": 50,
6187
+ "example": 5,
6188
+ "description": "Rows per page (1-200, default 50)",
6189
+ "alias": "l"
6190
+ }
6191
+ ],
6192
+ "view": "json",
6193
+ "pagination": "top",
6194
+ "allItemsPath": [
6195
+ "rows"
6196
+ ]
6197
+ },
6198
+ {
6199
+ "operationId": "secHoldingsHolders",
6200
+ "group": "sec",
6201
+ "action": "holders",
6202
+ "method": "get",
6203
+ "path": "/v1/sec/holdings/holders",
6204
+ "auth": true,
6205
+ "summary": "Institutional holders of a security (13F)",
6206
+ "params": [
6207
+ {
6208
+ "name": "period_end",
6209
+ "in": "query",
6210
+ "required": true,
6211
+ "type": "string",
6212
+ "example": "2026-06-30",
6213
+ "description": "The 13F report quarter end (YYYY-MM-DD)"
6214
+ },
6215
+ {
6216
+ "name": "cusip",
6217
+ "in": "query",
6218
+ "required": false,
6219
+ "type": "string",
6220
+ "example": "037833100",
6221
+ "description": "Security CUSIP"
6222
+ },
6223
+ {
6224
+ "name": "symbol",
6225
+ "in": "query",
6226
+ "required": false,
6227
+ "type": "string",
6228
+ "example": "AAPL",
6229
+ "description": "Ticker symbol",
6230
+ "alias": "s"
6231
+ },
6232
+ {
6233
+ "name": "issuer_cik",
6234
+ "in": "query",
6235
+ "required": false,
6236
+ "type": "string",
6237
+ "example": "320193",
6238
+ "description": "Issuer CIK"
6239
+ },
6240
+ {
6241
+ "name": "instruments",
6242
+ "in": "query",
6243
+ "required": false,
6244
+ "type": "string",
6245
+ "enum": [
6246
+ "shareholder",
6247
+ "all"
6248
+ ],
6249
+ "example": "shareholder",
6250
+ "description": "`shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder)"
6251
+ },
6252
+ {
6253
+ "name": "pinned_at",
6254
+ "in": "query",
6255
+ "required": false,
6256
+ "type": "string",
6257
+ "example": "2026-11-05T00:00:00Z",
6258
+ "description": "Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent)"
6259
+ },
6260
+ {
6261
+ "name": "cursor",
6262
+ "in": "query",
6263
+ "required": false,
6264
+ "type": "string",
6265
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6266
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6267
+ },
6268
+ {
6269
+ "name": "limit",
6270
+ "in": "query",
6271
+ "required": false,
6272
+ "type": "integer",
6273
+ "default": 50,
6274
+ "example": 5,
6275
+ "description": "Rows per page (1-200, default 50)",
6276
+ "alias": "l"
6277
+ }
6278
+ ],
6279
+ "view": "json",
6280
+ "pagination": "top",
6281
+ "allItemsPath": [
6282
+ "rows"
6283
+ ]
6284
+ },
6285
+ {
6286
+ "operationId": "secHoldingsDeltas",
6287
+ "group": "sec",
6288
+ "action": "holding-deltas",
6289
+ "method": "get",
6290
+ "path": "/v1/sec/holdings/deltas",
6291
+ "auth": true,
6292
+ "summary": "Position changes in a security (13F)",
6293
+ "params": [
6294
+ {
6295
+ "name": "period_end",
6296
+ "in": "query",
6297
+ "required": true,
6298
+ "type": "string",
6299
+ "example": "2026-06-30",
6300
+ "description": "The 13F report quarter end (YYYY-MM-DD)"
6301
+ },
6302
+ {
6303
+ "name": "prior_period_end",
6304
+ "in": "query",
6305
+ "required": false,
6306
+ "type": "string",
6307
+ "example": "2026-03-31",
6308
+ "description": "The quarter compared with (default the previous quarter)"
6309
+ },
6310
+ {
6311
+ "name": "cusip",
6312
+ "in": "query",
6313
+ "required": false,
6314
+ "type": "string",
6315
+ "example": "037833100",
6316
+ "description": "Security CUSIP"
6317
+ },
6318
+ {
6319
+ "name": "symbol",
6320
+ "in": "query",
6321
+ "required": false,
6322
+ "type": "string",
6323
+ "example": "AAPL",
6324
+ "description": "Ticker symbol",
6325
+ "alias": "s"
6326
+ },
6327
+ {
6328
+ "name": "issuer_cik",
6329
+ "in": "query",
6330
+ "required": false,
6331
+ "type": "string",
6332
+ "example": "320193",
6333
+ "description": "Issuer CIK"
6334
+ },
6335
+ {
6336
+ "name": "instruments",
6337
+ "in": "query",
6338
+ "required": false,
6339
+ "type": "string",
6340
+ "enum": [
6341
+ "shareholder",
6342
+ "all"
6343
+ ],
6344
+ "example": "shareholder",
6345
+ "description": "`shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder)"
6346
+ },
6347
+ {
6348
+ "name": "pinned_at",
6349
+ "in": "query",
6350
+ "required": false,
6351
+ "type": "string",
6352
+ "example": "2026-11-05T00:00:00Z",
6353
+ "description": "Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent)"
6354
+ },
6355
+ {
6356
+ "name": "cursor",
6357
+ "in": "query",
6358
+ "required": false,
6359
+ "type": "string",
6360
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6361
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6362
+ },
6363
+ {
6364
+ "name": "limit",
6365
+ "in": "query",
6366
+ "required": false,
6367
+ "type": "integer",
6368
+ "default": 50,
6369
+ "example": 5,
6370
+ "description": "Rows per page (1-200, default 50)",
6371
+ "alias": "l"
6372
+ }
6373
+ ],
6374
+ "view": "json",
6375
+ "pagination": "top",
6376
+ "allItemsPath": [
6377
+ "rows"
6378
+ ]
6379
+ },
6380
+ {
6381
+ "operationId": "secIssuers",
6382
+ "group": "sec",
6383
+ "action": "issuers",
6384
+ "method": "get",
6385
+ "path": "/v1/sec/issuers",
6386
+ "auth": true,
6387
+ "summary": "List SEC issuers",
6388
+ "params": [
6389
+ {
6390
+ "name": "query",
6391
+ "in": "query",
6392
+ "required": false,
6393
+ "type": "string",
6394
+ "example": "Iambic",
6395
+ "description": "Name (substring)",
6396
+ "alias": "q"
6397
+ },
6398
+ {
6399
+ "name": "phase",
6400
+ "in": "query",
6401
+ "required": false,
6402
+ "type": "string",
6403
+ "enum": [
6404
+ "observed",
6405
+ "public_preipo",
6406
+ "listed_spac",
6407
+ "listed_operating",
6408
+ "former_listed",
6409
+ "unresolved"
6410
+ ],
6411
+ "example": "public_preipo",
6412
+ "description": "Lifecycle phase",
6413
+ "alias": "p"
6414
+ },
6415
+ {
6416
+ "name": "form",
6417
+ "in": "query",
6418
+ "required": false,
6419
+ "type": "string",
6420
+ "example": "S-1",
6421
+ "description": "A form type the issuer filed"
6422
+ },
6423
+ {
6424
+ "name": "public_seen_from",
6425
+ "in": "query",
6426
+ "required": false,
6427
+ "type": "string",
6428
+ "example": "2026-01-01",
6429
+ "description": "First public sighting on or after (YYYY-MM-DD)"
6430
+ },
6431
+ {
6432
+ "name": "public_seen_to",
6433
+ "in": "query",
6434
+ "required": false,
6435
+ "type": "string",
6436
+ "example": "2026-10-31",
6437
+ "description": "First public sighting on or before (YYYY-MM-DD)"
6438
+ },
6439
+ {
6440
+ "name": "cursor",
6441
+ "in": "query",
6442
+ "required": false,
6443
+ "type": "string",
6444
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6445
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6446
+ },
6447
+ {
6448
+ "name": "limit",
6449
+ "in": "query",
6450
+ "required": false,
6451
+ "type": "integer",
6452
+ "default": 20,
6453
+ "example": 5,
6454
+ "description": "Issuers per page (1-100, default 20)",
6455
+ "alias": "l"
6456
+ }
6457
+ ],
6458
+ "view": "json",
6459
+ "pagination": "top",
6460
+ "allItemsPath": [
6461
+ "issuers"
6462
+ ]
6463
+ },
6464
+ {
6465
+ "operationId": "secFilerLifecycle",
6466
+ "group": "sec",
6467
+ "action": "lifecycle",
6468
+ "method": "get",
6469
+ "path": "/v1/sec/filers/{cik}/lifecycle",
6470
+ "auth": true,
6471
+ "summary": "SEC issuer lifecycle",
6472
+ "params": [
6473
+ {
6474
+ "name": "traverse",
6475
+ "in": "query",
6476
+ "required": false,
6477
+ "type": "string",
6478
+ "enum": [
6479
+ "successors",
6480
+ "predecessors"
6481
+ ],
6482
+ "example": "successors",
6483
+ "description": "Follow verified legal successions in this direction",
6484
+ "alias": "t"
6485
+ },
6486
+ {
6487
+ "name": "max_hops",
6488
+ "in": "query",
6489
+ "required": false,
6490
+ "type": "integer",
6491
+ "example": 3,
6492
+ "description": "At most this many successions (1-5, default 3)"
6493
+ },
6494
+ {
6495
+ "name": "cik",
6496
+ "in": "path",
6497
+ "required": true,
6498
+ "type": "string",
6499
+ "example": "320193",
6500
+ "description": "SEC CIK of the issuer (any zero padding)"
6501
+ }
6502
+ ],
6503
+ "view": "json",
6504
+ "pagination": "none"
6505
+ },
6506
+ {
6507
+ "operationId": "secExportsFinancialMetrics",
6508
+ "group": "sec",
6509
+ "action": "metric-export",
6510
+ "method": "get",
6511
+ "path": "/v1/sec/exports/financial-metrics",
6512
+ "auth": true,
6513
+ "summary": "Request an annual metric export",
6514
+ "params": [
6515
+ {
6516
+ "name": "metric_id",
6517
+ "in": "query",
6518
+ "required": true,
6519
+ "type": "string",
6520
+ "example": "is_total_revenue",
6521
+ "description": "Standardized metric",
6522
+ "alias": "m"
6523
+ },
6524
+ {
6525
+ "name": "fiscal_year",
6526
+ "in": "query",
6527
+ "required": true,
6528
+ "type": "integer",
6529
+ "example": 2025,
6530
+ "description": "Fiscal year",
6531
+ "alias": "y"
6532
+ },
6533
+ {
6534
+ "name": "period_type",
6535
+ "in": "query",
6536
+ "required": false,
6537
+ "type": "string",
6538
+ "enum": [
6539
+ "quarterly",
6540
+ "annual",
6541
+ "ytd",
6542
+ "ttm"
6543
+ ],
6544
+ "example": "annual",
6545
+ "description": "Period type (default annual)"
6546
+ },
6547
+ {
6548
+ "name": "mode",
6549
+ "in": "query",
6550
+ "required": false,
6551
+ "type": "string",
6552
+ "enum": [
6553
+ "standardized",
6554
+ "raw"
6555
+ ],
6556
+ "example": "standardized",
6557
+ "description": "standardized (default) or raw values"
6558
+ },
6559
+ {
6560
+ "name": "generation",
6561
+ "in": "query",
6562
+ "required": false,
6563
+ "type": "string",
6564
+ "example": "g20261104T031000Z-1a2b3c4d",
6565
+ "description": "A past export generation (point in time)"
6566
+ }
6567
+ ],
6568
+ "view": "json",
6569
+ "pagination": "none"
6570
+ },
6571
+ {
6572
+ "operationId": "secHoldingsManagerPortfolio",
6573
+ "group": "sec",
6574
+ "action": "portfolio",
6575
+ "method": "get",
6576
+ "path": "/v1/sec/holdings/managers/{cik}/portfolio",
6577
+ "auth": true,
6578
+ "summary": "Portfolio of a 13F manager",
6579
+ "params": [
6580
+ {
6581
+ "name": "period_end",
6582
+ "in": "query",
6583
+ "required": true,
6584
+ "type": "string",
6585
+ "example": "2026-06-30",
6586
+ "description": "The 13F report quarter end (YYYY-MM-DD)"
6587
+ },
6588
+ {
6589
+ "name": "instruments",
6590
+ "in": "query",
6591
+ "required": false,
6592
+ "type": "string",
6593
+ "enum": [
6594
+ "shareholder",
6595
+ "all"
6596
+ ],
6597
+ "example": "shareholder",
6598
+ "description": "`shareholder` (common / ordinary shares) or `all` (also options, notes, …; default all)"
6599
+ },
6600
+ {
6601
+ "name": "pinned_at",
6602
+ "in": "query",
6603
+ "required": false,
6604
+ "type": "string",
6605
+ "example": "2026-11-05T00:00:00Z",
6606
+ "description": "Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent)"
6607
+ },
6608
+ {
6609
+ "name": "cursor",
6610
+ "in": "query",
6611
+ "required": false,
6612
+ "type": "string",
6613
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6614
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6615
+ },
6616
+ {
6617
+ "name": "limit",
6618
+ "in": "query",
6619
+ "required": false,
6620
+ "type": "integer",
6621
+ "default": 50,
6622
+ "example": 5,
6623
+ "description": "Rows per page (1-200, default 50)",
6624
+ "alias": "l"
6625
+ },
6626
+ {
6627
+ "name": "cik",
6628
+ "in": "path",
6629
+ "required": true,
6630
+ "type": "string",
6631
+ "example": "1067983",
6632
+ "description": "CIK of the 13F manager"
6633
+ }
6634
+ ],
6635
+ "view": "json",
6636
+ "pagination": "top",
6637
+ "allItemsPath": [
6638
+ "rows"
6639
+ ]
6640
+ },
6641
+ {
6642
+ "operationId": "secFilingReviewChain",
6643
+ "group": "sec",
6644
+ "action": "review-chain",
6645
+ "method": "get",
6646
+ "path": "/v1/sec/filings/{accession}/review-chain",
6647
+ "auth": true,
6648
+ "summary": "SEC review chain of a filing",
6649
+ "params": [
6650
+ {
6651
+ "name": "max_depth",
6652
+ "in": "query",
6653
+ "required": false,
6654
+ "type": "integer",
6655
+ "example": 3,
6656
+ "description": "Hops from the filing (1-6, default 3)"
6657
+ },
6658
+ {
6659
+ "name": "max_nodes",
6660
+ "in": "query",
6661
+ "required": false,
6662
+ "type": "integer",
6663
+ "example": 25,
6664
+ "description": "Nodes at most (1-100, default 25)"
6665
+ },
6666
+ {
6667
+ "name": "accession",
6668
+ "in": "path",
6669
+ "required": true,
6670
+ "type": "string",
6671
+ "example": "0000320193-26-000026",
6672
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
6673
+ }
6674
+ ],
6675
+ "view": "json",
6676
+ "pagination": "none"
6677
+ },
6678
+ {
6679
+ "operationId": "secFilingReviewRelations",
6680
+ "group": "sec",
6681
+ "action": "review-relations",
6682
+ "method": "get",
6683
+ "path": "/v1/sec/filings/{accession}/review-relations",
6684
+ "auth": true,
6685
+ "summary": "SEC review relations of a filing",
6686
+ "params": [
6687
+ {
6688
+ "name": "direction",
6689
+ "in": "query",
6690
+ "required": false,
6691
+ "type": "string",
6692
+ "enum": [
6693
+ "from",
6694
+ "to",
6695
+ "both"
6696
+ ],
6697
+ "example": "both",
6698
+ "description": "Relations from, to or both (default both)"
6699
+ },
6700
+ {
6701
+ "name": "kind",
6702
+ "in": "query",
6703
+ "required": false,
6704
+ "type": "string",
6705
+ "enum": [
6706
+ "text_twin_of",
6707
+ "responds_to",
6708
+ "reviews_filing",
6709
+ "continues_review"
6710
+ ],
6711
+ "example": "responds_to",
6712
+ "description": "One relation kind"
6713
+ },
6714
+ {
6715
+ "name": "history",
6716
+ "in": "query",
6717
+ "required": false,
6718
+ "type": "string",
6719
+ "enum": [
6720
+ "true",
6721
+ "false"
6722
+ ],
6723
+ "example": "false",
6724
+ "description": "Add superseded observations (`true` or `false`)"
6725
+ },
6726
+ {
6727
+ "name": "cursor",
6728
+ "in": "query",
6729
+ "required": false,
6730
+ "type": "string",
6731
+ "example": "MTIz",
6732
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6733
+ },
6734
+ {
6735
+ "name": "limit",
6736
+ "in": "query",
6737
+ "required": false,
6738
+ "type": "integer",
6739
+ "default": 100,
6740
+ "example": 5,
6741
+ "description": "Relations per page (1-200, default 100)"
6742
+ },
6743
+ {
6744
+ "name": "accession",
6745
+ "in": "path",
6746
+ "required": true,
6747
+ "type": "string",
6748
+ "example": "0000320193-26-000026",
6749
+ "description": "Accession number, dashed (0000320193-26-000026) or 18 digits"
6750
+ }
6751
+ ],
6752
+ "view": "json",
6753
+ "pagination": "top",
6754
+ "allItemsPath": [
6755
+ "relations"
6756
+ ]
6757
+ },
6758
+ {
6759
+ "operationId": "secSearch",
6760
+ "group": "sec",
6761
+ "action": "search",
6762
+ "method": "get",
6763
+ "path": "/v1/sec/search",
6764
+ "auth": true,
6765
+ "summary": "Search SEC documents",
6766
+ "params": [
6767
+ {
6768
+ "name": "q",
6769
+ "in": "query",
6770
+ "required": true,
6771
+ "type": "string",
6772
+ "example": "supply chain concentration",
6773
+ "description": "Keywords / a quoted phrase (lexical) or the exact text (literal)",
6774
+ "alias": "q"
6775
+ },
6776
+ {
6777
+ "name": "mode",
6778
+ "in": "query",
6779
+ "required": false,
6780
+ "type": "string",
6781
+ "enum": [
6782
+ "lexical",
6783
+ "literal"
6784
+ ],
6785
+ "example": "lexical",
6786
+ "description": "`lexical` (default) or `literal`",
6787
+ "alias": "m"
6788
+ },
6789
+ {
6790
+ "name": "case_sensitive",
6791
+ "in": "query",
6792
+ "required": false,
6793
+ "type": "string",
6794
+ "enum": [
6795
+ "true",
6796
+ "false"
6797
+ ],
6798
+ "example": "false",
6799
+ "description": "Literal only: `false` folds case (default case-sensitive)"
6800
+ },
6801
+ {
6802
+ "name": "cik",
6803
+ "in": "query",
6804
+ "required": false,
6805
+ "type": "string",
6806
+ "example": "320193",
6807
+ "description": "Filer CIKs, a comma list",
6808
+ "alias": "c"
6809
+ },
6810
+ {
6811
+ "name": "entity_id",
6812
+ "in": "query",
6813
+ "required": false,
6814
+ "type": "integer",
6815
+ "example": 1,
6816
+ "description": "A company entity id (all its CIKs)"
6817
+ },
6818
+ {
6819
+ "name": "successors",
6820
+ "in": "query",
6821
+ "required": false,
6822
+ "type": "string",
6823
+ "enum": [
6824
+ "true",
6825
+ "false"
6826
+ ],
6827
+ "example": "false",
6828
+ "description": "Widen `cik` / `entity_id` over reviewed legal successors (`true` or `false`)"
6829
+ },
6830
+ {
6831
+ "name": "accession",
6832
+ "in": "query",
6833
+ "required": false,
6834
+ "type": "string",
6835
+ "example": "0000320193-26-000026",
6836
+ "description": "Accession numbers, a comma list"
6837
+ },
6838
+ {
6839
+ "name": "version_id",
6840
+ "in": "query",
6841
+ "required": false,
6842
+ "type": "string",
6843
+ "example": "8be0b759-1a9d-5f89-8308-bd86185f5e1f",
6844
+ "description": "Document version ids, a comma list"
6845
+ },
6846
+ {
6847
+ "name": "form",
6848
+ "in": "query",
6849
+ "required": false,
6850
+ "type": "string",
6851
+ "example": "10-K",
6852
+ "description": "Form types, a comma list",
6853
+ "alias": "f"
6854
+ },
6855
+ {
6856
+ "name": "filename",
6857
+ "in": "query",
6858
+ "required": false,
6859
+ "type": "string",
6860
+ "example": "aapl-20260926.htm",
6861
+ "description": "Document file names, a comma list"
6862
+ },
6863
+ {
6864
+ "name": "item",
6865
+ "in": "query",
6866
+ "required": false,
6867
+ "type": "string",
6868
+ "example": "2.02",
6869
+ "description": "8-K items, a comma list (e.g. 2.02)"
6870
+ },
6871
+ {
6872
+ "name": "exhibit_type",
6873
+ "in": "query",
6874
+ "required": false,
6875
+ "type": "string",
6876
+ "example": "EX-99.1",
6877
+ "description": "Exhibit types, a comma list (e.g. EX-99.1)"
6878
+ },
6879
+ {
6880
+ "name": "filed_from",
6881
+ "in": "query",
6882
+ "required": false,
6883
+ "type": "string",
6884
+ "example": "2025-01-01",
6885
+ "description": "First filing day (YYYY-MM-DD)"
6886
+ },
6887
+ {
6888
+ "name": "filed_to",
6889
+ "in": "query",
6890
+ "required": false,
6891
+ "type": "string",
6892
+ "example": "2026-11-05",
6893
+ "description": "Last filing day (YYYY-MM-DD)"
6894
+ },
6895
+ {
6896
+ "name": "cursor",
6897
+ "in": "query",
6898
+ "required": false,
6899
+ "type": "string",
6900
+ "example": "eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ",
6901
+ "description": "Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters."
6902
+ },
6903
+ {
6904
+ "name": "limit",
6905
+ "in": "query",
6906
+ "required": false,
6907
+ "type": "integer",
6908
+ "default": 20,
6909
+ "example": 5,
6910
+ "description": "Hits per page (1-50, default 20)",
6911
+ "alias": "l"
6912
+ }
6913
+ ],
6914
+ "view": "json",
6915
+ "pagination": "top",
6916
+ "allItemsPath": [
6917
+ "hits"
6918
+ ]
6919
+ },
6920
+ {
6921
+ "operationId": "secDocumentSections",
6922
+ "group": "sec",
6923
+ "action": "sections",
6924
+ "method": "get",
6925
+ "path": "/v1/sec/versions/{version_id}/sections",
6926
+ "auth": true,
6927
+ "summary": "Sections of an SEC document version",
6928
+ "params": [
6929
+ {
6930
+ "name": "outline",
6931
+ "in": "query",
6932
+ "required": false,
6933
+ "type": "string",
6934
+ "enum": [
6935
+ "legacy",
6936
+ "generic"
6937
+ ],
6938
+ "example": "legacy",
6939
+ "description": "One outline only",
6940
+ "alias": "o"
6941
+ },
6942
+ {
6943
+ "name": "version_id",
6944
+ "in": "path",
6945
+ "required": true,
6946
+ "type": "string",
6947
+ "example": "8be0b759-1a9d-5f89-8308-bd86185f5e1f",
6948
+ "description": "An immutable document version (`version.version_id` of a document read, a search hit's citation)"
6949
+ }
6950
+ ],
6951
+ "view": "table",
6952
+ "rowsPath": "sections",
6953
+ "columns": [
6954
+ "outline",
6955
+ "ordinal",
6956
+ "legacy_section_key",
6957
+ "title",
6958
+ "blocks"
6959
+ ],
6960
+ "pagination": "none"
6961
+ },
6962
+ {
6963
+ "operationId": "secFinancialsStatement",
6964
+ "group": "sec",
6965
+ "action": "statement",
6966
+ "method": "get",
6967
+ "path": "/v1/sec/financials/{cik}/statements/{statement}",
6968
+ "auth": true,
6969
+ "summary": "Standardized statement with provenance",
6970
+ "params": [
6971
+ {
6972
+ "name": "period_type",
6973
+ "in": "query",
6974
+ "required": false,
6975
+ "type": "string",
6976
+ "enum": [
6977
+ "quarterly",
6978
+ "annual",
6979
+ "ytd",
6980
+ "ttm"
6981
+ ],
6982
+ "example": "annual",
6983
+ "description": "Period type (default annual)",
6984
+ "alias": "p"
6985
+ },
6986
+ {
6987
+ "name": "fiscal_year_from",
6988
+ "in": "query",
6989
+ "required": false,
6990
+ "type": "integer",
6991
+ "example": 2022,
6992
+ "description": "First fiscal year"
6993
+ },
6994
+ {
6995
+ "name": "fiscal_year_to",
6996
+ "in": "query",
6997
+ "required": false,
6998
+ "type": "integer",
6999
+ "example": 2026,
7000
+ "description": "Last fiscal year"
7001
+ },
7002
+ {
7003
+ "name": "metric_id",
7004
+ "in": "query",
7005
+ "required": false,
7006
+ "type": "string",
7007
+ "example": "is_total_revenue,is_net_income",
7008
+ "description": "Standardized metrics, a comma list"
7009
+ },
7010
+ {
7011
+ "name": "other_evidence",
7012
+ "in": "query",
7013
+ "required": false,
7014
+ "type": "string",
7015
+ "enum": [
7016
+ "true",
7017
+ "false"
7018
+ ],
7019
+ "example": "false",
7020
+ "description": "Add facts that did not win a cell (`true` or `false`)"
7021
+ },
7022
+ {
7023
+ "name": "limit",
7024
+ "in": "query",
7025
+ "required": false,
7026
+ "type": "integer",
7027
+ "default": 2000,
7028
+ "example": 200,
7029
+ "description": "Cells at most (1-5000, default 2000)"
7030
+ },
7031
+ {
7032
+ "name": "cik",
7033
+ "in": "path",
7034
+ "required": true,
7035
+ "type": "string",
7036
+ "example": "320193",
7037
+ "description": "CIK of the company"
7038
+ },
7039
+ {
7040
+ "name": "statement",
7041
+ "in": "path",
7042
+ "required": true,
7043
+ "type": "string",
7044
+ "enum": [
7045
+ "income_statement",
7046
+ "balance_sheet",
7047
+ "cash_flow_statement"
7048
+ ],
7049
+ "example": "income_statement",
7050
+ "description": "The statement"
7051
+ }
7052
+ ],
7053
+ "view": "json",
7054
+ "pagination": "none"
7055
+ },
7056
+ {
7057
+ "operationId": "secDocumentVersion",
7058
+ "group": "sec",
7059
+ "action": "version",
7060
+ "method": "get",
7061
+ "path": "/v1/sec/versions/{version_id}",
7062
+ "auth": true,
7063
+ "summary": "SEC document version",
7064
+ "params": [
7065
+ {
7066
+ "name": "blocks",
7067
+ "in": "query",
7068
+ "required": false,
7069
+ "type": "string",
7070
+ "example": "b00107-b00244",
7071
+ "description": "A block id or range (`b00107` or `b00107-b00244`; a section's `blocks` selector)",
7072
+ "alias": "b"
7073
+ },
7074
+ {
7075
+ "name": "pages",
7076
+ "in": "query",
7077
+ "required": false,
7078
+ "type": "string",
7079
+ "example": "1-3",
7080
+ "description": "Physical page ordinals (`3` or `3-5`)",
7081
+ "alias": "p"
7082
+ },
7083
+ {
7084
+ "name": "printed",
7085
+ "in": "query",
7086
+ "required": false,
7087
+ "type": "string",
7088
+ "example": "17",
7089
+ "description": "An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number"
7090
+ },
7091
+ {
7092
+ "name": "printed_occurrence",
7093
+ "in": "query",
7094
+ "required": false,
7095
+ "type": "integer",
7096
+ "example": 1,
7097
+ "description": "Which page carrying a repeated printed label (1-based, page order)"
7098
+ },
7099
+ {
7100
+ "name": "neighbors",
7101
+ "in": "query",
7102
+ "required": false,
7103
+ "type": "integer",
7104
+ "example": 1,
7105
+ "description": "Widen the selection by this many blocks on each side (same version)"
7106
+ },
7107
+ {
7108
+ "name": "footnotes",
7109
+ "in": "query",
7110
+ "required": false,
7111
+ "type": "string",
7112
+ "enum": [
7113
+ "true",
7114
+ "false"
7115
+ ],
7116
+ "example": "true",
7117
+ "description": "Add the footnote blocks the selection links to (same version) (`true` or `false`)"
7118
+ },
7119
+ {
7120
+ "name": "limit",
7121
+ "in": "query",
7122
+ "required": false,
7123
+ "type": "integer",
7124
+ "example": 5,
7125
+ "description": "At most this many blocks (1-1000); the answer names the next block when cut",
7126
+ "alias": "l"
7127
+ },
7128
+ {
7129
+ "name": "version_id",
7130
+ "in": "path",
7131
+ "required": true,
7132
+ "type": "string",
7133
+ "example": "8be0b759-1a9d-5f89-8308-bd86185f5e1f",
7134
+ "description": "An immutable document version (`version.version_id` of a document read, a search hit's citation)"
7135
+ }
7136
+ ],
7137
+ "view": "json",
7138
+ "pagination": "none"
7139
+ },
5672
7140
  {
5673
7141
  "operationId": "segmentedFinancials",
5674
7142
  "group": "segments",