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,118 @@
1
+ {
2
+ "id": "fbi",
3
+ "title": "FBI Crime Data Explorer (UCR, NIBRS, hate crime, arrests, police employees)",
4
+ "agency": "Federal Bureau of Investigation, Criminal Justice Information Services Division (U.S. Department of Justice)",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "crime",
8
+ "justice",
9
+ "public safety",
10
+ "policing"
11
+ ],
12
+ "keywords": [
13
+ "crime",
14
+ "crime rate",
15
+ "violent crime",
16
+ "property crime",
17
+ "murder",
18
+ "homicide",
19
+ "robbery",
20
+ "assault",
21
+ "burglary",
22
+ "larceny",
23
+ "theft",
24
+ "motor vehicle theft",
25
+ "arson",
26
+ "rape",
27
+ "arrest",
28
+ "arrests",
29
+ "hate crime",
30
+ "bias",
31
+ "nibrs",
32
+ "ucr",
33
+ "srs",
34
+ "police",
35
+ "law enforcement",
36
+ "officers",
37
+ "clearance",
38
+ "fbi",
39
+ "cde",
40
+ "drug arrests",
41
+ "supplementary homicide"
42
+ ],
43
+ "questions": [
44
+ "violent crime rate trend in the United States",
45
+ "murders in a state by year",
46
+ "hate crimes by bias type",
47
+ "drug arrests by year",
48
+ "number of police officers per 1,000 people",
49
+ "crime clearance rates",
50
+ "homicide victims by weapon"
51
+ ],
52
+ "homepage": "https://cde.ucr.cjis.gov/",
53
+ "terms_url": "https://www.fbi.gov/how-we-can-help-you/more-fbi-services-and-information/ucr",
54
+ "auth": {
55
+ "env": "DATA_GOV_API_KEY",
56
+ "required": "optional",
57
+ "placement": "query",
58
+ "param": "API_KEY",
59
+ "home": "data-gov",
60
+ "signup_url": "https://api.data.gov/signup/",
61
+ "echoes_key": false,
62
+ "key_only": [
63
+ "more than 30 requests an hour or 50 a day (DEMO_KEY limits per IP address; a personal key allows 1,000 an hour)"
64
+ ],
65
+ "demo_key": "DEMO_KEY"
66
+ },
67
+ "limits": {
68
+ "rps": 1,
69
+ "burst": 3,
70
+ "daily_quota": null,
71
+ "max_rows": 100000
72
+ },
73
+ "routes": {
74
+ "api": {
75
+ "base": "https://api.usa.gov/crime/fbi/cde",
76
+ "probe": "https://api.usa.gov/crime/fbi/cde/summarized/national/V?from=01-2022&to=12-2022",
77
+ "hosts": [
78
+ "api.usa.gov"
79
+ ]
80
+ },
81
+ "manual": {
82
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each carries api.data.gov's public DEMO_KEY; replace it with your own free key if it answers OVER_RATE_LIMIT), save the JSON under the name shown, and upload the files. Without the links: the Crime Data Explorer at https://cde.ucr.cjis.gov/ (Explorer > choose crime, location and years > download CSV) or its Documents & Downloads page for full NIBRS and SRS files."
83
+ }
84
+ },
85
+ "cache": {
86
+ "mode": "run_only",
87
+ "ttl_hours": null,
88
+ "why": "Small chart queries; CDE refreshes monthly and revises past years, so data/ is reused only within a run."
89
+ },
90
+ "redistribution": {
91
+ "mode": "allowed",
92
+ "why": "Uniform Crime Reporting data published by the FBI are U.S. government works in the public domain (17 U.S.C. 105); attribute the FBI UCR Program and do not imply endorsement."
93
+ },
94
+ "notices": [],
95
+ "retention": null,
96
+ "citation": "Federal Bureau of Investigation, Crime Data Explorer, {dataset}, api.usa.gov/crime/fbi/cde, retrieved {retrieved_long}.",
97
+ "audit_hooks": [
98
+ {
99
+ "id": "fbi_participation",
100
+ "kind": "require_text",
101
+ "any": [
102
+ "coverage",
103
+ "participat",
104
+ "reporting agencies",
105
+ "nibrs transition"
106
+ ],
107
+ "why": "Counts depend on which agencies reported; 2021 coverage fell to about 77% of the population during the NIBRS transition, so a report must state coverage or participation."
108
+ }
109
+ ],
110
+ "clarify": [
111
+ "Counts or rates? Counts depend on how many agencies reported (2021 coverage fell to about 77% of the population); compare years with rates per 100,000 and state the coverage.",
112
+ "Which years? 2021 is not comparable with earlier and later years at the state and national level because of the NIBRS transition; say whether to include or flag it.",
113
+ "Reported offenses (agency submissions, this pack) or the FBI's published national estimates (Crime in the Nation tables; not fetched by this pack)?"
114
+ ],
115
+ "formats": [
116
+ "json"
117
+ ]
118
+ }
@@ -0,0 +1,108 @@
1
+ # FBI Crime Data Explorer (UCR, NIBRS, hate crime, arrests, police employees)
2
+ Depth: standard. Key: optional (DATA_GOV_API_KEY; DEMO_KEY works for a few requests). Agency-reported crime
3
+ data from the FBI Uniform Crime Reporting (UCR) Program, served by the Crime Data Explorer (CDE) API.
4
+
5
+ ## When to use
6
+ - Offenses and clearances by month (violent, property, homicide, robbery ...), national, state or agency;
7
+ arrests; NIBRS incident breakdowns (victim, offender, location, weapon); Supplementary Homicide Reports;
8
+ hate crimes by bias; law enforcement employees; law enforcement suicide data (LESDC).
9
+ - Not here: victimization surveys including crimes not reported to police (BJS NCVS, not covered), prisons
10
+ and sentencing (BJS / U.S. Sentencing Commission), federal prosecutions and DOJ announcements (doj-news,
11
+ which is text), the FBI's annual "Crime in the Nation" estimate tables (published reports).
12
+ - Not wrapped by this pack, though the CDE API has them (verified 2026-10): NIBRS estimates with lower and
13
+ upper bounds (`/nibrs-estimation/national|region|state/<numeric offense ID>?year=`, years 2021 and 2022
14
+ only, other years HTTP 400; the offense and state IDs are numeric codes not documented here) and use of
15
+ force participation (`/uof?year=&location=`). Use them only after checking the codes on the CDE site.
16
+
17
+ ## Endpoints and datasets
18
+ Most endpoints come in three levels: `_national`, `_state` (`state` = CA), `_agency` (`ori` = DE0010100).
19
+ | Endpoint family | Returns | Parameters |
20
+ |---|---|---|
21
+ | `agencies_by_state` | agencies: ORI, name, type, county, `is_nibrs`, `nibrs_start_date` | `state` |
22
+ | `summarized_*` | monthly offenses and clearances (counts, rates per 100,000), population covered | `offense` V P HOM RPE ROB ASS BUR LAR MVT ARS, `from`, `to` |
23
+ | `arrest_*` | `type=counts`: monthly arrests and rates; `type=totals`: by sex, race, age, offense | `offense` (all, 11, 30, 150 ...), `from`, `to`, `type` |
24
+ | `nibrs_*` | `counts`: monthly offenses; `totals`: victim/offender/location/weapon breakdowns | `offense` (09A, 13A, 23* ...), `from`, `to`, `type` |
25
+ | `shr_*` | expanded homicide: monthly victims or breakdowns (weapon, circumstance, relationship) | `from`, `to`, `type` |
26
+ | `supplemental_*` | expanded property offenses | `offense` NB NL NMVT NROB, `from`, `to` |
27
+ | `hate_crime_*`, `hate_crime_bias_*` | `type=totals` (default): incidents by bias, category, offense, location, offender over the span; `type=counts`: monthly incidents, offenses and coverage | `bias` (12, 21 ...), `from`, `to`, `type` |
28
+ | `pe_national` / `pe_state` / `pe_agency` | officers and civilians by sex, employees per 1,000 people, yearly | `from`, `to` (YYYY) |
29
+ | `lesdc` | Law Enforcement Suicide Data Collection, one chart and year | `chartType`, `year` |
30
+ Code lists are in the catalog: `request_schema` with `search: "drug"` finds arrest codes 150-160,
31
+ `search: "anti-jewish"` the bias code. `from`/`to` take MM-YYYY or a year (2019 becomes 01-2019 as `from`, 12-2019 as `to`).
32
+
33
+ ## Spec examples
34
+ ```json
35
+ {"description": "Violent crime, United States, monthly 2019-2023",
36
+ "requests": [{"name": "violent_us", "endpoint": "summarized_national", "params": {"offense": "V", "from": "2019", "to": "2023"}}]}
37
+ ```
38
+ ```json
39
+ {"description": "Homicide in Texas vs the nation; drug abuse arrests nationally",
40
+ "requests": [{"name": "hom_tx", "endpoint": "summarized_state", "params": {"state": "TX", "offense": "HOM", "from": "2018", "to": "2023"}},
41
+ {"name": "drug_arrests", "endpoint": "arrest_national", "params": {"offense": "150", "from": "2018", "to": "2023"}}]}
42
+ ```
43
+ ```json
44
+ {"description": "Hate crimes in 2023 by bias; agencies in Delaware",
45
+ "requests": [{"name": "hate_us", "endpoint": "hate_crime_national", "params": {"from": "2023", "to": "2023"}},
46
+ {"name": "de_agencies", "endpoint": "agencies_by_state", "params": {"state": "DE"}}]}
47
+ ```
48
+ ```json
49
+ {"description": "Arrests by sex, race and age, each year 2021-2023 (totals: one request per year)",
50
+ "requests": [{"name": "arrests_2021", "endpoint": "arrest_national", "params": {"offense": "all", "from": "2021", "to": "2021", "type": "totals"}},
51
+ {"name": "arrests_2022", "endpoint": "arrest_national", "params": {"offense": "all", "from": "2022", "to": "2022", "type": "totals"}},
52
+ {"name": "arrests_2023", "endpoint": "arrest_national", "params": {"offense": "all", "from": "2023", "to": "2023", "type": "totals"}}]}
53
+ ```
54
+
55
+ ## Data format and traps
56
+ - Output is one long table per request: `section` (e.g. `offenses/actuals`, `offenses/rates`,
57
+ `populations/participated_population`, `tooltips/Percent of Population Coverage`, `bias_section/offense_type`),
58
+ `series` (e.g. "United States Offenses", "Delaware Clearances"), `key` (label or MM-YYYY), `period`
59
+ (YYYY-MM), `year`, `month`, `value`, `unit`, `data_through`, `last_refresh`, `span_from`, `span_to` (the
60
+ request's from/to). Filter on `section` first.
61
+ - Rates are **monthly** offenses per 100,000 of the **participating** population (verified: Jan 2020 rate
62
+ 29.06 = 93,464 offenses / 321,657,569 participated population x 100,000). Annual rates are the sum of
63
+ monthly rates only if coverage is stable; better: sum actuals and divide by the average participated
64
+ population. State requests also return the United States series for comparison.
65
+ - **NIBRS transition.** The FBI retired the summary reporting system (SRS) on January 1, 2021 and accepted
66
+ only NIBRS submissions for 2021; many large agencies had not converted. National population coverage fell
67
+ from 96.0% (June 2020) to 77.1% (June 2021) and was back to 95.3% (June 2022) (verified from the
68
+ coverage series). National violent offenses summed to 1,273,168 in 2020, 932,588 in 2021 and 1,271,298 in
69
+ 2022: the 2021 drop is missing agencies, not less crime. Never compare 2021 counts with other years;
70
+ compare rates and always report coverage (`tooltips/Percent of Population Coverage`). State coverage in
71
+ 2021 ranges from near 100% to very low; check it per state. From 2022 the FBI again accepted SRS-format
72
+ submissions (background, not verified against the API here).
73
+ - NIBRS (`nibrs_*`) counts only NIBRS agencies, so before 2021 it covers a minority of the population and
74
+ trend breaks follow agencies' `nibrs_start_date`. NIBRS counts every offense in an incident; summary (SRS)
75
+ counts used the hierarchy rule (most serious offense only), so NIBRS and summarized numbers differ.
76
+ - Some December values are much higher than other months (national violent rate 57.3 in Dec 2020 against
77
+ about 30 in other months; 38.1 in Dec 2022). Verified in the data; the cause (agencies reporting annual
78
+ totals in December) is a likely explanation, not verified. Do not read it as seasonality.
79
+ - `type=totals` breakdowns (hate crime, arrests, NIBRS, SHR) are summed over the whole `from`-`to` span and
80
+ have no period; `span_from`/`span_to` say what a row covers (verified 2026-10: a two-year request equals
81
+ the sum of the two one-year requests). For a breakdown by year, make one request per year and stack the
82
+ tables; never divide a multi-year total by the number of years.
83
+ - These are offenses reported by agencies, not estimates for the whole population; the FBI's national
84
+ estimates (Crime in the Nation, and the API's NIBRS estimates for 2021-2022) impute non-reporting
85
+ agencies and will differ.
86
+ - Hate crime counts depend heavily on agency participation and local practice; zero often means "not
87
+ reported". The default `type=totals` reply carries no participation figure; `type=counts` on the same
88
+ endpoint returns monthly `actuals` plus `populations/participated_population` and `tooltips/Percent of
89
+ Population Coverage` (verified 2026-10). Fetch both to state coverage per year; for a breakdown per year,
90
+ make one totals request per year (`from` = `to` = the year). Past years change as late submissions arrive:
91
+ the CDE count for a year can exceed the FBI's first annual report, so cite `last_refresh`. Clearances are offenses cleared in the month, possibly from earlier months' offenses.
92
+ - Agency rows: `ori` is the 9-character agency ID; `county_group` is the county key the API groups by.
93
+ - Errors: an invalid offense or a date not in MM-YYYY answers HTTP 400 with a plain-text message.
94
+
95
+ ## Access
96
+ Key optional: DATA_GOV_API_KEY (free at https://api.data.gov/signup/) sent as `API_KEY`; without one the
97
+ pack sends DEMO_KEY, limited per IP address to 30 requests an hour and 50 a day (api.data.gov developer
98
+ manual, https://api.data.gov/docs/developer-manual/); a personal key allows 1,000 requests an hour.
99
+ Responses carry `X-RateLimit-Limit: 10` (window not documented); the pack keeps to one request a second. `fetch` downloads
100
+ when api.usa.gov answers. Manual route (`manual_bundle`): `manual_download/INSTRUCTIONS.md` lists one JSON link per
101
+ request with `API_KEY=DEMO_KEY`; open each, save under the name shown, upload, then `ingest`. Without the links: the
102
+ Crime Data Explorer (https://cde.ucr.cjis.gov/) charts have a download button (CSV), and its Documents &
103
+ Downloads page has full NIBRS and SRS files by state and year (not parsed by this pack).
104
+
105
+ ## Citation and terms
106
+ "Federal Bureau of Investigation, Crime Data Explorer, <series>, api.usa.gov/crime/fbi/cde, retrieved <date>."
107
+ Public domain (U.S. government work); attribute the FBI UCR Program, do not imply endorsement.
108
+ Redistribution allowed. A report must state agency participation or coverage (audit hook).
@@ -0,0 +1,238 @@
1
+ {
2
+ "base_url": "https://api.fda.gov",
3
+ "endpoints": {
4
+ "search": {
5
+ "path": "/{category}/{noun}.json",
6
+ "method": "GET",
7
+ "description": "Records of one openFDA dataset matching a search (1,000 a page; at most 26,000 rows: skip may not exceed 25,000).",
8
+ "params": {
9
+ "dataset": {
10
+ "catalog": true,
11
+ "desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
12
+ },
13
+ "search": {
14
+ "desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
15
+ },
16
+ "sort": {
17
+ "desc": "field:asc or field:desc, e.g. report_date:desc"
18
+ }
19
+ },
20
+ "records": "results",
21
+ "total": "meta.results.total",
22
+ "paging": {
23
+ "type": "offset",
24
+ "limit_param": "limit",
25
+ "offset_param": "skip",
26
+ "size": 1000
27
+ },
28
+ "max_rows": 26000,
29
+ "missing": [
30
+ ""
31
+ ],
32
+ "flatten": true
33
+ },
34
+ "count": {
35
+ "path": "/{category}/{noun}.json",
36
+ "method": "GET",
37
+ "description": "Counts of records by the values of one field (top 1,000 terms, or a daily time series for a date field).",
38
+ "params": {
39
+ "dataset": {
40
+ "catalog": true,
41
+ "desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
42
+ },
43
+ "search": {
44
+ "desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
45
+ },
46
+ "count": {
47
+ "required": true,
48
+ "desc": "field to count, with .exact for whole phrases (patient.reaction.reactionmeddrapt.exact); a date field gives daily counts"
49
+ },
50
+ "limit": {
51
+ "desc": "number of terms, at most 1000; default 1000 (all the API returns); without a key the pack sends at most 999 (limit=1000 answers HTTP 403 on some datasets). Ignored by date-field counts"
52
+ }
53
+ },
54
+ "defaults": {
55
+ "limit": 1000
56
+ },
57
+ "records": "results",
58
+ "paging": {
59
+ "type": "none"
60
+ },
61
+ "max_rows": 40000,
62
+ "missing": [
63
+ ""
64
+ ],
65
+ "flatten": true
66
+ }
67
+ },
68
+ "catalog": {
69
+ "drug_event": {
70
+ "id": "drug/event",
71
+ "name": "Drug adverse event reports (FAERS)",
72
+ "description": "Reports submitted to FDA about adverse events and medication errors; 20.7M reports, 2004-present, updated quarterly",
73
+ "endpoint": "search",
74
+ "page": "https://open.fda.gov/apis/drug/event/"
75
+ },
76
+ "drug_label": {
77
+ "id": "drug/label",
78
+ "name": "Drug labeling (SPL)",
79
+ "description": "Structured product labels: indications, warnings, boxed warnings, dosage",
80
+ "endpoint": "search",
81
+ "page": "https://open.fda.gov/apis/drug/label/"
82
+ },
83
+ "drug_ndc": {
84
+ "id": "drug/ndc",
85
+ "name": "NDC Directory",
86
+ "description": "National Drug Code directory: products, packages, active ingredients, pharm class, DEA schedule",
87
+ "endpoint": "search",
88
+ "page": "https://open.fda.gov/apis/drug/ndc/"
89
+ },
90
+ "drug_enforcement": {
91
+ "id": "drug/enforcement",
92
+ "name": "Drug recall enforcement reports",
93
+ "description": "Drug recalls with classification (I, II, III), firm, reason, status; enforcement reports from 2012-06-20 on (report_date)",
94
+ "endpoint": "search",
95
+ "page": "https://open.fda.gov/apis/drug/enforcement/"
96
+ },
97
+ "drugsfda": {
98
+ "id": "drug/drugsfda",
99
+ "name": "Drugs@FDA",
100
+ "description": "Approved drug applications (NDA, ANDA, BLA) with submissions and products",
101
+ "endpoint": "search",
102
+ "page": "https://open.fda.gov/apis/drug/drugsfda/"
103
+ },
104
+ "drug_shortages": {
105
+ "id": "drug/shortages",
106
+ "name": "Drug shortages",
107
+ "description": "Current, to-be-discontinued and resolved drug shortages: status, therapeutic category, availability; count fields status and therapeutic_category (no .exact); dates are MM/DD/YYYY text",
108
+ "endpoint": "search",
109
+ "page": "https://open.fda.gov/apis/drug/drugshortages/"
110
+ },
111
+ "device_event": {
112
+ "id": "device/event",
113
+ "name": "Device adverse events (MAUDE)",
114
+ "description": "Medical device reports of deaths, injuries and malfunctions; 26.5M reports",
115
+ "endpoint": "search",
116
+ "page": "https://open.fda.gov/apis/device/event/"
117
+ },
118
+ "device_510k": {
119
+ "id": "device/510k",
120
+ "name": "510(k) clearances",
121
+ "description": "Premarket notification decisions",
122
+ "endpoint": "search",
123
+ "page": "https://open.fda.gov/apis/device/510k/"
124
+ },
125
+ "device_classification": {
126
+ "id": "device/classification",
127
+ "name": "Device classification",
128
+ "description": "Device product codes, class (1, 2, 3), medical specialty, regulation number",
129
+ "endpoint": "search",
130
+ "page": "https://open.fda.gov/apis/device/classification/"
131
+ },
132
+ "device_enforcement": {
133
+ "id": "device/enforcement",
134
+ "name": "Device recall enforcement reports",
135
+ "description": "Device recalls with classification, firm and reason; enforcement reports from 2012-06-20 on (report_date)",
136
+ "endpoint": "search",
137
+ "page": "https://open.fda.gov/apis/device/enforcement/"
138
+ },
139
+ "device_recall": {
140
+ "id": "device/recall",
141
+ "name": "Device recalls (RES)",
142
+ "description": "Device recall records from the Recall Enterprise System, with root cause",
143
+ "endpoint": "search",
144
+ "page": "https://open.fda.gov/apis/device/recall/"
145
+ },
146
+ "device_pma": {
147
+ "id": "device/pma",
148
+ "name": "Premarket approval (PMA)",
149
+ "description": "PMA decisions for class III devices, including supplements",
150
+ "endpoint": "search",
151
+ "page": "https://open.fda.gov/apis/device/pma/"
152
+ },
153
+ "device_registration": {
154
+ "id": "device/registrationlisting",
155
+ "name": "Device registration and listing",
156
+ "description": "Establishments and the devices they list",
157
+ "endpoint": "search",
158
+ "page": "https://open.fda.gov/apis/device/registrationlisting/"
159
+ },
160
+ "device_udi": {
161
+ "id": "device/udi",
162
+ "name": "Unique Device Identifier (GUDID)",
163
+ "description": "Device identification records: brand, model, company, sterilization, MRI safety",
164
+ "endpoint": "search",
165
+ "page": "https://open.fda.gov/apis/device/udi/"
166
+ },
167
+ "device_covid19serology": {
168
+ "id": "device/covid19serology",
169
+ "name": "COVID-19 serology test evaluations",
170
+ "description": "Independent evaluations of antibody tests (archived 2022)",
171
+ "endpoint": "search",
172
+ "page": "https://open.fda.gov/apis/device/covid19serology/"
173
+ },
174
+ "food_enforcement": {
175
+ "id": "food/enforcement",
176
+ "name": "Food recall enforcement reports",
177
+ "description": "Food (and cosmetics) recalls with classification, firm, reason, distribution; enforcement reports from 2012-06-20 on (report_date)",
178
+ "endpoint": "search",
179
+ "page": "https://open.fda.gov/apis/food/enforcement/"
180
+ },
181
+ "food_event": {
182
+ "id": "food/event",
183
+ "name": "Food, supplement and cosmetic adverse events (CAERS)",
184
+ "description": "Adverse event reports for foods, dietary supplements and cosmetics",
185
+ "endpoint": "search",
186
+ "page": "https://open.fda.gov/apis/food/event/"
187
+ },
188
+ "animal_event": {
189
+ "id": "animalandveterinary/event",
190
+ "name": "Animal and veterinary adverse events",
191
+ "description": "Adverse event reports for animal drugs and devices",
192
+ "endpoint": "search",
193
+ "page": "https://open.fda.gov/apis/animalandveterinary/event/"
194
+ },
195
+ "tobacco_problem": {
196
+ "id": "tobacco/problem",
197
+ "name": "Tobacco product problem reports",
198
+ "description": "Reports of health and product problems with tobacco and e-cigarette products",
199
+ "endpoint": "search",
200
+ "page": "https://open.fda.gov/apis/tobacco/problem/"
201
+ },
202
+ "historical_document": {
203
+ "id": "other/historicaldocument",
204
+ "name": "Historical FDA documents",
205
+ "description": "Press releases and reports, 1913-2014, with OCR text",
206
+ "endpoint": "search",
207
+ "page": "https://open.fda.gov/apis/other/historicaldocument/"
208
+ },
209
+ "nsde": {
210
+ "id": "other/nsde",
211
+ "name": "NDC SPL Data Elements",
212
+ "description": "NDC package-level data elements from SPL files",
213
+ "endpoint": "search",
214
+ "page": "https://open.fda.gov/apis/other/nsde/"
215
+ },
216
+ "substance": {
217
+ "id": "other/substance",
218
+ "name": "Substance data (GSRS)",
219
+ "description": "Substance records: names, codes, structures, relationships",
220
+ "endpoint": "search",
221
+ "page": "https://open.fda.gov/apis/other/substance/"
222
+ },
223
+ "unii": {
224
+ "id": "other/unii",
225
+ "name": "UNII",
226
+ "description": "Unique Ingredient Identifiers and names",
227
+ "endpoint": "search",
228
+ "page": "https://open.fda.gov/apis/other/unii/"
229
+ },
230
+ "crl": {
231
+ "id": "transparency/crl",
232
+ "name": "Complete response letters",
233
+ "description": "FDA complete response letters to drug and biologic applicants",
234
+ "endpoint": "search",
235
+ "page": "https://open.fda.gov/apis/transparency/completeresponseletters/"
236
+ }
237
+ }
238
+ }
@@ -0,0 +1,121 @@
1
+ {
2
+ "id": "fda",
3
+ "title": "openFDA (api.fda.gov)",
4
+ "agency": "U.S. Food and Drug Administration",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "health",
8
+ "drugs",
9
+ "medical devices",
10
+ "food safety"
11
+ ],
12
+ "keywords": [
13
+ "fda",
14
+ "openfda",
15
+ "adverse event",
16
+ "adverse events",
17
+ "side effect",
18
+ "faers",
19
+ "maude",
20
+ "drug recall",
21
+ "recall",
22
+ "recalls",
23
+ "device recall",
24
+ "food recall",
25
+ "drug label",
26
+ "boxed warning",
27
+ "ndc",
28
+ "national drug code",
29
+ "drug approval",
30
+ "drugs@fda",
31
+ "510k",
32
+ "pma",
33
+ "drug shortage",
34
+ "shortages",
35
+ "caers",
36
+ "supplement",
37
+ "tobacco",
38
+ "vaping",
39
+ "udi",
40
+ "unii"
41
+ ],
42
+ "questions": [
43
+ "most reported adverse reactions for a drug",
44
+ "drug recalls by classification and year",
45
+ "food recalls in a state",
46
+ "medical device adverse event reports trend",
47
+ "current drug shortages",
48
+ "when was a drug approved"
49
+ ],
50
+ "homepage": "https://open.fda.gov/",
51
+ "terms_url": "https://open.fda.gov/terms/",
52
+ "auth": {
53
+ "env": "DATA_GOV_API_KEY",
54
+ "required": "optional",
55
+ "placement": "query",
56
+ "param": "api_key",
57
+ "home": "data-gov",
58
+ "signup_url": "https://open.fda.gov/apis/authentication/",
59
+ "echoes_key": false,
60
+ "key_only": [
61
+ "more than 1,000 requests a day (120,000 with a key)"
62
+ ],
63
+ "demo_key": null
64
+ },
65
+ "limits": {
66
+ "rps": 3,
67
+ "burst": 6,
68
+ "max_rows": 26000
69
+ },
70
+ "routes": {
71
+ "api": {
72
+ "base": "https://api.fda.gov",
73
+ "probe": "https://api.fda.gov/drug/enforcement.json?limit=1",
74
+ "hosts": [
75
+ "api.fda.gov"
76
+ ]
77
+ },
78
+ "manual": {
79
+ "how": "Open the links in INSTRUCTIONS.md in a browser (openFDA answers JSON without a key), save each page under the shown name and upload. For whole datasets use https://open.fda.gov/data/downloads/ (zipped JSON partitions) and upload the extracted files."
80
+ }
81
+ },
82
+ "cache": {
83
+ "mode": "run_only",
84
+ "ttl_hours": null,
85
+ "why": "Searches are small; openFDA refreshes most datasets weekly and FAERS quarterly. data/ is reused within a run."
86
+ },
87
+ "redistribution": {
88
+ "mode": "allowed",
89
+ "why": "openFDA content and data are public domain under a CC0 1.0 dedication unless otherwise noted (https://open.fda.gov/license/)."
90
+ },
91
+ "notices": [
92
+ "openFDA data are not validated for clinical use. Adverse event reports are voluntary, unverified reports: a report does not show that a product caused the event, and report counts are not incidence or risk rates."
93
+ ],
94
+ "retention": null,
95
+ "citation": "U.S. Food and Drug Administration, openFDA: {dataset}, api.fda.gov, retrieved {retrieved_long}.",
96
+ "audit_hooks": [
97
+ {
98
+ "id": "fda_reports_not_rates",
99
+ "kind": "require_text",
100
+ "any": [
101
+ "not incidence",
102
+ "not rates",
103
+ "not a rate",
104
+ "does not show",
105
+ "do not establish",
106
+ "causal",
107
+ "unverified",
108
+ "voluntary"
109
+ ],
110
+ "why": "A report that uses openFDA adverse-event counts must say they are spontaneous reports, not incidence rates or proof of causation."
111
+ }
112
+ ],
113
+ "clarify": [
114
+ "Adverse events: count reports or count reactions? One report lists several drugs and reactions; say which is counted.",
115
+ "Which dates: when FDA received the report (receivedate) or when the event happened? Recalls: report_date or recall_initiation_date (device_recall: event_date_posted or event_date_initiated)?",
116
+ "All recall classes, or Class I (most serious) only?"
117
+ ],
118
+ "formats": [
119
+ "json"
120
+ ]
121
+ }