data-analyst-mcp 0.0.0-stage → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (640) hide show
  1. package/README.md +262 -3
  2. package/dist/adapters/_acf_tidy.d.ts +18 -0
  3. package/dist/adapters/_acf_tidy.js +432 -0
  4. package/dist/adapters/_acf_tidy.js.map +1 -0
  5. package/dist/adapters/_actuaries_read.d.ts +38 -0
  6. package/dist/adapters/_actuaries_read.js +728 -0
  7. package/dist/adapters/_actuaries_read.js.map +1 -0
  8. package/dist/adapters/_census_micro.d.ts +70 -0
  9. package/dist/adapters/_census_micro.js +622 -0
  10. package/dist/adapters/_census_micro.js.map +1 -0
  11. package/dist/adapters/_census_util.d.ts +40 -0
  12. package/dist/adapters/_census_util.js +275 -0
  13. package/dist/adapters/_census_util.js.map +1 -0
  14. package/dist/adapters/_dol_states.d.ts +6 -0
  15. package/dist/adapters/_dol_states.js +58 -0
  16. package/dist/adapters/_dol_states.js.map +1 -0
  17. package/dist/adapters/_govinfo_entities.d.ts +4 -0
  18. package/dist/adapters/_govinfo_entities.js +6 -0
  19. package/dist/adapters/_govinfo_entities.js.map +1 -0
  20. package/dist/adapters/_govinfo_json.d.ts +13 -0
  21. package/dist/adapters/_govinfo_json.js +107 -0
  22. package/dist/adapters/_govinfo_json.js.map +1 -0
  23. package/dist/adapters/_govinfo_py.d.ts +22 -0
  24. package/dist/adapters/_govinfo_py.js +272 -0
  25. package/dist/adapters/_govinfo_py.js.map +1 -0
  26. package/dist/adapters/_govinfo_xml.d.ts +22 -0
  27. package/dist/adapters/_govinfo_xml.js +233 -0
  28. package/dist/adapters/_govinfo_xml.js.map +1 -0
  29. package/dist/adapters/_hud_excel.d.ts +2 -0
  30. package/dist/adapters/_hud_excel.js +166 -0
  31. package/dist/adapters/_hud_excel.js.map +1 -0
  32. package/dist/adapters/_omb_grid.d.ts +17 -0
  33. package/dist/adapters/_omb_grid.js +132 -0
  34. package/dist/adapters/_omb_grid.js.map +1 -0
  35. package/dist/adapters/_omb_util.d.ts +40 -0
  36. package/dist/adapters/_omb_util.js +192 -0
  37. package/dist/adapters/_omb_util.js.map +1 -0
  38. package/dist/adapters/_usaspending_state.d.ts +6 -0
  39. package/dist/adapters/_usaspending_state.js +54 -0
  40. package/dist/adapters/_usaspending_state.js.map +1 -0
  41. package/dist/adapters/_usda-fna_book.d.ts +59 -0
  42. package/dist/adapters/_usda-fna_book.js +869 -0
  43. package/dist/adapters/_usda-fna_book.js.map +1 -0
  44. package/dist/adapters/_usda-fna_pdf.d.ts +20 -0
  45. package/dist/adapters/_usda-fna_pdf.js +361 -0
  46. package/dist/adapters/_usda-fna_pdf.js.map +1 -0
  47. package/dist/adapters/_usda-outlook_read.d.ts +70 -0
  48. package/dist/adapters/_usda-outlook_read.js +362 -0
  49. package/dist/adapters/_usda-outlook_read.js.map +1 -0
  50. package/dist/adapters/acf.d.ts +3 -0
  51. package/dist/adapters/acf.js +187 -0
  52. package/dist/adapters/acf.js.map +1 -0
  53. package/dist/adapters/actuaries.d.ts +3 -0
  54. package/dist/adapters/actuaries.js +293 -0
  55. package/dist/adapters/actuaries.js.map +1 -0
  56. package/dist/adapters/bts.d.ts +3 -0
  57. package/dist/adapters/bts.js +26 -0
  58. package/dist/adapters/bts.js.map +1 -0
  59. package/dist/adapters/census-geocoder.d.ts +10 -0
  60. package/dist/adapters/census-geocoder.js +47 -0
  61. package/dist/adapters/census-geocoder.js.map +1 -0
  62. package/dist/adapters/census.d.ts +17 -0
  63. package/dist/adapters/census.js +983 -0
  64. package/dist/adapters/census.js.map +1 -0
  65. package/dist/adapters/cfpb.d.ts +7 -0
  66. package/dist/adapters/cfpb.js +348 -0
  67. package/dist/adapters/cfpb.js.map +1 -0
  68. package/dist/adapters/clinical-trials.d.ts +3 -0
  69. package/dist/adapters/clinical-trials.js +135 -0
  70. package/dist/adapters/clinical-trials.js.map +1 -0
  71. package/dist/adapters/cms.d.ts +3 -0
  72. package/dist/adapters/cms.js +292 -0
  73. package/dist/adapters/cms.js.map +1 -0
  74. package/dist/adapters/college-scorecard.d.ts +3 -0
  75. package/dist/adapters/college-scorecard.js +122 -0
  76. package/dist/adapters/college-scorecard.js.map +1 -0
  77. package/dist/adapters/congress.d.ts +33 -0
  78. package/dist/adapters/congress.js +589 -0
  79. package/dist/adapters/congress.js.map +1 -0
  80. package/dist/adapters/dhs-ohss.d.ts +13 -0
  81. package/dist/adapters/dhs-ohss.js +598 -0
  82. package/dist/adapters/dhs-ohss.js.map +1 -0
  83. package/dist/adapters/doj-news.d.ts +7 -0
  84. package/dist/adapters/doj-news.js +286 -0
  85. package/dist/adapters/doj-news.js.map +1 -0
  86. package/dist/adapters/dol.d.ts +4 -0
  87. package/dist/adapters/dol.js +634 -0
  88. package/dist/adapters/dol.js.map +1 -0
  89. package/dist/adapters/eia.d.ts +15 -0
  90. package/dist/adapters/eia.js +456 -0
  91. package/dist/adapters/eia.js.map +1 -0
  92. package/dist/adapters/epa-aqs.d.ts +3 -0
  93. package/dist/adapters/epa-aqs.js +357 -0
  94. package/dist/adapters/epa-aqs.js.map +1 -0
  95. package/dist/adapters/epa.d.ts +3 -0
  96. package/dist/adapters/epa.js +298 -0
  97. package/dist/adapters/epa.js.map +1 -0
  98. package/dist/adapters/fbi.d.ts +3 -0
  99. package/dist/adapters/fbi.js +192 -0
  100. package/dist/adapters/fbi.js.map +1 -0
  101. package/dist/adapters/fda.d.ts +5 -0
  102. package/dist/adapters/fda.js +184 -0
  103. package/dist/adapters/fda.js.map +1 -0
  104. package/dist/adapters/fdic.d.ts +4 -0
  105. package/dist/adapters/fdic.js +95 -0
  106. package/dist/adapters/fdic.js.map +1 -0
  107. package/dist/adapters/fec.d.ts +3 -0
  108. package/dist/adapters/fec.js +142 -0
  109. package/dist/adapters/fec.js.map +1 -0
  110. package/dist/adapters/fed-board.d.ts +12 -0
  111. package/dist/adapters/fed-board.js +581 -0
  112. package/dist/adapters/fed-board.js.map +1 -0
  113. package/dist/adapters/federal-register.d.ts +11 -0
  114. package/dist/adapters/federal-register.js +43 -0
  115. package/dist/adapters/federal-register.js.map +1 -0
  116. package/dist/adapters/fhfa.d.ts +3 -0
  117. package/dist/adapters/fhfa.js +253 -0
  118. package/dist/adapters/fhfa.js.map +1 -0
  119. package/dist/adapters/fsa.d.ts +9 -0
  120. package/dist/adapters/fsa.js +335 -0
  121. package/dist/adapters/fsa.js.map +1 -0
  122. package/dist/adapters/govinfo.d.ts +30 -0
  123. package/dist/adapters/govinfo.js +636 -0
  124. package/dist/adapters/govinfo.js.map +1 -0
  125. package/dist/adapters/gsa-calc.d.ts +10 -0
  126. package/dist/adapters/gsa-calc.js +318 -0
  127. package/dist/adapters/gsa-calc.js.map +1 -0
  128. package/dist/adapters/hud.d.ts +3 -0
  129. package/dist/adapters/hud.js +200 -0
  130. package/dist/adapters/hud.js.map +1 -0
  131. package/dist/adapters/index.d.ts +3 -0
  132. package/dist/adapters/index.js +25 -0
  133. package/dist/adapters/index.js.map +1 -0
  134. package/dist/adapters/irs-soi.d.ts +6 -0
  135. package/dist/adapters/irs-soi.js +576 -0
  136. package/dist/adapters/irs-soi.js.map +1 -0
  137. package/dist/adapters/naep.d.ts +15 -0
  138. package/dist/adapters/naep.js +341 -0
  139. package/dist/adapters/naep.js.map +1 -0
  140. package/dist/adapters/nhtsa.d.ts +10 -0
  141. package/dist/adapters/nhtsa.js +239 -0
  142. package/dist/adapters/nhtsa.js.map +1 -0
  143. package/dist/adapters/nih.d.ts +5 -0
  144. package/dist/adapters/nih.js +196 -0
  145. package/dist/adapters/nih.js.map +1 -0
  146. package/dist/adapters/noaa.d.ts +3 -0
  147. package/dist/adapters/noaa.js +148 -0
  148. package/dist/adapters/noaa.js.map +1 -0
  149. package/dist/adapters/nrel.d.ts +3 -0
  150. package/dist/adapters/nrel.js +186 -0
  151. package/dist/adapters/nrel.js.map +1 -0
  152. package/dist/adapters/nws.d.ts +3 -0
  153. package/dist/adapters/nws.js +119 -0
  154. package/dist/adapters/nws.js.map +1 -0
  155. package/dist/adapters/omb.d.ts +15 -0
  156. package/dist/adapters/omb.js +517 -0
  157. package/dist/adapters/omb.js.map +1 -0
  158. package/dist/adapters/open-payments.d.ts +5 -0
  159. package/dist/adapters/open-payments.js +149 -0
  160. package/dist/adapters/open-payments.js.map +1 -0
  161. package/dist/adapters/pbgc.d.ts +13 -0
  162. package/dist/adapters/pbgc.js +283 -0
  163. package/dist/adapters/pbgc.js.map +1 -0
  164. package/dist/adapters/philfed.d.ts +12 -0
  165. package/dist/adapters/philfed.js +59 -0
  166. package/dist/adapters/philfed.js.map +1 -0
  167. package/dist/adapters/regulations.d.ts +6 -0
  168. package/dist/adapters/regulations.js +58 -0
  169. package/dist/adapters/regulations.js.map +1 -0
  170. package/dist/adapters/sec.d.ts +13 -0
  171. package/dist/adapters/sec.js +504 -0
  172. package/dist/adapters/sec.js.map +1 -0
  173. package/dist/adapters/senate-lobbying.d.ts +3 -0
  174. package/dist/adapters/senate-lobbying.js +181 -0
  175. package/dist/adapters/senate-lobbying.js.map +1 -0
  176. package/dist/adapters/snapqc.d.ts +32 -0
  177. package/dist/adapters/snapqc.js +701 -0
  178. package/dist/adapters/snapqc.js.map +1 -0
  179. package/dist/adapters/treasury-yields.d.ts +3 -0
  180. package/dist/adapters/treasury-yields.js +170 -0
  181. package/dist/adapters/treasury-yields.js.map +1 -0
  182. package/dist/adapters/usaspending.d.ts +3 -0
  183. package/dist/adapters/usaspending.js +340 -0
  184. package/dist/adapters/usaspending.js.map +1 -0
  185. package/dist/adapters/usda-fna.d.ts +7 -0
  186. package/dist/adapters/usda-fna.js +707 -0
  187. package/dist/adapters/usda-fna.js.map +1 -0
  188. package/dist/adapters/usda-fooddata.d.ts +3 -0
  189. package/dist/adapters/usda-fooddata.js +101 -0
  190. package/dist/adapters/usda-fooddata.js.map +1 -0
  191. package/dist/adapters/usda-nass.d.ts +3 -0
  192. package/dist/adapters/usda-nass.js +108 -0
  193. package/dist/adapters/usda-nass.js.map +1 -0
  194. package/dist/adapters/usda-outlook.d.ts +12 -0
  195. package/dist/adapters/usda-outlook.js +696 -0
  196. package/dist/adapters/usda-outlook.js.map +1 -0
  197. package/dist/adapters/usgs.d.ts +9 -0
  198. package/dist/adapters/usgs.js +265 -0
  199. package/dist/adapters/usgs.js.map +1 -0
  200. package/dist/adapters/usitc.d.ts +18 -0
  201. package/dist/adapters/usitc.js +170 -0
  202. package/dist/adapters/usitc.js.map +1 -0
  203. package/dist/adapters/uspto.d.ts +3 -0
  204. package/dist/adapters/uspto.js +47 -0
  205. package/dist/adapters/uspto.js.map +1 -0
  206. package/dist/adapters/world-bank.d.ts +3 -0
  207. package/dist/adapters/world-bank.js +163 -0
  208. package/dist/adapters/world-bank.js.map +1 -0
  209. package/dist/analysis/cite.d.ts +31 -0
  210. package/dist/analysis/cite.js +229 -0
  211. package/dist/analysis/cite.js.map +1 -0
  212. package/dist/analysis/combine.d.ts +27 -0
  213. package/dist/analysis/combine.js +198 -0
  214. package/dist/analysis/combine.js.map +1 -0
  215. package/dist/analysis/compute.d.ts +62 -0
  216. package/dist/analysis/compute.js +583 -0
  217. package/dist/analysis/compute.js.map +1 -0
  218. package/dist/analysis/expr.d.ts +69 -0
  219. package/dist/analysis/expr.js +780 -0
  220. package/dist/analysis/expr.js.map +1 -0
  221. package/dist/analysis/factfmt.d.ts +16 -0
  222. package/dist/analysis/factfmt.js +187 -0
  223. package/dist/analysis/factfmt.js.map +1 -0
  224. package/dist/analysis/facts.d.ts +63 -0
  225. package/dist/analysis/facts.js +355 -0
  226. package/dist/analysis/facts.js.map +1 -0
  227. package/dist/analysis/handoff.d.ts +58 -0
  228. package/dist/analysis/handoff.js +208 -0
  229. package/dist/analysis/handoff.js.map +1 -0
  230. package/dist/analysis/pyfmt.d.ts +16 -0
  231. package/dist/analysis/pyfmt.js +156 -0
  232. package/dist/analysis/pyfmt.js.map +1 -0
  233. package/dist/analysis/rerun.d.ts +13 -0
  234. package/dist/analysis/rerun.js +125 -0
  235. package/dist/analysis/rerun.js.map +1 -0
  236. package/dist/analysis/table.d.ts +18 -0
  237. package/dist/analysis/table.js +109 -0
  238. package/dist/analysis/table.js.map +1 -0
  239. package/dist/analysis/tools.d.ts +67 -0
  240. package/dist/analysis/tools.js +217 -0
  241. package/dist/analysis/tools.js.map +1 -0
  242. package/dist/analysis/write_table.d.ts +13 -0
  243. package/dist/analysis/write_table.js +59 -0
  244. package/dist/analysis/write_table.js.map +1 -0
  245. package/dist/bin/cli.d.ts +10 -0
  246. package/dist/bin/cli.js +177 -0
  247. package/dist/bin/cli.js.map +1 -0
  248. package/dist/core/cache.d.ts +14 -0
  249. package/dist/core/cache.js +90 -0
  250. package/dist/core/cache.js.map +1 -0
  251. package/dist/core/context.d.ts +12 -0
  252. package/dist/core/context.js +15 -0
  253. package/dist/core/context.js.map +1 -0
  254. package/dist/core/env.d.ts +14 -0
  255. package/dist/core/env.js +52 -0
  256. package/dist/core/env.js.map +1 -0
  257. package/dist/core/generic-rest.d.ts +61 -0
  258. package/dist/core/generic-rest.js +639 -0
  259. package/dist/core/generic-rest.js.map +1 -0
  260. package/dist/core/http.d.ts +120 -0
  261. package/dist/core/http.js +514 -0
  262. package/dist/core/http.js.map +1 -0
  263. package/dist/core/keys.d.ts +43 -0
  264. package/dist/core/keys.js +174 -0
  265. package/dist/core/keys.js.map +1 -0
  266. package/dist/core/manual.d.ts +41 -0
  267. package/dist/core/manual.js +218 -0
  268. package/dist/core/manual.js.map +1 -0
  269. package/dist/core/package.d.ts +58 -0
  270. package/dist/core/package.js +228 -0
  271. package/dist/core/package.js.map +1 -0
  272. package/dist/core/packs.d.ts +139 -0
  273. package/dist/core/packs.js +173 -0
  274. package/dist/core/packs.js.map +1 -0
  275. package/dist/core/policy.d.ts +69 -0
  276. package/dist/core/policy.js +189 -0
  277. package/dist/core/policy.js.map +1 -0
  278. package/dist/core/py.d.ts +40 -0
  279. package/dist/core/py.js +171 -0
  280. package/dist/core/py.js.map +1 -0
  281. package/dist/core/routing.d.ts +10 -0
  282. package/dist/core/routing.js +39 -0
  283. package/dist/core/routing.js.map +1 -0
  284. package/dist/core/tabular.d.ts +21 -0
  285. package/dist/core/tabular.js +229 -0
  286. package/dist/core/tabular.js.map +1 -0
  287. package/dist/deep/_bea_api.d.ts +102 -0
  288. package/dist/deep/_bea_api.js +457 -0
  289. package/dist/deep/_bea_api.js.map +1 -0
  290. package/dist/deep/_bea_fetch.d.ts +151 -0
  291. package/dist/deep/_bea_fetch.js +1274 -0
  292. package/dist/deep/_bea_fetch.js.map +1 -0
  293. package/dist/deep/_bea_util.d.ts +14 -0
  294. package/dist/deep/_bea_util.js +156 -0
  295. package/dist/deep/_bea_util.js.map +1 -0
  296. package/dist/deep/_bls_api.d.ts +84 -0
  297. package/dist/deep/_bls_api.js +231 -0
  298. package/dist/deep/_bls_api.js.map +1 -0
  299. package/dist/deep/_bls_ids.d.ts +43 -0
  300. package/dist/deep/_bls_ids.js +188 -0
  301. package/dist/deep/_bls_ids.js.map +1 -0
  302. package/dist/deep/_bls_lib.d.ts +61 -0
  303. package/dist/deep/_bls_lib.js +442 -0
  304. package/dist/deep/_bls_lib.js.map +1 -0
  305. package/dist/deep/_fred_api.d.ts +148 -0
  306. package/dist/deep/_fred_api.js +545 -0
  307. package/dist/deep/_fred_api.js.map +1 -0
  308. package/dist/deep/_fred_pack.d.ts +162 -0
  309. package/dist/deep/_fred_pack.js +1027 -0
  310. package/dist/deep/_fred_pack.js.map +1 -0
  311. package/dist/deep/_fred_py.d.ts +40 -0
  312. package/dist/deep/_fred_py.js +199 -0
  313. package/dist/deep/_fred_py.js.map +1 -0
  314. package/dist/deep/_ipums_bundle.d.ts +29 -0
  315. package/dist/deep/_ipums_bundle.js +194 -0
  316. package/dist/deep/_ipums_bundle.js.map +1 -0
  317. package/dist/deep/_ipums_ddi.d.ts +23 -0
  318. package/dist/deep/_ipums_ddi.js +162 -0
  319. package/dist/deep/_ipums_ddi.js.map +1 -0
  320. package/dist/deep/_opm_io.d.ts +26 -0
  321. package/dist/deep/_opm_io.js +383 -0
  322. package/dist/deep/_opm_io.js.map +1 -0
  323. package/dist/deep/_opm_parquet.d.ts +31 -0
  324. package/dist/deep/_opm_parquet.js +744 -0
  325. package/dist/deep/_opm_parquet.js.map +1 -0
  326. package/dist/deep/_opm_py.d.ts +6 -0
  327. package/dist/deep/_opm_py.js +74 -0
  328. package/dist/deep/_opm_py.js.map +1 -0
  329. package/dist/deep/_treasury_api.d.ts +48 -0
  330. package/dist/deep/_treasury_api.js +221 -0
  331. package/dist/deep/_treasury_api.js.map +1 -0
  332. package/dist/deep/_treasury_context.d.ts +34 -0
  333. package/dist/deep/_treasury_context.js +142 -0
  334. package/dist/deep/_treasury_context.js.map +1 -0
  335. package/dist/deep/_treasury_lib.d.ts +109 -0
  336. package/dist/deep/_treasury_lib.js +686 -0
  337. package/dist/deep/_treasury_lib.js.map +1 -0
  338. package/dist/deep/bea.d.ts +3 -0
  339. package/dist/deep/bea.js +248 -0
  340. package/dist/deep/bea.js.map +1 -0
  341. package/dist/deep/bls.d.ts +3 -0
  342. package/dist/deep/bls.js +220 -0
  343. package/dist/deep/bls.js.map +1 -0
  344. package/dist/deep/fred.d.ts +3 -0
  345. package/dist/deep/fred.js +325 -0
  346. package/dist/deep/fred.js.map +1 -0
  347. package/dist/deep/ipums.d.ts +59 -0
  348. package/dist/deep/ipums.js +744 -0
  349. package/dist/deep/ipums.js.map +1 -0
  350. package/dist/deep/opm.d.ts +56 -0
  351. package/dist/deep/opm.js +1033 -0
  352. package/dist/deep/opm.js.map +1 -0
  353. package/dist/deep/treasury.d.ts +3 -0
  354. package/dist/deep/treasury.js +218 -0
  355. package/dist/deep/treasury.js.map +1 -0
  356. package/dist/envelope.d.ts +47 -0
  357. package/dist/envelope.js +88 -0
  358. package/dist/envelope.js.map +1 -0
  359. package/dist/index.d.ts +277 -0
  360. package/dist/index.js +106 -0
  361. package/dist/index.js.map +1 -0
  362. package/dist/remote/app.d.ts +21 -0
  363. package/dist/remote/app.js +218 -0
  364. package/dist/remote/app.js.map +1 -0
  365. package/dist/remote/oauth.d.ts +14 -0
  366. package/dist/remote/oauth.js +90 -0
  367. package/dist/remote/oauth.js.map +1 -0
  368. package/dist/remote/pages.d.ts +8 -0
  369. package/dist/remote/pages.js +56 -0
  370. package/dist/remote/pages.js.map +1 -0
  371. package/dist/remote/sign.d.ts +4 -0
  372. package/dist/remote/sign.js +40 -0
  373. package/dist/remote/sign.js.map +1 -0
  374. package/dist/remote/store.d.ts +31 -0
  375. package/dist/remote/store.js +129 -0
  376. package/dist/remote/store.js.map +1 -0
  377. package/dist/report/audit_answer.d.ts +94 -0
  378. package/dist/report/audit_answer.js +1349 -0
  379. package/dist/report/audit_answer.js.map +1 -0
  380. package/dist/report/audit_report.d.ts +23 -0
  381. package/dist/report/audit_report.js +637 -0
  382. package/dist/report/audit_report.js.map +1 -0
  383. package/dist/report/build_report.d.ts +27 -0
  384. package/dist/report/build_report.js +1168 -0
  385. package/dist/report/build_report.js.map +1 -0
  386. package/dist/report/method_audit.d.ts +47 -0
  387. package/dist/report/method_audit.js +710 -0
  388. package/dist/report/method_audit.js.map +1 -0
  389. package/dist/report/policyset.d.ts +50 -0
  390. package/dist/report/policyset.js +421 -0
  391. package/dist/report/policyset.js.map +1 -0
  392. package/dist/report/py.d.ts +58 -0
  393. package/dist/report/py.js +311 -0
  394. package/dist/report/py.js.map +1 -0
  395. package/dist/report/scan_secrets.d.ts +21 -0
  396. package/dist/report/scan_secrets.js +234 -0
  397. package/dist/report/scan_secrets.js.map +1 -0
  398. package/dist/report/style_check.d.ts +29 -0
  399. package/dist/report/style_check.js +173 -0
  400. package/dist/report/style_check.js.map +1 -0
  401. package/dist/report/tools.d.ts +87 -0
  402. package/dist/report/tools.js +167 -0
  403. package/dist/report/tools.js.map +1 -0
  404. package/dist/server.d.ts +5 -0
  405. package/dist/server.js +246 -0
  406. package/dist/server.js.map +1 -0
  407. package/dist/session.d.ts +47 -0
  408. package/dist/session.js +107 -0
  409. package/dist/session.js.map +1 -0
  410. package/dist/toolkit.d.ts +21 -0
  411. package/dist/toolkit.js +2 -0
  412. package/dist/toolkit.js.map +1 -0
  413. package/dist/tools.d.ts +299 -0
  414. package/dist/tools.js +491 -0
  415. package/dist/tools.js.map +1 -0
  416. package/guide/WORKFLOW.md +134 -0
  417. package/guide/assets/disclaimer.txt +1 -0
  418. package/guide/assets/download_data.ps1 +162 -0
  419. package/guide/assets/download_data.sh +143 -0
  420. package/guide/assets/report_template.html +597 -0
  421. package/guide/references/report_patterns.md +199 -0
  422. package/guide/references/routing.md +171 -0
  423. package/guide/references/style_guide.md +398 -0
  424. package/package.json +56 -6
  425. package/packs/acf/endpoints.json +114 -0
  426. package/packs/acf/policy.json +104 -0
  427. package/packs/acf/source.md +138 -0
  428. package/packs/actuaries/endpoints.json +82 -0
  429. package/packs/actuaries/policy.json +109 -0
  430. package/packs/actuaries/source.md +137 -0
  431. package/packs/bea/assets/download_bea.ps1 +182 -0
  432. package/packs/bea/assets/download_bea.sh +144 -0
  433. package/packs/bea/docs/bea_api.md +461 -0
  434. package/packs/bea/docs/datasets.md +157 -0
  435. package/packs/bea/docs/report_patterns.md +112 -0
  436. package/packs/bea/policy.json +170 -0
  437. package/packs/bea/source.md +152 -0
  438. package/packs/bls/assets/download_bls.ps1 +152 -0
  439. package/packs/bls/assets/download_bls.sh +167 -0
  440. package/packs/bls/docs/analysis_patterns.md +108 -0
  441. package/packs/bls/docs/bls_api.md +73 -0
  442. package/packs/bls/docs/series_ids.md +149 -0
  443. package/packs/bls/policy.json +238 -0
  444. package/packs/bls/series_ids.json +1375 -0
  445. package/packs/bls/source.md +156 -0
  446. package/packs/bts/endpoints.json +347 -0
  447. package/packs/bts/policy.json +94 -0
  448. package/packs/bts/source.md +97 -0
  449. package/packs/cdc/endpoints.json +197 -0
  450. package/packs/cdc/policy.json +83 -0
  451. package/packs/cdc/source.md +74 -0
  452. package/packs/census/endpoints.json +99 -0
  453. package/packs/census/policy.json +238 -0
  454. package/packs/census/source.md +304 -0
  455. package/packs/census-geocoder/endpoints.json +70 -0
  456. package/packs/census-geocoder/policy.json +80 -0
  457. package/packs/census-geocoder/source.md +53 -0
  458. package/packs/cfpb/endpoints.json +327 -0
  459. package/packs/cfpb/policy.json +119 -0
  460. package/packs/cfpb/source.md +96 -0
  461. package/packs/clinical-trials/endpoints.json +167 -0
  462. package/packs/clinical-trials/policy.json +84 -0
  463. package/packs/clinical-trials/source.md +82 -0
  464. package/packs/cms/endpoints.json +69 -0
  465. package/packs/cms/policy.json +96 -0
  466. package/packs/cms/source.md +112 -0
  467. package/packs/college-scorecard/endpoints.json +253 -0
  468. package/packs/college-scorecard/policy.json +106 -0
  469. package/packs/college-scorecard/source.md +92 -0
  470. package/packs/congress/endpoints.json +1701 -0
  471. package/packs/congress/policy.json +117 -0
  472. package/packs/congress/source.md +190 -0
  473. package/packs/dhs-ohss/endpoints.json +66 -0
  474. package/packs/dhs-ohss/policy.json +107 -0
  475. package/packs/dhs-ohss/source.md +120 -0
  476. package/packs/doj-news/endpoints.json +59 -0
  477. package/packs/doj-news/policy.json +96 -0
  478. package/packs/doj-news/source.md +99 -0
  479. package/packs/dol/endpoints.json +818 -0
  480. package/packs/dol/policy.json +135 -0
  481. package/packs/dol/source.md +181 -0
  482. package/packs/eia/endpoints.json +718 -0
  483. package/packs/eia/policy.json +112 -0
  484. package/packs/eia/source.md +112 -0
  485. package/packs/epa/endpoints.json +292 -0
  486. package/packs/epa/policy.json +99 -0
  487. package/packs/epa/source.md +99 -0
  488. package/packs/epa-aqs/endpoints.json +174 -0
  489. package/packs/epa-aqs/policy.json +96 -0
  490. package/packs/epa-aqs/source.md +97 -0
  491. package/packs/fbi/endpoints.json +1842 -0
  492. package/packs/fbi/policy.json +118 -0
  493. package/packs/fbi/source.md +108 -0
  494. package/packs/fda/endpoints.json +238 -0
  495. package/packs/fda/policy.json +121 -0
  496. package/packs/fda/source.md +117 -0
  497. package/packs/fdic/endpoints.json +417 -0
  498. package/packs/fdic/policy.json +83 -0
  499. package/packs/fdic/source.md +92 -0
  500. package/packs/fec/endpoints.json +708 -0
  501. package/packs/fec/policy.json +93 -0
  502. package/packs/fec/source.md +90 -0
  503. package/packs/fed-board/endpoints.json +89 -0
  504. package/packs/fed-board/policy.json +136 -0
  505. package/packs/fed-board/source.md +118 -0
  506. package/packs/federal-register/endpoints.json +143 -0
  507. package/packs/federal-register/policy.json +86 -0
  508. package/packs/federal-register/source.md +98 -0
  509. package/packs/fema/endpoints.json +646 -0
  510. package/packs/fema/policy.json +103 -0
  511. package/packs/fema/source.md +103 -0
  512. package/packs/fhfa/endpoints.json +105 -0
  513. package/packs/fhfa/policy.json +109 -0
  514. package/packs/fhfa/source.md +108 -0
  515. package/packs/fred/assets/download_fred.ps1 +122 -0
  516. package/packs/fred/assets/download_fred.sh +123 -0
  517. package/packs/fred/docs/analysis_patterns.md +124 -0
  518. package/packs/fred/docs/fred_api.md +94 -0
  519. package/packs/fred/docs/series.md +188 -0
  520. package/packs/fred/policy.json +253 -0
  521. package/packs/fred/source.md +142 -0
  522. package/packs/fsa/endpoints.json +150 -0
  523. package/packs/fsa/policy.json +99 -0
  524. package/packs/fsa/source.md +102 -0
  525. package/packs/govinfo/endpoints.json +520 -0
  526. package/packs/govinfo/policy.json +116 -0
  527. package/packs/govinfo/source.md +241 -0
  528. package/packs/gsa-calc/endpoints.json +93 -0
  529. package/packs/gsa-calc/policy.json +97 -0
  530. package/packs/gsa-calc/source.md +108 -0
  531. package/packs/hud/endpoints.json +147 -0
  532. package/packs/hud/policy.json +84 -0
  533. package/packs/hud/source.md +97 -0
  534. package/packs/ipums/assets/download_ipums.ps1 +215 -0
  535. package/packs/ipums/assets/download_ipums.sh +192 -0
  536. package/packs/ipums/docs/ipums_api.md +67 -0
  537. package/packs/ipums/docs/report_patterns.md +117 -0
  538. package/packs/ipums/docs/variables.md +284 -0
  539. package/packs/ipums/lib/fetch_text.json +112 -0
  540. package/packs/ipums/policy.json +215 -0
  541. package/packs/ipums/source.md +169 -0
  542. package/packs/irs-soi/endpoints.json +114 -0
  543. package/packs/irs-soi/policy.json +107 -0
  544. package/packs/irs-soi/source.md +124 -0
  545. package/packs/medicaid/endpoints.json +412 -0
  546. package/packs/medicaid/policy.json +108 -0
  547. package/packs/medicaid/source.md +136 -0
  548. package/packs/naep/endpoints.json +217 -0
  549. package/packs/naep/policy.json +100 -0
  550. package/packs/naep/source.md +120 -0
  551. package/packs/nhtsa/endpoints.json +132 -0
  552. package/packs/nhtsa/policy.json +93 -0
  553. package/packs/nhtsa/source.md +109 -0
  554. package/packs/nih/endpoints.json +453 -0
  555. package/packs/nih/policy.json +86 -0
  556. package/packs/nih/source.md +108 -0
  557. package/packs/noaa/endpoints.json +432 -0
  558. package/packs/noaa/policy.json +95 -0
  559. package/packs/noaa/source.md +88 -0
  560. package/packs/nrel/endpoints.json +328 -0
  561. package/packs/nrel/policy.json +96 -0
  562. package/packs/nrel/source.md +91 -0
  563. package/packs/nws/endpoints.json +272 -0
  564. package/packs/nws/policy.json +82 -0
  565. package/packs/nws/source.md +81 -0
  566. package/packs/nyfed/endpoints.json +80 -0
  567. package/packs/nyfed/policy.json +92 -0
  568. package/packs/nyfed/source.md +89 -0
  569. package/packs/omb/endpoints.json +460 -0
  570. package/packs/omb/policy.json +106 -0
  571. package/packs/omb/source.md +130 -0
  572. package/packs/open-payments/endpoints.json +298 -0
  573. package/packs/open-payments/policy.json +101 -0
  574. package/packs/open-payments/source.md +99 -0
  575. package/packs/opm/assets/download_opm.ps1 +125 -0
  576. package/packs/opm/assets/download_opm.sh +85 -0
  577. package/packs/opm/docs/fields.md +184 -0
  578. package/packs/opm/docs/opm_api.md +71 -0
  579. package/packs/opm/docs/report_patterns.md +83 -0
  580. package/packs/opm/lib/data_dictionary.csv +73 -0
  581. package/packs/opm/policy.json +142 -0
  582. package/packs/opm/source.md +137 -0
  583. package/packs/pbgc/endpoints.json +483 -0
  584. package/packs/pbgc/policy.json +94 -0
  585. package/packs/pbgc/source.md +95 -0
  586. package/packs/philfed/endpoints.json +85 -0
  587. package/packs/philfed/policy.json +94 -0
  588. package/packs/philfed/source.md +125 -0
  589. package/packs/port.json +287 -0
  590. package/packs/regulations/endpoints.json +288 -0
  591. package/packs/regulations/policy.json +86 -0
  592. package/packs/regulations/source.md +84 -0
  593. package/packs/sec/endpoints.json +237 -0
  594. package/packs/sec/policy.json +86 -0
  595. package/packs/sec/source.md +101 -0
  596. package/packs/senate-lobbying/endpoints.json +554 -0
  597. package/packs/senate-lobbying/policy.json +99 -0
  598. package/packs/senate-lobbying/source.md +100 -0
  599. package/packs/snapqc/endpoints.json +1426 -0
  600. package/packs/snapqc/policy.json +92 -0
  601. package/packs/snapqc/source.md +96 -0
  602. package/packs/treasury/catalog.json +2267 -0
  603. package/packs/treasury/docs/api_guide.md +245 -0
  604. package/packs/treasury/docs/datasets.md +56 -0
  605. package/packs/treasury/docs/report_patterns.md +126 -0
  606. package/packs/treasury/policy.json +159 -0
  607. package/packs/treasury/source.md +165 -0
  608. package/packs/treasury-yields/endpoints.json +226 -0
  609. package/packs/treasury-yields/policy.json +86 -0
  610. package/packs/treasury-yields/source.md +80 -0
  611. package/packs/usaspending/endpoints.json +1316 -0
  612. package/packs/usaspending/policy.json +109 -0
  613. package/packs/usaspending/source.md +103 -0
  614. package/packs/usda-fna/endpoints.json +427 -0
  615. package/packs/usda-fna/policy.json +133 -0
  616. package/packs/usda-fna/source.md +217 -0
  617. package/packs/usda-fooddata/endpoints.json +181 -0
  618. package/packs/usda-fooddata/policy.json +94 -0
  619. package/packs/usda-fooddata/source.md +105 -0
  620. package/packs/usda-nass/endpoints.json +324 -0
  621. package/packs/usda-nass/policy.json +95 -0
  622. package/packs/usda-nass/source.md +85 -0
  623. package/packs/usda-outlook/endpoints.json +86 -0
  624. package/packs/usda-outlook/policy.json +109 -0
  625. package/packs/usda-outlook/source.md +144 -0
  626. package/packs/usgs/endpoints.json +313 -0
  627. package/packs/usgs/policy.json +95 -0
  628. package/packs/usgs/source.md +96 -0
  629. package/packs/usitc/endpoints.json +74 -0
  630. package/packs/usitc/policy.json +111 -0
  631. package/packs/usitc/source.md +90 -0
  632. package/packs/uspto/endpoints.json +141 -0
  633. package/packs/uspto/policy.json +95 -0
  634. package/packs/uspto/source.md +101 -0
  635. package/packs/va/endpoints.json +414 -0
  636. package/packs/va/policy.json +101 -0
  637. package/packs/va/source.md +129 -0
  638. package/packs/world-bank/endpoints.json +122 -0
  639. package/packs/world-bank/policy.json +101 -0
  640. package/packs/world-bank/source.md +93 -0
@@ -0,0 +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
+ }
288
+ }
@@ -0,0 +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
+ }
@@ -0,0 +1,84 @@
1
+ # Regulations.gov (API v4)
2
+ Depth: standard. Key: optional (DATA_GOV_API_KEY; the public DEMO_KEY works at about 10 requests an hour).
3
+ Federal rulemaking dockets, the documents in them (proposed and final rules, notices, supporting
4
+ material) and the public comments agencies have posted.
5
+
6
+ ## When to use
7
+ - How many comments a docket or proposed rule has (posted), comments over time, documents in a docket,
8
+ rules open for comment now, dockets an agency opened, comment deadlines.
9
+ - Not here: the published rule text and Federal Register metadata such as significance, executive
10
+ orders, page counts by year (federal-register); CFR text (govinfo); bills (congress). Agencies with
11
+ their own comment systems (SEC, FCC, FERC) are missing or incomplete.
12
+
13
+ ## Endpoints and datasets
14
+ | Endpoint | Returns (one row per) | Key parameters |
15
+ |---|---|---|
16
+ | `documents` | document | `filter[searchTerm]`, `filter[agencyId]`, `filter[docketId]`, `filter[documentType]` (Proposed Rule, Rule, Notice, Supporting & Related Material, Other), `filter[frDocNum]`, `filter[withinCommentPeriod]`, `filter[commentEndDate][ge/le]`, `filter[postedDate][ge/le]`, `sort` |
17
+ | `document` | one document (full metadata) | `documentId`, `include=attachments` |
18
+ | `comments` | posted comment (id, title, dates) | `filter[docketId]` or `filter[commentOnId]` (document objectId), `filter[agencyId]`, `filter[searchTerm]`, `filter[postedDate][ge/le]`, `filter[lastModifiedDate][ge/le]`, `sort` |
19
+ | `comment_count` | one row: the filters and `totalElements` | same filters as `comments` |
20
+ | `comment` | one comment with its text | `commentId`, `include=attachments` |
21
+ | `dockets` | docket | `filter[searchTerm]`, `filter[agencyId]`, `filter[docketType]` (Rulemaking, Nonrulemaking), `sort` |
22
+ | `docket` | one docket (title, RIN, abstract) | `docketId` |
23
+
24
+ Columns drop the API's `attributes.` prefix (values unchanged). IDs: docket `EPA-HQ-OAR-2023-0072`;
25
+ document `EPA-HQ-OAR-2023-0072-0001` (docket + sequence); `objectId` (`0900006485a3507a`) is a separate
26
+ internal id, the one `filter[commentOnId]` needs. `request_schema` with `search` finds catalog aliases (agency acronyms).
27
+
28
+ ## Spec examples
29
+ ```json
30
+ {"description": "Power-plant greenhouse gas rule: proposed rule documents and posted comments",
31
+ "requests": [
32
+ {"name": "docket_rules", "endpoint": "documents",
33
+ "params": {"filter[docketId]": "EPA-HQ-OAR-2023-0072", "filter[documentType]": "Proposed Rule"}},
34
+ {"name": "docket_comments", "endpoint": "comment_count", "params": {"filter[docketId]": "EPA-HQ-OAR-2023-0072"}}]}
35
+ ```
36
+ ```json
37
+ {"description": "EPA proposed rules posted in 2025",
38
+ "requests": [{"name": "epa_prop_2025", "endpoint": "documents",
39
+ "params": {"filter[agencyId]": "EPA", "filter[documentType]": "Proposed Rule",
40
+ "filter[postedDate][ge]": "2025-01-01", "filter[postedDate][le]": "2025-12-31"},
41
+ "max_rows": 2000}]}
42
+ ```
43
+ ```json
44
+ {"description": "Rules open for comment now at FDA",
45
+ "requests": [{"name": "fda_open", "endpoint": "documents",
46
+ "params": {"filter[agencyId]": "FDA", "filter[withinCommentPeriod]": "true", "sort": "commentEndDate"}}]}
47
+ ```
48
+
49
+ ## Data format and traps
50
+ - Posted is not received. `comment_count` and `comments` count comments the agency posted. Agencies post
51
+ one copy of a mass-mail campaign (the rest counted in the agency's own tally or attached), withhold
52
+ abusive or duplicate submissions, and post with delays. Example: docket EPA-HQ-OAR-2023-0072 showed
53
+ 8,202 posted comments in Oct 2026; an agency's own "comments received" figure can be much larger.
54
+ Say "posted comments".
55
+ - A docket's comments cover every document in it; comments on one rule need `filter[commentOnId]` with
56
+ that document's `objectId` (not its documentId). New documents can show 0 comments for weeks.
57
+ - At most 10,000 rows per query: page size 250, page number at most 40 (HTTP 400 above). For more, sort by
58
+ `lastModifiedDate` and repeat with `filter[lastModifiedDate][ge]` set to the last value seen, or split
59
+ by `filter[postedDate]` ranges.
60
+ - Date filters: `filter[postedDate]` and `filter[commentEndDate]` take `YYYY-MM-DD`;
61
+ `filter[lastModifiedDate]` takes `YYYY-MM-DD HH:MM:SS` (Eastern time). Returned timestamps are UTC
62
+ (`2023-05-23T04:00:00Z` is May 23 Eastern).
63
+ - `documentType` values are labels with spaces and capitals ("Proposed Rule"); "Rule" means final rule.
64
+ `subtype` adds detail ("Supplemental Notice of Proposed Rulemaking (SNPRM)", "Extension of Comment Period").
65
+ - List rows hold only summary fields; full text and submitter fields need `comment` or `document`, one call
66
+ each. Comment titles often contain the submitter's name as posted.
67
+ - `withdrawn` documents and comments stay in results with `withdrawn=True`; filter them out when counting.
68
+ - Agency coverage varies: agencies joined Regulations.gov at different times and some post only part of
69
+ their dockets; independent agencies such as SEC, FCC and FERC use their own systems.
70
+
71
+ ## Access
72
+ Key optional: DATA_GOV_API_KEY (free, https://api.data.gov/signup/), sent as the `api_key` query
73
+ parameter. Without it the pack uses `DEMO_KEY`: about 10 requests an hour per IP address on this API
74
+ (observed X-RateLimit-Limit 10), enough for a few small requests; a key allows 1,000 an hour (observed).
75
+ Without a key, a spec needing more than about 8 calls stops with `key_missing`. Manual: `manual_bundle`'s
76
+ INSTRUCTIONS.md lists JSON links with `api_key=DEMO_KEY` (one per 250 rows); open each in a browser, save it,
77
+ upload, then `ingest`. On www.regulations.gov a
78
+ docket's Browse Documents / Browse Comments lists have a Download button (CSV).
79
+
80
+ ## Citation and terms
81
+ "Regulations.gov API v4 (eRulemaking Program, GSA), <query>, api.regulations.gov, retrieved <date>."
82
+ Agency documents and metadata are public domain; redistribution allowed. Required notice: comments are
83
+ posted as received and posted counts differ from comments received. Comment attachments can contain
84
+ copyrighted material or personal details; report counts and metadata, quote sparingly.