data-analyst-mcp 0.3.0 → 0.4.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.
- package/README.md +286 -262
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +10 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +38 -18
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +46 -13
- package/dist/server.js.map +1 -1
- package/dist/tools.js +27 -6
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +164 -162
- package/guide/assets/download_data.sh +8 -2
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +198 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/college-scorecard/source.md +1 -1
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/doj-news/source.md +1 -1
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fbi/source.md +3 -3
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/fsa/source.md +1 -1
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nhtsa/source.md +1 -1
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/port.json +65 -0
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/uspto/source.md +1 -1
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
package/packs/sec/endpoints.json
CHANGED
|
@@ -1,237 +1,237 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://data.sec.gov",
|
|
3
|
-
"endpoints": {
|
|
4
|
-
"company_search": {
|
|
5
|
-
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
6
|
-
"method": "GET",
|
|
7
|
-
"description": "Find companies (and people) by ticker or name: cik, name, tickers (EDGAR's search-box index).",
|
|
8
|
-
"params": {
|
|
9
|
-
"text": {
|
|
10
|
-
"required": true,
|
|
11
|
-
"desc": "ticker or name, e.g. 'AAPL' or 'apple'"
|
|
12
|
-
}
|
|
13
|
-
},
|
|
14
|
-
"records": "hits.hits",
|
|
15
|
-
"paging": {
|
|
16
|
-
"type": "none"
|
|
17
|
-
}
|
|
18
|
-
},
|
|
19
|
-
"submissions": {
|
|
20
|
-
"path": "/submissions/CIK{cik10}.json",
|
|
21
|
-
"method": "GET",
|
|
22
|
-
"description": "A company's filing history: one row per filing (form, filingDate, reportDate, accessionNumber, primaryDocument, url), newest first; profile columns cik, entity_name, sic.",
|
|
23
|
-
"params": {
|
|
24
|
-
"cik": {
|
|
25
|
-
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
26
|
-
},
|
|
27
|
-
"ticker": {
|
|
28
|
-
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
29
|
-
},
|
|
30
|
-
"forms": {
|
|
31
|
-
"desc": "comma-separated forms to keep, e.g. '10-K,10-Q' (amendments 10-K/A kept only if listed)"
|
|
32
|
-
},
|
|
33
|
-
"since": {
|
|
34
|
-
"desc": "keep filings on or after YYYY-MM-DD"
|
|
35
|
-
},
|
|
36
|
-
"all": {
|
|
37
|
-
"desc": "true = also read the older-filings files (filings.files); otherwise the latest 1,000 or so"
|
|
38
|
-
}
|
|
39
|
-
},
|
|
40
|
-
"records": "filings.recent",
|
|
41
|
-
"paging": {
|
|
42
|
-
"type": "none"
|
|
43
|
-
}
|
|
44
|
-
},
|
|
45
|
-
"company_concept": {
|
|
46
|
-
"path": "/api/xbrl/companyconcept/CIK{cik10}/{taxonomy}/{tag}.json",
|
|
47
|
-
"method": "GET",
|
|
48
|
-
"description": "Every value one company reported for one XBRL concept: one row per fact (start, end, period_days, val, unit, fy, fp, form, filed, accn, frame).",
|
|
49
|
-
"params": {
|
|
50
|
-
"cik": {
|
|
51
|
-
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
52
|
-
},
|
|
53
|
-
"ticker": {
|
|
54
|
-
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
55
|
-
},
|
|
56
|
-
"tag": {
|
|
57
|
-
"required": true,
|
|
58
|
-
"desc": "XBRL concept, e.g. NetIncomeLoss, Revenues, Assets (case-sensitive)"
|
|
59
|
-
},
|
|
60
|
-
"taxonomy": {
|
|
61
|
-
"desc": "us-gaap (default), ifrs-full, dei, srt"
|
|
62
|
-
},
|
|
63
|
-
"unit": {
|
|
64
|
-
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
65
|
-
},
|
|
66
|
-
"forms": {
|
|
67
|
-
"desc": "comma-separated forms to keep, e.g. '10-K' (prefix match: 10-K keeps 10-K/A)"
|
|
68
|
-
},
|
|
69
|
-
"frames_only": {
|
|
70
|
-
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
71
|
-
},
|
|
72
|
-
"duration": {
|
|
73
|
-
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
74
|
-
}
|
|
75
|
-
},
|
|
76
|
-
"defaults": {
|
|
77
|
-
"taxonomy": "us-gaap"
|
|
78
|
-
},
|
|
79
|
-
"records": "units",
|
|
80
|
-
"paging": {
|
|
81
|
-
"type": "none"
|
|
82
|
-
}
|
|
83
|
-
},
|
|
84
|
-
"company_facts": {
|
|
85
|
-
"path": "/api/xbrl/companyfacts/CIK{cik10}.json",
|
|
86
|
-
"method": "GET",
|
|
87
|
-
"description": "Every XBRL fact a company reported, all concepts: one row per fact with taxonomy and tag columns (large: tens of thousands of rows for big filers; set tags).",
|
|
88
|
-
"params": {
|
|
89
|
-
"cik": {
|
|
90
|
-
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
91
|
-
},
|
|
92
|
-
"ticker": {
|
|
93
|
-
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
94
|
-
},
|
|
95
|
-
"tags": {
|
|
96
|
-
"desc": "comma-separated concepts to keep, e.g. 'Revenues,NetIncomeLoss,Assets'"
|
|
97
|
-
},
|
|
98
|
-
"taxonomy": {
|
|
99
|
-
"desc": "keep one taxonomy (us-gaap, dei, ifrs-full)"
|
|
100
|
-
},
|
|
101
|
-
"forms": {
|
|
102
|
-
"desc": "comma-separated forms to keep (prefix match)"
|
|
103
|
-
},
|
|
104
|
-
"unit": {
|
|
105
|
-
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
106
|
-
},
|
|
107
|
-
"frames_only": {
|
|
108
|
-
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
109
|
-
},
|
|
110
|
-
"duration": {
|
|
111
|
-
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
112
|
-
}
|
|
113
|
-
},
|
|
114
|
-
"records": "facts",
|
|
115
|
-
"paging": {
|
|
116
|
-
"type": "none"
|
|
117
|
-
}
|
|
118
|
-
},
|
|
119
|
-
"frames": {
|
|
120
|
-
"path": "/api/xbrl/frames/{taxonomy}/{tag}/{unit}/{period}.json",
|
|
121
|
-
"method": "GET",
|
|
122
|
-
"description": "One concept for every reporting company in one calendar period: one row per company (cik, entityName, loc, start, end, val, accn).",
|
|
123
|
-
"params": {
|
|
124
|
-
"tag": {
|
|
125
|
-
"required": true,
|
|
126
|
-
"desc": "XBRL concept, e.g. Assets"
|
|
127
|
-
},
|
|
128
|
-
"period": {
|
|
129
|
-
"required": true,
|
|
130
|
-
"desc": "CY2023 (annual), CY2023Q1 (quarter), CY2023Q4I (instant: balance-sheet items)"
|
|
131
|
-
},
|
|
132
|
-
"unit": {
|
|
133
|
-
"desc": "USD (default), shares, USD-per-shares, pure; USD/shares is accepted and sent as USD-per-shares"
|
|
134
|
-
},
|
|
135
|
-
"taxonomy": {
|
|
136
|
-
"desc": "us-gaap (default)"
|
|
137
|
-
}
|
|
138
|
-
},
|
|
139
|
-
"defaults": {
|
|
140
|
-
"taxonomy": "us-gaap",
|
|
141
|
-
"unit": "USD"
|
|
142
|
-
},
|
|
143
|
-
"records": "data",
|
|
144
|
-
"paging": {
|
|
145
|
-
"type": "none"
|
|
146
|
-
}
|
|
147
|
-
},
|
|
148
|
-
"full_text_search": {
|
|
149
|
-
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
150
|
-
"method": "GET",
|
|
151
|
-
"description": "EDGAR full-text search (2001-): one row per matching DOCUMENT (a filing's main file and each exhibit are separate hits): adsh, form, file_date, entity, file_type, url.",
|
|
152
|
-
"params": {
|
|
153
|
-
"q": {
|
|
154
|
-
"required": true,
|
|
155
|
-
"desc": "words; quote phrases: '\"climate risk\"'; AND/OR/NOT supported"
|
|
156
|
-
},
|
|
157
|
-
"forms": {
|
|
158
|
-
"desc": "comma-separated forms, e.g. '10-K' or '8-K,8-K/A'"
|
|
159
|
-
},
|
|
160
|
-
"startdt": {
|
|
161
|
-
"desc": "YYYY-MM-DD"
|
|
162
|
-
},
|
|
163
|
-
"enddt": {
|
|
164
|
-
"desc": "YYYY-MM-DD"
|
|
165
|
-
},
|
|
166
|
-
"ciks": {
|
|
167
|
-
"desc": "limit to one company: 10-digit CIK"
|
|
168
|
-
}
|
|
169
|
-
},
|
|
170
|
-
"records": "hits.hits",
|
|
171
|
-
"paging": {
|
|
172
|
-
"type": "none"
|
|
173
|
-
},
|
|
174
|
-
"max_rows": 10000
|
|
175
|
-
},
|
|
176
|
-
"insider_filings": {
|
|
177
|
-
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
178
|
-
"method": "GET",
|
|
179
|
-
"description": "Insider ownership filings (Form 4 by default; 3, 5) where the company is the issuer: one row per filing with insider name and CIK, filing and period dates, link.",
|
|
180
|
-
"params": {
|
|
181
|
-
"cik": {
|
|
182
|
-
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
183
|
-
},
|
|
184
|
-
"ticker": {
|
|
185
|
-
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
186
|
-
},
|
|
187
|
-
"forms": {
|
|
188
|
-
"desc": "4 (default), 3, 5 or a comma list"
|
|
189
|
-
},
|
|
190
|
-
"startdt": {
|
|
191
|
-
"desc": "YYYY-MM-DD"
|
|
192
|
-
},
|
|
193
|
-
"enddt": {
|
|
194
|
-
"desc": "YYYY-MM-DD"
|
|
195
|
-
}
|
|
196
|
-
},
|
|
197
|
-
"defaults": {
|
|
198
|
-
"forms": "4"
|
|
199
|
-
},
|
|
200
|
-
"records": "hits.hits",
|
|
201
|
-
"paging": {
|
|
202
|
-
"type": "none"
|
|
203
|
-
},
|
|
204
|
-
"max_rows": 10000
|
|
205
|
-
}
|
|
206
|
-
},
|
|
207
|
-
"catalog": {},
|
|
208
|
-
"concepts": {
|
|
209
|
-
"Revenues": "Total revenue (many companies use RevenueFromContractWithCustomerExcludingAssessedTax instead)",
|
|
210
|
-
"RevenueFromContractWithCustomerExcludingAssessedTax": "Revenue from contracts with customers (ASC 606, 2018-)",
|
|
211
|
-
"NetIncomeLoss": "Net income (loss) attributable to the parent",
|
|
212
|
-
"OperatingIncomeLoss": "Operating income (loss)",
|
|
213
|
-
"GrossProfit": "Gross profit",
|
|
214
|
-
"Assets": "Total assets (instant)",
|
|
215
|
-
"Liabilities": "Total liabilities (instant; not reported by every filer)",
|
|
216
|
-
"LiabilitiesAndStockholdersEquity": "Total liabilities and equity (instant)",
|
|
217
|
-
"StockholdersEquity": "Total stockholders' equity (instant)",
|
|
218
|
-
"CashAndCashEquivalentsAtCarryingValue": "Cash and cash equivalents (instant)",
|
|
219
|
-
"LongTermDebt": "Long-term debt (instant)",
|
|
220
|
-
"EarningsPerShareBasic": "Basic EPS (unit USD/shares)",
|
|
221
|
-
"EarningsPerShareDiluted": "Diluted EPS (unit USD/shares)",
|
|
222
|
-
"CommonStockSharesOutstanding": "Common shares outstanding (unit shares)",
|
|
223
|
-
"EntityCommonStockSharesOutstanding": "dei: shares outstanding on the cover page",
|
|
224
|
-
"Goodwill": "Goodwill (instant)",
|
|
225
|
-
"GoodwillImpairmentLoss": "Goodwill impairment loss",
|
|
226
|
-
"ResearchAndDevelopmentExpense": "R&D expense",
|
|
227
|
-
"SellingGeneralAndAdministrativeExpense": "SG&A expense",
|
|
228
|
-
"InterestExpense": "Interest expense",
|
|
229
|
-
"IncomeTaxExpenseBenefit": "Income tax expense (benefit)",
|
|
230
|
-
"NetCashProvidedByUsedInOperatingActivities": "Operating cash flow",
|
|
231
|
-
"PaymentsForRepurchaseOfCommonStock": "Share buybacks",
|
|
232
|
-
"PaymentsOfDividends": "Dividends paid"
|
|
233
|
-
},
|
|
234
|
-
"headers": {
|
|
235
|
-
"Accept": "application/json"
|
|
236
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://data.sec.gov",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"company_search": {
|
|
5
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
6
|
+
"method": "GET",
|
|
7
|
+
"description": "Find companies (and people) by ticker or name: cik, name, tickers (EDGAR's search-box index).",
|
|
8
|
+
"params": {
|
|
9
|
+
"text": {
|
|
10
|
+
"required": true,
|
|
11
|
+
"desc": "ticker or name, e.g. 'AAPL' or 'apple'"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"records": "hits.hits",
|
|
15
|
+
"paging": {
|
|
16
|
+
"type": "none"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"submissions": {
|
|
20
|
+
"path": "/submissions/CIK{cik10}.json",
|
|
21
|
+
"method": "GET",
|
|
22
|
+
"description": "A company's filing history: one row per filing (form, filingDate, reportDate, accessionNumber, primaryDocument, url), newest first; profile columns cik, entity_name, sic.",
|
|
23
|
+
"params": {
|
|
24
|
+
"cik": {
|
|
25
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
26
|
+
},
|
|
27
|
+
"ticker": {
|
|
28
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
29
|
+
},
|
|
30
|
+
"forms": {
|
|
31
|
+
"desc": "comma-separated forms to keep, e.g. '10-K,10-Q' (amendments 10-K/A kept only if listed)"
|
|
32
|
+
},
|
|
33
|
+
"since": {
|
|
34
|
+
"desc": "keep filings on or after YYYY-MM-DD"
|
|
35
|
+
},
|
|
36
|
+
"all": {
|
|
37
|
+
"desc": "true = also read the older-filings files (filings.files); otherwise the latest 1,000 or so"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"records": "filings.recent",
|
|
41
|
+
"paging": {
|
|
42
|
+
"type": "none"
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"company_concept": {
|
|
46
|
+
"path": "/api/xbrl/companyconcept/CIK{cik10}/{taxonomy}/{tag}.json",
|
|
47
|
+
"method": "GET",
|
|
48
|
+
"description": "Every value one company reported for one XBRL concept: one row per fact (start, end, period_days, val, unit, fy, fp, form, filed, accn, frame).",
|
|
49
|
+
"params": {
|
|
50
|
+
"cik": {
|
|
51
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
52
|
+
},
|
|
53
|
+
"ticker": {
|
|
54
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
55
|
+
},
|
|
56
|
+
"tag": {
|
|
57
|
+
"required": true,
|
|
58
|
+
"desc": "XBRL concept, e.g. NetIncomeLoss, Revenues, Assets (case-sensitive)"
|
|
59
|
+
},
|
|
60
|
+
"taxonomy": {
|
|
61
|
+
"desc": "us-gaap (default), ifrs-full, dei, srt"
|
|
62
|
+
},
|
|
63
|
+
"unit": {
|
|
64
|
+
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
65
|
+
},
|
|
66
|
+
"forms": {
|
|
67
|
+
"desc": "comma-separated forms to keep, e.g. '10-K' (prefix match: 10-K keeps 10-K/A)"
|
|
68
|
+
},
|
|
69
|
+
"frames_only": {
|
|
70
|
+
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
71
|
+
},
|
|
72
|
+
"duration": {
|
|
73
|
+
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"defaults": {
|
|
77
|
+
"taxonomy": "us-gaap"
|
|
78
|
+
},
|
|
79
|
+
"records": "units",
|
|
80
|
+
"paging": {
|
|
81
|
+
"type": "none"
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"company_facts": {
|
|
85
|
+
"path": "/api/xbrl/companyfacts/CIK{cik10}.json",
|
|
86
|
+
"method": "GET",
|
|
87
|
+
"description": "Every XBRL fact a company reported, all concepts: one row per fact with taxonomy and tag columns (large: tens of thousands of rows for big filers; set tags).",
|
|
88
|
+
"params": {
|
|
89
|
+
"cik": {
|
|
90
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
91
|
+
},
|
|
92
|
+
"ticker": {
|
|
93
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
94
|
+
},
|
|
95
|
+
"tags": {
|
|
96
|
+
"desc": "comma-separated concepts to keep, e.g. 'Revenues,NetIncomeLoss,Assets'"
|
|
97
|
+
},
|
|
98
|
+
"taxonomy": {
|
|
99
|
+
"desc": "keep one taxonomy (us-gaap, dei, ifrs-full)"
|
|
100
|
+
},
|
|
101
|
+
"forms": {
|
|
102
|
+
"desc": "comma-separated forms to keep (prefix match)"
|
|
103
|
+
},
|
|
104
|
+
"unit": {
|
|
105
|
+
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
106
|
+
},
|
|
107
|
+
"frames_only": {
|
|
108
|
+
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
109
|
+
},
|
|
110
|
+
"duration": {
|
|
111
|
+
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"records": "facts",
|
|
115
|
+
"paging": {
|
|
116
|
+
"type": "none"
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"frames": {
|
|
120
|
+
"path": "/api/xbrl/frames/{taxonomy}/{tag}/{unit}/{period}.json",
|
|
121
|
+
"method": "GET",
|
|
122
|
+
"description": "One concept for every reporting company in one calendar period: one row per company (cik, entityName, loc, start, end, val, accn).",
|
|
123
|
+
"params": {
|
|
124
|
+
"tag": {
|
|
125
|
+
"required": true,
|
|
126
|
+
"desc": "XBRL concept, e.g. Assets"
|
|
127
|
+
},
|
|
128
|
+
"period": {
|
|
129
|
+
"required": true,
|
|
130
|
+
"desc": "CY2023 (annual), CY2023Q1 (quarter), CY2023Q4I (instant: balance-sheet items)"
|
|
131
|
+
},
|
|
132
|
+
"unit": {
|
|
133
|
+
"desc": "USD (default), shares, USD-per-shares, pure; USD/shares is accepted and sent as USD-per-shares"
|
|
134
|
+
},
|
|
135
|
+
"taxonomy": {
|
|
136
|
+
"desc": "us-gaap (default)"
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
"defaults": {
|
|
140
|
+
"taxonomy": "us-gaap",
|
|
141
|
+
"unit": "USD"
|
|
142
|
+
},
|
|
143
|
+
"records": "data",
|
|
144
|
+
"paging": {
|
|
145
|
+
"type": "none"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"full_text_search": {
|
|
149
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
150
|
+
"method": "GET",
|
|
151
|
+
"description": "EDGAR full-text search (2001-): one row per matching DOCUMENT (a filing's main file and each exhibit are separate hits): adsh, form, file_date, entity, file_type, url.",
|
|
152
|
+
"params": {
|
|
153
|
+
"q": {
|
|
154
|
+
"required": true,
|
|
155
|
+
"desc": "words; quote phrases: '\"climate risk\"'; AND/OR/NOT supported"
|
|
156
|
+
},
|
|
157
|
+
"forms": {
|
|
158
|
+
"desc": "comma-separated forms, e.g. '10-K' or '8-K,8-K/A'"
|
|
159
|
+
},
|
|
160
|
+
"startdt": {
|
|
161
|
+
"desc": "YYYY-MM-DD"
|
|
162
|
+
},
|
|
163
|
+
"enddt": {
|
|
164
|
+
"desc": "YYYY-MM-DD"
|
|
165
|
+
},
|
|
166
|
+
"ciks": {
|
|
167
|
+
"desc": "limit to one company: 10-digit CIK"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"records": "hits.hits",
|
|
171
|
+
"paging": {
|
|
172
|
+
"type": "none"
|
|
173
|
+
},
|
|
174
|
+
"max_rows": 10000
|
|
175
|
+
},
|
|
176
|
+
"insider_filings": {
|
|
177
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
178
|
+
"method": "GET",
|
|
179
|
+
"description": "Insider ownership filings (Form 4 by default; 3, 5) where the company is the issuer: one row per filing with insider name and CIK, filing and period dates, link.",
|
|
180
|
+
"params": {
|
|
181
|
+
"cik": {
|
|
182
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
183
|
+
},
|
|
184
|
+
"ticker": {
|
|
185
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
186
|
+
},
|
|
187
|
+
"forms": {
|
|
188
|
+
"desc": "4 (default), 3, 5 or a comma list"
|
|
189
|
+
},
|
|
190
|
+
"startdt": {
|
|
191
|
+
"desc": "YYYY-MM-DD"
|
|
192
|
+
},
|
|
193
|
+
"enddt": {
|
|
194
|
+
"desc": "YYYY-MM-DD"
|
|
195
|
+
}
|
|
196
|
+
},
|
|
197
|
+
"defaults": {
|
|
198
|
+
"forms": "4"
|
|
199
|
+
},
|
|
200
|
+
"records": "hits.hits",
|
|
201
|
+
"paging": {
|
|
202
|
+
"type": "none"
|
|
203
|
+
},
|
|
204
|
+
"max_rows": 10000
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"catalog": {},
|
|
208
|
+
"concepts": {
|
|
209
|
+
"Revenues": "Total revenue (many companies use RevenueFromContractWithCustomerExcludingAssessedTax instead)",
|
|
210
|
+
"RevenueFromContractWithCustomerExcludingAssessedTax": "Revenue from contracts with customers (ASC 606, 2018-)",
|
|
211
|
+
"NetIncomeLoss": "Net income (loss) attributable to the parent",
|
|
212
|
+
"OperatingIncomeLoss": "Operating income (loss)",
|
|
213
|
+
"GrossProfit": "Gross profit",
|
|
214
|
+
"Assets": "Total assets (instant)",
|
|
215
|
+
"Liabilities": "Total liabilities (instant; not reported by every filer)",
|
|
216
|
+
"LiabilitiesAndStockholdersEquity": "Total liabilities and equity (instant)",
|
|
217
|
+
"StockholdersEquity": "Total stockholders' equity (instant)",
|
|
218
|
+
"CashAndCashEquivalentsAtCarryingValue": "Cash and cash equivalents (instant)",
|
|
219
|
+
"LongTermDebt": "Long-term debt (instant)",
|
|
220
|
+
"EarningsPerShareBasic": "Basic EPS (unit USD/shares)",
|
|
221
|
+
"EarningsPerShareDiluted": "Diluted EPS (unit USD/shares)",
|
|
222
|
+
"CommonStockSharesOutstanding": "Common shares outstanding (unit shares)",
|
|
223
|
+
"EntityCommonStockSharesOutstanding": "dei: shares outstanding on the cover page",
|
|
224
|
+
"Goodwill": "Goodwill (instant)",
|
|
225
|
+
"GoodwillImpairmentLoss": "Goodwill impairment loss",
|
|
226
|
+
"ResearchAndDevelopmentExpense": "R&D expense",
|
|
227
|
+
"SellingGeneralAndAdministrativeExpense": "SG&A expense",
|
|
228
|
+
"InterestExpense": "Interest expense",
|
|
229
|
+
"IncomeTaxExpenseBenefit": "Income tax expense (benefit)",
|
|
230
|
+
"NetCashProvidedByUsedInOperatingActivities": "Operating cash flow",
|
|
231
|
+
"PaymentsForRepurchaseOfCommonStock": "Share buybacks",
|
|
232
|
+
"PaymentsOfDividends": "Dividends paid"
|
|
233
|
+
},
|
|
234
|
+
"headers": {
|
|
235
|
+
"Accept": "application/json"
|
|
236
|
+
}
|
|
237
237
|
}
|
package/packs/sec/policy.json
CHANGED
|
@@ -1,86 +1,86 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "sec",
|
|
3
|
-
"title": "SEC EDGAR (XBRL financial data, filings, full-text search)",
|
|
4
|
-
"agency": "U.S. Securities and Exchange Commission",
|
|
5
|
-
"depth": "standard",
|
|
6
|
-
"domains": [
|
|
7
|
-
"finance",
|
|
8
|
-
"corporations",
|
|
9
|
-
"securities"
|
|
10
|
-
],
|
|
11
|
-
"keywords": [
|
|
12
|
-
"sec",
|
|
13
|
-
"edgar",
|
|
14
|
-
"10-k",
|
|
15
|
-
"10-q",
|
|
16
|
-
"8-k",
|
|
17
|
-
"annual report",
|
|
18
|
-
"public company",
|
|
19
|
-
"company financials",
|
|
20
|
-
"revenue",
|
|
21
|
-
"net income",
|
|
22
|
-
"earnings per share",
|
|
23
|
-
"total assets",
|
|
24
|
-
"xbrl",
|
|
25
|
-
"filings",
|
|
26
|
-
"insider trading",
|
|
27
|
-
"form 4",
|
|
28
|
-
"full-text search",
|
|
29
|
-
"cik",
|
|
30
|
-
"ticker"
|
|
31
|
-
],
|
|
32
|
-
"questions": [
|
|
33
|
-
"a public company's annual revenue and net income over ten years",
|
|
34
|
-
"total assets of every public company in 2023",
|
|
35
|
-
"which 10-K filings mention climate risk",
|
|
36
|
-
"recent insider (Form 4) filings for a company",
|
|
37
|
-
"list of a company's 8-K filings since 2024"
|
|
38
|
-
],
|
|
39
|
-
"homepage": "https://www.sec.gov/search-filings/edgar-application-programming-interfaces",
|
|
40
|
-
"terms_url": "https://www.sec.gov/about/privacy-information#security",
|
|
41
|
-
"auth": {
|
|
42
|
-
"env": null,
|
|
43
|
-
"required": "none",
|
|
44
|
-
"placement": "none",
|
|
45
|
-
"signup_url": null,
|
|
46
|
-
"echoes_key": false
|
|
47
|
-
},
|
|
48
|
-
"limits": {
|
|
49
|
-
"rps": 5,
|
|
50
|
-
"burst": 5,
|
|
51
|
-
"max_rows": 100000
|
|
52
|
-
},
|
|
53
|
-
"routes": {
|
|
54
|
-
"api": {
|
|
55
|
-
"base": "https://data.sec.gov",
|
|
56
|
-
"probe": "https://data.sec.gov/api/xbrl/frames/us-gaap/GoodwillImpairmentLoss/USD/CY2023Q4.json",
|
|
57
|
-
"hosts": [
|
|
58
|
-
"data.sec.gov",
|
|
59
|
-
"efts.sec.gov"
|
|
60
|
-
]
|
|
61
|
-
},
|
|
62
|
-
"manual": {
|
|
63
|
-
"how": "Open the JSON links in INSTRUCTIONS.md in a browser (data.sec.gov and efts.sec.gov accept a browser) and save each under the name shown, or use EDGAR full-text search (https://efts.sec.gov/LATEST/search-index is behind https://www.sec.gov/edgar/search/) and company pages (https://www.sec.gov/edgar/searchedgar/companysearch); upload the files."
|
|
64
|
-
}
|
|
65
|
-
},
|
|
66
|
-
"cache": {
|
|
67
|
-
"mode": "run_only",
|
|
68
|
-
"ttl_hours": null,
|
|
69
|
-
"why": "Filings arrive continuously and companyfacts change with each filing; data/ is reused within a run."
|
|
70
|
-
},
|
|
71
|
-
"redistribution": {
|
|
72
|
-
"mode": "allowed",
|
|
73
|
-
"why": "EDGAR filings are public records and SEC data are U.S. government works (17 U.S.C. 105); SEC's fair-access policy limits request rates, not reuse."
|
|
74
|
-
},
|
|
75
|
-
"notices": [],
|
|
76
|
-
"retention": null,
|
|
77
|
-
"citation": "U.S. Securities and Exchange Commission, EDGAR {dataset}, data.sec.gov, retrieved {retrieved_long}.",
|
|
78
|
-
"audit_hooks": [],
|
|
79
|
-
"clarify": [
|
|
80
|
-
"Fiscal or calendar years? XBRL facts carry the company's fiscal year (fy) and period dates; the frames API realigns to calendar periods.",
|
|
81
|
-
"As first reported or latest restated values? Each 10-K repeats and may restate prior years; frames_only keeps the latest filed value per period."
|
|
82
|
-
],
|
|
83
|
-
"formats": [
|
|
84
|
-
"json"
|
|
85
|
-
]
|
|
86
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "sec",
|
|
3
|
+
"title": "SEC EDGAR (XBRL financial data, filings, full-text search)",
|
|
4
|
+
"agency": "U.S. Securities and Exchange Commission",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"finance",
|
|
8
|
+
"corporations",
|
|
9
|
+
"securities"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"sec",
|
|
13
|
+
"edgar",
|
|
14
|
+
"10-k",
|
|
15
|
+
"10-q",
|
|
16
|
+
"8-k",
|
|
17
|
+
"annual report",
|
|
18
|
+
"public company",
|
|
19
|
+
"company financials",
|
|
20
|
+
"revenue",
|
|
21
|
+
"net income",
|
|
22
|
+
"earnings per share",
|
|
23
|
+
"total assets",
|
|
24
|
+
"xbrl",
|
|
25
|
+
"filings",
|
|
26
|
+
"insider trading",
|
|
27
|
+
"form 4",
|
|
28
|
+
"full-text search",
|
|
29
|
+
"cik",
|
|
30
|
+
"ticker"
|
|
31
|
+
],
|
|
32
|
+
"questions": [
|
|
33
|
+
"a public company's annual revenue and net income over ten years",
|
|
34
|
+
"total assets of every public company in 2023",
|
|
35
|
+
"which 10-K filings mention climate risk",
|
|
36
|
+
"recent insider (Form 4) filings for a company",
|
|
37
|
+
"list of a company's 8-K filings since 2024"
|
|
38
|
+
],
|
|
39
|
+
"homepage": "https://www.sec.gov/search-filings/edgar-application-programming-interfaces",
|
|
40
|
+
"terms_url": "https://www.sec.gov/about/privacy-information#security",
|
|
41
|
+
"auth": {
|
|
42
|
+
"env": null,
|
|
43
|
+
"required": "none",
|
|
44
|
+
"placement": "none",
|
|
45
|
+
"signup_url": null,
|
|
46
|
+
"echoes_key": false
|
|
47
|
+
},
|
|
48
|
+
"limits": {
|
|
49
|
+
"rps": 5,
|
|
50
|
+
"burst": 5,
|
|
51
|
+
"max_rows": 100000
|
|
52
|
+
},
|
|
53
|
+
"routes": {
|
|
54
|
+
"api": {
|
|
55
|
+
"base": "https://data.sec.gov",
|
|
56
|
+
"probe": "https://data.sec.gov/api/xbrl/frames/us-gaap/GoodwillImpairmentLoss/USD/CY2023Q4.json",
|
|
57
|
+
"hosts": [
|
|
58
|
+
"data.sec.gov",
|
|
59
|
+
"efts.sec.gov"
|
|
60
|
+
]
|
|
61
|
+
},
|
|
62
|
+
"manual": {
|
|
63
|
+
"how": "Open the JSON links in INSTRUCTIONS.md in a browser (data.sec.gov and efts.sec.gov accept a browser) and save each under the name shown, or use EDGAR full-text search (https://efts.sec.gov/LATEST/search-index is behind https://www.sec.gov/edgar/search/) and company pages (https://www.sec.gov/edgar/searchedgar/companysearch); upload the files."
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"cache": {
|
|
67
|
+
"mode": "run_only",
|
|
68
|
+
"ttl_hours": null,
|
|
69
|
+
"why": "Filings arrive continuously and companyfacts change with each filing; data/ is reused within a run."
|
|
70
|
+
},
|
|
71
|
+
"redistribution": {
|
|
72
|
+
"mode": "allowed",
|
|
73
|
+
"why": "EDGAR filings are public records and SEC data are U.S. government works (17 U.S.C. 105); SEC's fair-access policy limits request rates, not reuse."
|
|
74
|
+
},
|
|
75
|
+
"notices": [],
|
|
76
|
+
"retention": null,
|
|
77
|
+
"citation": "U.S. Securities and Exchange Commission, EDGAR {dataset}, data.sec.gov, retrieved {retrieved_long}.",
|
|
78
|
+
"audit_hooks": [],
|
|
79
|
+
"clarify": [
|
|
80
|
+
"Fiscal or calendar years? XBRL facts carry the company's fiscal year (fy) and period dates; the frames API realigns to calendar periods.",
|
|
81
|
+
"As first reported or latest restated values? Each 10-K repeats and may restate prior years; frames_only keeps the latest filed value per period."
|
|
82
|
+
],
|
|
83
|
+
"formats": [
|
|
84
|
+
"json"
|
|
85
|
+
]
|
|
86
|
+
}
|