data-analyst-mcp 0.3.0 → 0.3.1

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 (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. package/packs/world-bank/policy.json +101 -101
@@ -1,86 +1,86 @@
1
- {
2
- "id": "regulations",
3
- "title": "Regulations.gov (API v4)",
4
- "agency": "General Services Administration (eRulemaking Program), for participating federal agencies",
5
- "depth": "standard",
6
- "domains": [
7
- "legislation",
8
- "regulation",
9
- "rulemaking"
10
- ],
11
- "keywords": [
12
- "regulations.gov",
13
- "public comment",
14
- "public comments",
15
- "comments",
16
- "docket",
17
- "dockets",
18
- "rulemaking",
19
- "proposed rule",
20
- "final rule",
21
- "comment period",
22
- "notice and comment",
23
- "erulemaking"
24
- ],
25
- "questions": [
26
- "how many public comments did a proposed rule receive",
27
- "proposed rules open for comment at EPA",
28
- "dockets an agency opened this year",
29
- "comments on a docket over time"
30
- ],
31
- "homepage": "https://www.regulations.gov/",
32
- "terms_url": "https://open.gsa.gov/api/regulationsgov/",
33
- "auth": {
34
- "env": "DATA_GOV_API_KEY",
35
- "required": "optional",
36
- "placement": "query",
37
- "param": "api_key",
38
- "home": "data-gov",
39
- "signup_url": "https://api.data.gov/signup/",
40
- "echoes_key": false,
41
- "demo_key": "DEMO_KEY",
42
- "key_only": [
43
- "more than about 10 requests an hour (DEMO_KEY limit); a free key allows 1,000 an hour"
44
- ]
45
- },
46
- "limits": {
47
- "rps": 1,
48
- "burst": 4,
49
- "daily_quota": null,
50
- "max_rows": 10000
51
- },
52
- "routes": {
53
- "api": {
54
- "base": "https://api.regulations.gov/v4",
55
- "probe": "https://api.regulations.gov/v4/documents?page%5Bsize%5D=5",
56
- "hosts": [
57
- "api.regulations.gov"
58
- ]
59
- },
60
- "manual": {
61
- "how": "Open each link in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY, about 10 requests an hour; put your own api.data.gov key in its place for more) and save the JSON under the given name; or search on https://www.regulations.gov, open the docket's 'Browse Comments' or 'Browse Documents' list, use 'Download' (CSV export of up to the first results), and upload the file."
62
- }
63
- },
64
- "cache": {
65
- "mode": "run_only",
66
- "ttl_hours": null,
67
- "why": "Dockets gain documents and comments daily; data/ is reused within a run."
68
- },
69
- "redistribution": {
70
- "mode": "allowed",
71
- "why": "Federal agency documents and the metadata are U.S. government works (17 U.S.C. 105). Public submissions are posted as received: attachments can contain third-party copyrighted material and personal information the submitter chose to include; share counts and metadata, and quote comment text sparingly."
72
- },
73
- "notices": [
74
- "Public comments on Regulations.gov are posted by the agencies as received; posted counts can differ from comments received (agencies may withhold duplicates, mass-mail campaigns or sensitive submissions)."
75
- ],
76
- "retention": null,
77
- "citation": "Regulations.gov API v4 (eRulemaking Program, GSA), {dataset}, api.regulations.gov, retrieved {retrieved_long}.",
78
- "audit_hooks": [],
79
- "clarify": [
80
- "Comments posted or comments received? The API counts posted comments only; agencies may post a sample or one copy of a mass-mail campaign.",
81
- "Which document or docket? Comments filed on a docket (filter[docketId]) include every document in it; on one document use filter[commentOnId] with its objectId."
82
- ],
83
- "formats": [
84
- "json"
85
- ]
86
- }
1
+ {
2
+ "id": "regulations",
3
+ "title": "Regulations.gov (API v4)",
4
+ "agency": "General Services Administration (eRulemaking Program), for participating federal agencies",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "legislation",
8
+ "regulation",
9
+ "rulemaking"
10
+ ],
11
+ "keywords": [
12
+ "regulations.gov",
13
+ "public comment",
14
+ "public comments",
15
+ "comments",
16
+ "docket",
17
+ "dockets",
18
+ "rulemaking",
19
+ "proposed rule",
20
+ "final rule",
21
+ "comment period",
22
+ "notice and comment",
23
+ "erulemaking"
24
+ ],
25
+ "questions": [
26
+ "how many public comments did a proposed rule receive",
27
+ "proposed rules open for comment at EPA",
28
+ "dockets an agency opened this year",
29
+ "comments on a docket over time"
30
+ ],
31
+ "homepage": "https://www.regulations.gov/",
32
+ "terms_url": "https://open.gsa.gov/api/regulationsgov/",
33
+ "auth": {
34
+ "env": "DATA_GOV_API_KEY",
35
+ "required": "optional",
36
+ "placement": "query",
37
+ "param": "api_key",
38
+ "home": "data-gov",
39
+ "signup_url": "https://api.data.gov/signup/",
40
+ "echoes_key": false,
41
+ "demo_key": "DEMO_KEY",
42
+ "key_only": [
43
+ "more than about 10 requests an hour (DEMO_KEY limit); a free key allows 1,000 an hour"
44
+ ]
45
+ },
46
+ "limits": {
47
+ "rps": 1,
48
+ "burst": 4,
49
+ "daily_quota": null,
50
+ "max_rows": 10000
51
+ },
52
+ "routes": {
53
+ "api": {
54
+ "base": "https://api.regulations.gov/v4",
55
+ "probe": "https://api.regulations.gov/v4/documents?page%5Bsize%5D=5",
56
+ "hosts": [
57
+ "api.regulations.gov"
58
+ ]
59
+ },
60
+ "manual": {
61
+ "how": "Open each link in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY, about 10 requests an hour; put your own api.data.gov key in its place for more) and save the JSON under the given name; or search on https://www.regulations.gov, open the docket's 'Browse Comments' or 'Browse Documents' list, use 'Download' (CSV export of up to the first results), and upload the file."
62
+ }
63
+ },
64
+ "cache": {
65
+ "mode": "run_only",
66
+ "ttl_hours": null,
67
+ "why": "Dockets gain documents and comments daily; data/ is reused within a run."
68
+ },
69
+ "redistribution": {
70
+ "mode": "allowed",
71
+ "why": "Federal agency documents and the metadata are U.S. government works (17 U.S.C. 105). Public submissions are posted as received: attachments can contain third-party copyrighted material and personal information the submitter chose to include; share counts and metadata, and quote comment text sparingly."
72
+ },
73
+ "notices": [
74
+ "Public comments on Regulations.gov are posted by the agencies as received; posted counts can differ from comments received (agencies may withhold duplicates, mass-mail campaigns or sensitive submissions)."
75
+ ],
76
+ "retention": null,
77
+ "citation": "Regulations.gov API v4 (eRulemaking Program, GSA), {dataset}, api.regulations.gov, retrieved {retrieved_long}.",
78
+ "audit_hooks": [],
79
+ "clarify": [
80
+ "Comments posted or comments received? The API counts posted comments only; agencies may post a sample or one copy of a mass-mail campaign.",
81
+ "Which document or docket? Comments filed on a docket (filter[docketId]) include every document in it; on one document use filter[commentOnId] with its objectId."
82
+ ],
83
+ "formats": [
84
+ "json"
85
+ ]
86
+ }
@@ -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
  }