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,288 +1,288 @@
1
- {
2
- "base_url": "https://api.regulations.gov/v4",
3
- "endpoints": {
4
- "documents": {
5
- "path": "/documents",
6
- "method": "GET",
7
- "description": "Search rulemaking documents (proposed rules, rules, notices, supporting material) across agencies. At most 10,000 per query.",
8
- "params": {
9
- "filter[searchTerm]": {
10
- "desc": "full-text words"
11
- },
12
- "filter[agencyId]": {
13
- "desc": "agency acronym, e.g. EPA, FDA, OSHA, CMS, FAA (comma-separated for several)"
14
- },
15
- "filter[docketId]": {
16
- "desc": "docket id, e.g. EPA-HQ-OAR-2023-0072"
17
- },
18
- "filter[documentType]": {
19
- "desc": "Proposed Rule | Rule | Notice | Supporting & Related Material | Other"
20
- },
21
- "filter[frDocNum]": {
22
- "desc": "Federal Register document number, e.g. 2023-10141"
23
- },
24
- "filter[withinCommentPeriod]": {
25
- "desc": "true = open for comment now"
26
- },
27
- "filter[commentEndDate][ge]": {
28
- "desc": "comment period ends on or after YYYY-MM-DD"
29
- },
30
- "filter[commentEndDate][le]": {
31
- "desc": "comment period ends on or before YYYY-MM-DD"
32
- },
33
- "filter[postedDate][ge]": {
34
- "desc": "posted on or after YYYY-MM-DD"
35
- },
36
- "filter[postedDate][le]": {
37
- "desc": "posted on or before YYYY-MM-DD"
38
- },
39
- "filter[lastModifiedDate][ge]": {
40
- "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
41
- },
42
- "filter[lastModifiedDate][le]": {
43
- "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
44
- },
45
- "sort": {
46
- "desc": "postedDate | -postedDate (default) | lastModifiedDate | commentEndDate | title | documentId"
47
- }
48
- },
49
- "defaults": {
50
- "sort": "-postedDate"
51
- },
52
- "records": "data",
53
- "total": "meta.totalElements",
54
- "paging": {
55
- "type": "page",
56
- "page_param": "page[number]",
57
- "size_param": "page[size]",
58
- "min_size": 5,
59
- "size": 250,
60
- "start": 1
61
- },
62
- "max_rows": 10000
63
- },
64
- "document": {
65
- "path": "/documents/{documentId}",
66
- "method": "GET",
67
- "description": "One document's full metadata (CFR part, FR citation, page count, comment dates, file links).",
68
- "params": {
69
- "documentId": {
70
- "in": "path",
71
- "required": true,
72
- "desc": "e.g. EPA-HQ-OAR-2023-0072-0001"
73
- },
74
- "include": {
75
- "desc": "attachments = add attachment metadata"
76
- }
77
- },
78
- "records": "data",
79
- "paging": {
80
- "type": "none"
81
- }
82
- },
83
- "comments": {
84
- "path": "/comments",
85
- "method": "GET",
86
- "description": "Search posted public comments (id, title, posted date). At most 10,000 per query; the text needs the 'comment' endpoint per comment.",
87
- "params": {
88
- "filter[searchTerm]": {
89
- "desc": "full-text words"
90
- },
91
- "filter[agencyId]": {
92
- "desc": "agency acronym"
93
- },
94
- "filter[docketId]": {
95
- "desc": "docket id: every comment in the docket"
96
- },
97
- "filter[commentOnId]": {
98
- "desc": "objectId of a document (from 'documents' or 'document', e.g. 0900006485a3507a): comments on that document"
99
- },
100
- "filter[postedDate][ge]": {
101
- "desc": "posted on or after YYYY-MM-DD"
102
- },
103
- "filter[postedDate][le]": {
104
- "desc": "posted on or before YYYY-MM-DD"
105
- },
106
- "filter[lastModifiedDate][ge]": {
107
- "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
108
- },
109
- "filter[lastModifiedDate][le]": {
110
- "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
111
- },
112
- "sort": {
113
- "desc": "postedDate | -postedDate | lastModifiedDate (use with filter[lastModifiedDate][ge] to page past 10,000) | documentId"
114
- }
115
- },
116
- "defaults": {
117
- "sort": "-postedDate"
118
- },
119
- "records": "data",
120
- "total": "meta.totalElements",
121
- "paging": {
122
- "type": "page",
123
- "page_param": "page[number]",
124
- "size_param": "page[size]",
125
- "min_size": 5,
126
- "size": 250,
127
- "start": 1
128
- },
129
- "max_rows": 10000
130
- },
131
- "comment_count": {
132
- "path": "/comments",
133
- "method": "GET",
134
- "description": "Number of posted comments matching the filters (one row: totalElements), without downloading them.",
135
- "params": {
136
- "filter[docketId]": {
137
- "desc": "docket id"
138
- },
139
- "filter[commentOnId]": {
140
- "desc": "document objectId"
141
- },
142
- "filter[agencyId]": {
143
- "desc": "agency acronym"
144
- },
145
- "filter[searchTerm]": {
146
- "desc": "words"
147
- },
148
- "filter[postedDate][ge]": {
149
- "desc": "posted on or after YYYY-MM-DD"
150
- },
151
- "filter[postedDate][le]": {
152
- "desc": "posted on or before YYYY-MM-DD"
153
- },
154
- "filter[lastModifiedDate][ge]": {
155
- "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
156
- },
157
- "filter[lastModifiedDate][le]": {
158
- "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
159
- }
160
- },
161
- "defaults": {
162
- "page[size]": "5"
163
- },
164
- "records": "meta",
165
- "paging": {
166
- "type": "none"
167
- }
168
- },
169
- "comment": {
170
- "path": "/comments/{commentId}",
171
- "method": "GET",
172
- "description": "One comment: text (attributes.comment), submitter fields as posted, organization, attachments.",
173
- "params": {
174
- "commentId": {
175
- "in": "path",
176
- "required": true,
177
- "desc": "e.g. EPA-HQ-OAR-2023-0072-8036"
178
- },
179
- "include": {
180
- "desc": "attachments"
181
- }
182
- },
183
- "records": "data",
184
- "paging": {
185
- "type": "none"
186
- }
187
- },
188
- "dockets": {
189
- "path": "/dockets",
190
- "method": "GET",
191
- "description": "Search dockets (rulemaking and nonrulemaking folders). At most 10,000 per query.",
192
- "params": {
193
- "filter[searchTerm]": {
194
- "desc": "words"
195
- },
196
- "filter[agencyId]": {
197
- "desc": "agency acronym"
198
- },
199
- "filter[docketType]": {
200
- "desc": "Rulemaking | Nonrulemaking"
201
- },
202
- "filter[lastModifiedDate][ge]": {
203
- "desc": "'YYYY-MM-DD HH:MM:SS'"
204
- },
205
- "filter[lastModifiedDate][le]": {
206
- "desc": "'YYYY-MM-DD HH:MM:SS'"
207
- },
208
- "sort": {
209
- "desc": "title | docketId | lastModifiedDate | -lastModifiedDate"
210
- }
211
- },
212
- "defaults": {
213
- "sort": "-lastModifiedDate"
214
- },
215
- "records": "data",
216
- "total": "meta.totalElements",
217
- "paging": {
218
- "type": "page",
219
- "page_param": "page[number]",
220
- "size_param": "page[size]",
221
- "min_size": 5,
222
- "size": 250,
223
- "start": 1
224
- },
225
- "max_rows": 10000
226
- },
227
- "docket": {
228
- "path": "/dockets/{docketId}",
229
- "method": "GET",
230
- "description": "One docket: title, RIN, abstract, keywords, program, type.",
231
- "params": {
232
- "docketId": {
233
- "in": "path",
234
- "required": true,
235
- "desc": "e.g. EPA-HQ-OAR-2023-0072"
236
- }
237
- },
238
- "records": "data",
239
- "paging": {
240
- "type": "none"
241
- }
242
- }
243
- },
244
- "catalog": {
245
- "proposed_rules": {
246
- "id": "Proposed Rule",
247
- "name": "Proposed rules",
248
- "description": "documents with filter[documentType] = Proposed Rule",
249
- "endpoint": "documents"
250
- },
251
- "final_rules": {
252
- "id": "Rule",
253
- "name": "Final rules",
254
- "description": "documents with filter[documentType] = Rule",
255
- "endpoint": "documents"
256
- },
257
- "notices": {
258
- "id": "Notice",
259
- "name": "Notices",
260
- "description": "documents with filter[documentType] = Notice",
261
- "endpoint": "documents"
262
- },
263
- "open_for_comment": {
264
- "id": "true",
265
- "name": "Open comment periods",
266
- "description": "documents with filter[withinCommentPeriod] = true",
267
- "endpoint": "documents"
268
- },
269
- "public_comments": {
270
- "id": "comments",
271
- "name": "Public comments",
272
- "description": "comments on a docket (filter[docketId]) or a document (filter[commentOnId] = objectId)",
273
- "endpoint": "comments"
274
- },
275
- "comment_totals": {
276
- "id": "comment_count",
277
- "name": "Comment counts",
278
- "description": "how many comments a docket or document received (posted)",
279
- "endpoint": "comment_count"
280
- },
281
- "agency_ids": {
282
- "id": "EPA; FDA; CMS; OSHA; FAA; NHTSA; DOT; USDA; FWS; NOAA; CFPB; DOE; ED; HHS; IRS",
283
- "name": "Agency acronyms",
284
- "description": "values for filter[agencyId]; some independent agencies (SEC, FCC, FERC) run their own comment systems",
285
- "endpoint": "documents"
286
- }
287
- }
1
+ {
2
+ "base_url": "https://api.regulations.gov/v4",
3
+ "endpoints": {
4
+ "documents": {
5
+ "path": "/documents",
6
+ "method": "GET",
7
+ "description": "Search rulemaking documents (proposed rules, rules, notices, supporting material) across agencies. At most 10,000 per query.",
8
+ "params": {
9
+ "filter[searchTerm]": {
10
+ "desc": "full-text words"
11
+ },
12
+ "filter[agencyId]": {
13
+ "desc": "agency acronym, e.g. EPA, FDA, OSHA, CMS, FAA (comma-separated for several)"
14
+ },
15
+ "filter[docketId]": {
16
+ "desc": "docket id, e.g. EPA-HQ-OAR-2023-0072"
17
+ },
18
+ "filter[documentType]": {
19
+ "desc": "Proposed Rule | Rule | Notice | Supporting & Related Material | Other"
20
+ },
21
+ "filter[frDocNum]": {
22
+ "desc": "Federal Register document number, e.g. 2023-10141"
23
+ },
24
+ "filter[withinCommentPeriod]": {
25
+ "desc": "true = open for comment now"
26
+ },
27
+ "filter[commentEndDate][ge]": {
28
+ "desc": "comment period ends on or after YYYY-MM-DD"
29
+ },
30
+ "filter[commentEndDate][le]": {
31
+ "desc": "comment period ends on or before YYYY-MM-DD"
32
+ },
33
+ "filter[postedDate][ge]": {
34
+ "desc": "posted on or after YYYY-MM-DD"
35
+ },
36
+ "filter[postedDate][le]": {
37
+ "desc": "posted on or before YYYY-MM-DD"
38
+ },
39
+ "filter[lastModifiedDate][ge]": {
40
+ "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
41
+ },
42
+ "filter[lastModifiedDate][le]": {
43
+ "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
44
+ },
45
+ "sort": {
46
+ "desc": "postedDate | -postedDate (default) | lastModifiedDate | commentEndDate | title | documentId"
47
+ }
48
+ },
49
+ "defaults": {
50
+ "sort": "-postedDate"
51
+ },
52
+ "records": "data",
53
+ "total": "meta.totalElements",
54
+ "paging": {
55
+ "type": "page",
56
+ "page_param": "page[number]",
57
+ "size_param": "page[size]",
58
+ "min_size": 5,
59
+ "size": 250,
60
+ "start": 1
61
+ },
62
+ "max_rows": 10000
63
+ },
64
+ "document": {
65
+ "path": "/documents/{documentId}",
66
+ "method": "GET",
67
+ "description": "One document's full metadata (CFR part, FR citation, page count, comment dates, file links).",
68
+ "params": {
69
+ "documentId": {
70
+ "in": "path",
71
+ "required": true,
72
+ "desc": "e.g. EPA-HQ-OAR-2023-0072-0001"
73
+ },
74
+ "include": {
75
+ "desc": "attachments = add attachment metadata"
76
+ }
77
+ },
78
+ "records": "data",
79
+ "paging": {
80
+ "type": "none"
81
+ }
82
+ },
83
+ "comments": {
84
+ "path": "/comments",
85
+ "method": "GET",
86
+ "description": "Search posted public comments (id, title, posted date). At most 10,000 per query; the text needs the 'comment' endpoint per comment.",
87
+ "params": {
88
+ "filter[searchTerm]": {
89
+ "desc": "full-text words"
90
+ },
91
+ "filter[agencyId]": {
92
+ "desc": "agency acronym"
93
+ },
94
+ "filter[docketId]": {
95
+ "desc": "docket id: every comment in the docket"
96
+ },
97
+ "filter[commentOnId]": {
98
+ "desc": "objectId of a document (from 'documents' or 'document', e.g. 0900006485a3507a): comments on that document"
99
+ },
100
+ "filter[postedDate][ge]": {
101
+ "desc": "posted on or after YYYY-MM-DD"
102
+ },
103
+ "filter[postedDate][le]": {
104
+ "desc": "posted on or before YYYY-MM-DD"
105
+ },
106
+ "filter[lastModifiedDate][ge]": {
107
+ "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
108
+ },
109
+ "filter[lastModifiedDate][le]": {
110
+ "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
111
+ },
112
+ "sort": {
113
+ "desc": "postedDate | -postedDate | lastModifiedDate (use with filter[lastModifiedDate][ge] to page past 10,000) | documentId"
114
+ }
115
+ },
116
+ "defaults": {
117
+ "sort": "-postedDate"
118
+ },
119
+ "records": "data",
120
+ "total": "meta.totalElements",
121
+ "paging": {
122
+ "type": "page",
123
+ "page_param": "page[number]",
124
+ "size_param": "page[size]",
125
+ "min_size": 5,
126
+ "size": 250,
127
+ "start": 1
128
+ },
129
+ "max_rows": 10000
130
+ },
131
+ "comment_count": {
132
+ "path": "/comments",
133
+ "method": "GET",
134
+ "description": "Number of posted comments matching the filters (one row: totalElements), without downloading them.",
135
+ "params": {
136
+ "filter[docketId]": {
137
+ "desc": "docket id"
138
+ },
139
+ "filter[commentOnId]": {
140
+ "desc": "document objectId"
141
+ },
142
+ "filter[agencyId]": {
143
+ "desc": "agency acronym"
144
+ },
145
+ "filter[searchTerm]": {
146
+ "desc": "words"
147
+ },
148
+ "filter[postedDate][ge]": {
149
+ "desc": "posted on or after YYYY-MM-DD"
150
+ },
151
+ "filter[postedDate][le]": {
152
+ "desc": "posted on or before YYYY-MM-DD"
153
+ },
154
+ "filter[lastModifiedDate][ge]": {
155
+ "desc": "modified on or after 'YYYY-MM-DD HH:MM:SS' (Eastern time); use to page past 10,000"
156
+ },
157
+ "filter[lastModifiedDate][le]": {
158
+ "desc": "modified on or before 'YYYY-MM-DD HH:MM:SS'"
159
+ }
160
+ },
161
+ "defaults": {
162
+ "page[size]": "5"
163
+ },
164
+ "records": "meta",
165
+ "paging": {
166
+ "type": "none"
167
+ }
168
+ },
169
+ "comment": {
170
+ "path": "/comments/{commentId}",
171
+ "method": "GET",
172
+ "description": "One comment: text (attributes.comment), submitter fields as posted, organization, attachments.",
173
+ "params": {
174
+ "commentId": {
175
+ "in": "path",
176
+ "required": true,
177
+ "desc": "e.g. EPA-HQ-OAR-2023-0072-8036"
178
+ },
179
+ "include": {
180
+ "desc": "attachments"
181
+ }
182
+ },
183
+ "records": "data",
184
+ "paging": {
185
+ "type": "none"
186
+ }
187
+ },
188
+ "dockets": {
189
+ "path": "/dockets",
190
+ "method": "GET",
191
+ "description": "Search dockets (rulemaking and nonrulemaking folders). At most 10,000 per query.",
192
+ "params": {
193
+ "filter[searchTerm]": {
194
+ "desc": "words"
195
+ },
196
+ "filter[agencyId]": {
197
+ "desc": "agency acronym"
198
+ },
199
+ "filter[docketType]": {
200
+ "desc": "Rulemaking | Nonrulemaking"
201
+ },
202
+ "filter[lastModifiedDate][ge]": {
203
+ "desc": "'YYYY-MM-DD HH:MM:SS'"
204
+ },
205
+ "filter[lastModifiedDate][le]": {
206
+ "desc": "'YYYY-MM-DD HH:MM:SS'"
207
+ },
208
+ "sort": {
209
+ "desc": "title | docketId | lastModifiedDate | -lastModifiedDate"
210
+ }
211
+ },
212
+ "defaults": {
213
+ "sort": "-lastModifiedDate"
214
+ },
215
+ "records": "data",
216
+ "total": "meta.totalElements",
217
+ "paging": {
218
+ "type": "page",
219
+ "page_param": "page[number]",
220
+ "size_param": "page[size]",
221
+ "min_size": 5,
222
+ "size": 250,
223
+ "start": 1
224
+ },
225
+ "max_rows": 10000
226
+ },
227
+ "docket": {
228
+ "path": "/dockets/{docketId}",
229
+ "method": "GET",
230
+ "description": "One docket: title, RIN, abstract, keywords, program, type.",
231
+ "params": {
232
+ "docketId": {
233
+ "in": "path",
234
+ "required": true,
235
+ "desc": "e.g. EPA-HQ-OAR-2023-0072"
236
+ }
237
+ },
238
+ "records": "data",
239
+ "paging": {
240
+ "type": "none"
241
+ }
242
+ }
243
+ },
244
+ "catalog": {
245
+ "proposed_rules": {
246
+ "id": "Proposed Rule",
247
+ "name": "Proposed rules",
248
+ "description": "documents with filter[documentType] = Proposed Rule",
249
+ "endpoint": "documents"
250
+ },
251
+ "final_rules": {
252
+ "id": "Rule",
253
+ "name": "Final rules",
254
+ "description": "documents with filter[documentType] = Rule",
255
+ "endpoint": "documents"
256
+ },
257
+ "notices": {
258
+ "id": "Notice",
259
+ "name": "Notices",
260
+ "description": "documents with filter[documentType] = Notice",
261
+ "endpoint": "documents"
262
+ },
263
+ "open_for_comment": {
264
+ "id": "true",
265
+ "name": "Open comment periods",
266
+ "description": "documents with filter[withinCommentPeriod] = true",
267
+ "endpoint": "documents"
268
+ },
269
+ "public_comments": {
270
+ "id": "comments",
271
+ "name": "Public comments",
272
+ "description": "comments on a docket (filter[docketId]) or a document (filter[commentOnId] = objectId)",
273
+ "endpoint": "comments"
274
+ },
275
+ "comment_totals": {
276
+ "id": "comment_count",
277
+ "name": "Comment counts",
278
+ "description": "how many comments a docket or document received (posted)",
279
+ "endpoint": "comment_count"
280
+ },
281
+ "agency_ids": {
282
+ "id": "EPA; FDA; CMS; OSHA; FAA; NHTSA; DOT; USDA; FWS; NOAA; CFPB; DOE; ED; HHS; IRS",
283
+ "name": "Agency acronyms",
284
+ "description": "values for filter[agencyId]; some independent agencies (SEC, FCC, FERC) run their own comment systems",
285
+ "endpoint": "documents"
286
+ }
287
+ }
288
288
  }