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,130 @@
1
+ # OMB President's Budget data via GovInfo (Historical Tables, Public Budget Database, Federal Credit Supplement)
2
+ Depth: standard. Key: none. The Office of Management and Budget's budget data files, read from GovInfo's
3
+ stable URLs: the Historical Tables (receipts, outlays, deficits, debt, budget authority since 1789/1940/1962),
4
+ the Public Budget Database (every budget account, every year since 1962), and the Federal Credit Supplement
5
+ (credit subsidy rates of loan and loan guarantee programs).
6
+
7
+ ## When to use
8
+ - Long federal budget histories on one consistent basis: totals, on-/off-budget, percent of GDP, outlays by
9
+ function, subfunction and agency, mandatory vs discretionary (BEA category), receipts by source, debt held by
10
+ the public, grants to states, payments for individuals, federal employment (FTE); the account-level detail
11
+ behind them (Public Budget Database); credit subsidy rates by program (Federal Credit Supplement).
12
+ - The President's estimates for the current year and the budget year onward (labelled "estimate"): proposals,
13
+ not law and not outcomes.
14
+ - Not here: monthly or daily Treasury cash results, debt to the penny, interest rates on the debt (treasury);
15
+ Treasury yields (treasury-yields); GDP and NIPA government accounts (bea); spending by award or recipient
16
+ (usaspending). The Mid-Session Review is published as PDF only and is not read by this pack.
17
+
18
+ ## Endpoints and datasets
19
+ Files at `https://www.govinfo.gov/content/pkg/BUDGET-<FY>-<PKG>/...`, keyless (verified live 2026-10-30). `fy` is
20
+ the budget's fiscal year (the edition): FY2027 = the budget released in 2026. Default `fy`: the newest edition
21
+ GovInfo has (tries next year, this year, last year). One CSV per request; every table gets a `sheet_row` column.
22
+
23
+ | Endpoint | Returns | Key parameters | Units, coverage |
24
+ |---|---|---|---|
25
+ | `historical_table` | one Historical Table as published, multi-row headers joined ("Total Outlays", "On-Budget Receipts", "As Percentages of GDP Gross Federal Debt") | `fy`, `table` ("1.1", "3.2", "8.5" or alias `table_1_1`), optional `header_row`, `header_rows` | per table: millions, billions, percent of GDP, constant FY 2017 dollars (the units line is in the notes); 1789/1901/1930/1940/1962/1976 on |
26
+ | `budget_database` | Public Budget Database: one row per account line with Agency/Bureau/Account codes and names, Treasury and CGAC agency codes, Subfunction Code/Title, BEA Category (Mandatory, Discretionary, Net interest), Grant/non-grant split (outlays only), On- or Off- Budget, then one column per year | `fy`, `kind` = `budget_authority` (1976 on) / `outlays` (1962 on) / `receipts` (1962 on; source category columns instead of subfunction) | thousands of dollars; through the edition's last projection year (FY2027: 2031); 5,000-6,000 rows (receipts about 260) |
27
+ | `credit_supplement` | one Federal Credit Supplement table, label rows (agency, bureau, account) kept in order | `fy`, `table` 1-10 | Table 1 direct loans and Table 2 loan guarantees: subsidy rate (percent), obligations/commitments and average loan size (thousands of dollars) for the current year and the budget year; 3-6 subsidy assumptions; 7-8 reestimates by cohort; 9-10 disbursement rates |
28
+
29
+ Historical Table numbers (FY2026 and FY2027 editions have the same 57 tables): 1.1-1.4 summary (1.2 % of GDP, 1.3
30
+ constant dollars), 2.1-2.5 receipts by source, 3.1-3.2 outlays by function/subfunction, 4.1-4.2 outlays by agency,
31
+ 5.1-5.6 budget authority, 6.1 composition of outlays, 7.1-7.3 debt and debt limit, 8.1-8.8 mandatory/discretionary
32
+ (BEA categories; 8.5 mandatory programs, 8.7 discretionary), 9.1-9.9 investment and R&D, 10.1 GDP and deflators,
33
+ 11.1-11.3 payments for individuals, 12.1-12.3 grants to state and local governments, 13.1 Social Security and
34
+ Medicare trust funds, 14.1-14.6 total (federal, state, local) government, 15.1 health, 16.1-16.2 FTE employees.
35
+ A `request_schema` search ("<words>") finds a table in the catalog (aliases `table_s_t`, `pbd_outlays`, `fcs_table1` ...).
36
+
37
+ How a table is found: Table s.t is GovInfo granule `TAB-<s+1>-<t>` (Table 1.1 = BUDGET-2027-TAB-2-1.xlsx); the pack
38
+ checks the sheet's title row names the table. Editions that do not follow it (FY2026 publishes one workbook,
39
+ BUDGET-2026-TAB.xlsx, sheets hist01z1 ...; FY2015 and earlier other numbers and .xls files) are read from the
40
+ package zip `BUDGET-<FY>-TAB.zip` (1-6 MB), and the note says which member. Public Budget Database: granules 1-3
41
+ (.xlsx; FY2015 and other older editions CSV only, read the same way). FY2026 has no Public Budget Database on
42
+ GovInfo. Credit supplement: one workbook (FY2024 on) or one file per table (FY2018-FY2023).
43
+
44
+ ## Spec examples
45
+ ```json
46
+ {"description": "Receipts, outlays and deficit since 1940, and as percent of GDP (FY2027 edition)",
47
+ "requests": [
48
+ {"name": "summary", "endpoint": "historical_table", "params": {"fy": 2027, "table": "1.1"}},
49
+ {"name": "summary_gdp", "endpoint": "historical_table", "params": {"fy": 2027, "table": "1.2"}},
50
+ {"name": "debt", "endpoint": "historical_table", "params": {"fy": 2027, "table": "7.1"}}]}
51
+ ```
52
+ ```json
53
+ {"description": "Outlays by account and BEA category; outlays by function and subfunction",
54
+ "requests": [
55
+ {"name": "pbd_outlays", "endpoint": "budget_database", "params": {"fy": 2027, "kind": "outlays"}},
56
+ {"name": "by_subfunction", "endpoint": "historical_table", "params": {"fy": 2027, "table": "3.2"}}]}
57
+ ```
58
+ ```json
59
+ {"description": "Credit subsidy rates of direct loan and loan guarantee programs",
60
+ "requests": [
61
+ {"name": "direct_loans", "endpoint": "credit_supplement", "params": {"fy": 2027, "table": 1}},
62
+ {"name": "guarantees", "endpoint": "credit_supplement", "params": {"fy": 2027, "table": 2}}]}
63
+ ```
64
+
65
+ ## Data format and traps
66
+ - Edition matters. Each edition revises history (concepts and reclassifications). Verified: FY2024 total outlays
67
+ are 6,750,856 million in the FY2026 edition and 6,735,261 million in the FY2027 edition, because the FY2027
68
+ edition lowers "International Assistance Programs" (FY2024: 35,798 to 20,194 million; FY2020-FY2023 too).
69
+ Treasury's final Monthly Treasury Statement shows 6,751.6 billion. Take a series from one edition, cite the
70
+ edition (`fy`), and expect small differences from Treasury figures.
71
+ - Actual vs estimate. A year labelled "<year> estimate" (row label in year-row tables, column header in
72
+ year-column tables such as 3.2, 4.1, 5.x) is the President's projection: the current year (fy - 1) is an
73
+ estimate, the budget year (fy) and later are proposals. The notes say how many estimate years a table has.
74
+ Coverage differs within one edition: in FY2027, Tables 1.1-1.4, 7.1-7.2 and 14.x end with actual 2025 (no
75
+ estimates), 9.x, 12.3 and 16.x run to 2027, the others to 2031. In FY2026 every table ends with actual 2024.
76
+ - Units differ by table (FY2027 edition, checked table by table): the units line is in the notes when the table
77
+ has one, otherwise the units are in the column names ("In Millions of Dollars ...", "As Percentages of GDP
78
+ ..."). Millions of dollars: most tables (1.1, 1.4, 2.1, 2.4, 2.5, 3.2, 4.1, 5.x amounts, 7.2, 8.5, 8.7, 9.4-9.9,
79
+ 11.2, 11.3, 12.x, 13.1). Billions: 1.3, 7.3, 8.1, 8.2, 8.6, 8.8, 14.1, 14.2, 14.4, 14.6, 15.1. Percent of GDP:
80
+ 1.2, 2.3, 8.4, 14.3, 14.5 (and part of 1.3, 7.1, 14.1, 14.6). Percent composition: 2.2, 4.2, 5.3, 5.5, 8.3, 9.3.
81
+ Constant (FY 2017) dollars: 1.3, 8.2, 8.6, 8.8, 9.2 (part). 10.1: GDP in billions and price indexes (FY 2017 =
82
+ 1.000). 16.1 thousands of FTEs, 16.2 percent. Tables 3.1 and 6.1 stack blocks in different units under label
83
+ rows ("In millions of dollars:", "As percentages of GDP:"), so "Total, Federal outlays" appears once per
84
+ block: the pack adds a column `units_block`; filter on it. Public Budget Database: thousands of dollars (FY2024
85
+ outlays sum to 6,735,261,000 thousand = Table 1.1). Credit supplement: "Dollars in thousands" except rates
86
+ (percent).
87
+ - Percent of GDP uses fiscal-year GDP (Table 10.1), not calendar-year GDP from BEA.
88
+ - Fiscal years run October-September since FY1977 (July-June before). `TQ` is the transition quarter (July-
89
+ September 1976), its own row or column: not part of 1976 or 1977.
90
+ - On-budget + off-budget = total (unified budget). Off-budget is the Social Security trust funds and the Postal
91
+ Service. Tables 3.2, 4.1 and others show "(On-budget)" and "(Off-budget)" lines under a total: do not add them
92
+ to the total.
93
+ - Rows are as published: label-only rows ("050 National Defense:", "Department of Agriculture", "Farm Service
94
+ Agency:") have empty values, and subtotal and total rows sit among detail rows. Never sum a whole column;
95
+ select the lines you need (by label and `sheet_row` order).
96
+ - Year-column tables (3.2, 4.1, 5.x, 8.5, 12.3 ...) have years as column names ("1962" ... "TQ" ... "2026
97
+ estimate"); year-row tables (1.1, 7.1, 10.1) have the year in the first column ("1789-1849", "1901", "TQ",
98
+ "2026 estimate").
99
+ - Published markers are kept as text: ".........." = not applicable / no amount, "*" = $500 thousand or less
100
+ (or under 0.05 percent), "N/A" = not available, "......" in the credit supplement = no program that year.
101
+ Convert to numbers only after deciding how to treat them. Footnotes (e.g. budget figures before 1933 follow
102
+ the administrative budget concept) are in the notes.
103
+ - Public Budget Database: codes are text with leading zeros ("001", "00"); some account codes are blank and some
104
+ Treasury/CGAC codes are a space. An account can appear on several rows (one per subfunction, BEA category,
105
+ grant split, on/off-budget). Offsetting receipts are negative rows in the outlays file (e.g. "Undistributed
106
+ Offsetting Receipts", "Receipts, Central fiscal operations"); the receipts file is governmental receipts only
107
+ (FY2024 sums to 4,919,884,000 thousand = Table 1.1). Budget authority is not outlays: BA is what may be
108
+ obligated, outlays what is spent.
109
+ - Credit supplement: a negative subsidy rate means the program is estimated to make money for the government; the
110
+ rates are percent of disbursements. Columns are the current year (fy - 1) and the budget year (fy), both
111
+ estimates. Leader dots after labels are removed; nothing else is changed.
112
+ - Constant-dollar tables use OMB's deflators (Table 10.1), not CPI: say which when comparing.
113
+
114
+ ## Access
115
+ No key. GovInfo answers scripts (verified 2026-10-30); limit used two requests per second. A file that does not
116
+ exist answers HTTP 302 to GovInfo's error page (HTML, status 200): the pack treats it as missing, tries the
117
+ package zip for Historical Tables, and otherwise fails with a message naming the URLs (never an empty table).
118
+ `fetch` reads the files directly. Manual route (`manual_bundle`): the bundle lists the GovInfo URL of each file (open it in a
119
+ browser, save under the name shown, upload); for a Historical Table whose link shows the error page, download
120
+ `https://www.govinfo.gov/content/pkg/BUDGET-<FY>-TAB.zip` and upload the zip. The same files are on whitehouse.gov
121
+ with dated paths: https://www.whitehouse.gov/omb/information-resources/budget/historical-tables/ (hist01z1_fy2027.xlsx,
122
+ hist_fy2027.zip) and https://www.whitehouse.gov/omb/information-resources/budget/supplemental-materials/
123
+ (budauth_fy2027.xlsx, outlays_fy2027.xlsx, receipts_fy2027.xlsx, cr_supp_fy2027.xlsx); whitehouse.gov removes older
124
+ editions, GovInfo keeps them (back to the FY1996 budget, file formats vary).
125
+
126
+ ## Citation and terms
127
+ Office of Management and Budget, Budget of the U.S. Government, Fiscal Year <fy>, <Historical Tables / Public
128
+ Budget Database / Federal Credit Supplement>, GovInfo (www.govinfo.gov), retrieved <date>. Name the table (e.g.
129
+ "Historical Table 1.1") and the edition. U.S. government work in the public domain (17 U.S.C. 105): free to
130
+ reuse and redistribute.
@@ -0,0 +1,298 @@
1
+ {
2
+ "base_url": "https://openpaymentsdata.cms.gov",
3
+ "endpoints": {
4
+ "query": {
5
+ "path": "/api/1/datastore/query/{dataset}/{index}",
6
+ "method": "GET",
7
+ "description": "DKAN datastore query on one Open Payments dataset (payments by program year, or a summary table).",
8
+ "params": {
9
+ "dataset": {
10
+ "in": "path",
11
+ "required": true,
12
+ "catalog": true,
13
+ "desc": "catalog alias (general_2024, state_totals) or dataset id (UUID)"
14
+ },
15
+ "index": {
16
+ "in": "path",
17
+ "desc": "distribution index; 0 = the dataset's CSV (each dataset has one, checked 2026-10)"
18
+ },
19
+ "where": {
20
+ "desc": "equality filters {column: value}; a list value means IN (recipient_state, program_year, covered_recipient_npi)"
21
+ },
22
+ "conditions": {
23
+ "desc": "list of {property, value, operator}; operators = <> < <= > >= LIKE IN 'NOT IN' BETWEEN CONTAINS 'STARTS WITH'; LIKE uses % and is case-insensitive"
24
+ },
25
+ "sort": {
26
+ "desc": "column or -column (descending), or a list; slow on the payment files"
27
+ },
28
+ "columns": {
29
+ "desc": "list of columns to return (default all, about 90 in the payment files)"
30
+ }
31
+ },
32
+ "defaults": {
33
+ "index": "0",
34
+ "schema": "false"
35
+ },
36
+ "records": "results",
37
+ "total": "count",
38
+ "paging": {
39
+ "type": "offset",
40
+ "limit_param": "limit",
41
+ "offset_param": "offset",
42
+ "size": 500
43
+ },
44
+ "max_rows": 100000,
45
+ "missing": [
46
+ ""
47
+ ],
48
+ "flatten": true
49
+ }
50
+ },
51
+ "catalog": {
52
+ "general_2019": {
53
+ "id": "4e54dd6c-30f8-4f86-86a7-3c109a89528e",
54
+ "name": "2019 General Payment Data",
55
+ "description": "Program year 2019. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
56
+ "endpoint": "query",
57
+ "page": "https://openpaymentsdata.cms.gov/dataset/4e54dd6c-30f8-4f86-86a7-3c109a89528e"
58
+ },
59
+ "research_2019": {
60
+ "id": "713a6016-1930-4a0c-b7c2-3e3de4f244c5",
61
+ "name": "2019 Research Payment Data",
62
+ "description": "Program year 2019. Research payments: one row per payment, with study name, principal investigators, amount",
63
+ "endpoint": "query",
64
+ "page": "https://openpaymentsdata.cms.gov/dataset/713a6016-1930-4a0c-b7c2-3e3de4f244c5"
65
+ },
66
+ "ownership_2019": {
67
+ "id": "0b5c9710-7edb-484e-abc8-39293849ccb2",
68
+ "name": "2019 Ownership Payment Data",
69
+ "description": "Program year 2019. Ownership and investment interests held by physicians or their immediate family",
70
+ "endpoint": "query",
71
+ "page": "https://openpaymentsdata.cms.gov/dataset/0b5c9710-7edb-484e-abc8-39293849ccb2"
72
+ },
73
+ "general_2020": {
74
+ "id": "a08c4b30-5cf3-4948-ad40-36f404619019",
75
+ "name": "2020 General Payment Data",
76
+ "description": "Program year 2020. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
77
+ "endpoint": "query",
78
+ "page": "https://openpaymentsdata.cms.gov/dataset/a08c4b30-5cf3-4948-ad40-36f404619019"
79
+ },
80
+ "research_2020": {
81
+ "id": "9c248e7e-7c7f-478b-ab84-ce0919d72c1c",
82
+ "name": "2020 Research Payment Data",
83
+ "description": "Program year 2020. Research payments: one row per payment, with study name, principal investigators, amount",
84
+ "endpoint": "query",
85
+ "page": "https://openpaymentsdata.cms.gov/dataset/9c248e7e-7c7f-478b-ab84-ce0919d72c1c"
86
+ },
87
+ "ownership_2020": {
88
+ "id": "a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2",
89
+ "name": "2020 Ownership Payment Data",
90
+ "description": "Program year 2020. Ownership and investment interests held by physicians or their immediate family",
91
+ "endpoint": "query",
92
+ "page": "https://openpaymentsdata.cms.gov/dataset/a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2"
93
+ },
94
+ "general_2021": {
95
+ "id": "0380bbeb-aea1-58b6-b708-829f92a48202",
96
+ "name": "2021 General Payment Data",
97
+ "description": "Program year 2021. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
98
+ "endpoint": "query",
99
+ "page": "https://openpaymentsdata.cms.gov/dataset/0380bbeb-aea1-58b6-b708-829f92a48202"
100
+ },
101
+ "research_2021": {
102
+ "id": "ce1d28dd-0094-5060-a036-580329439600",
103
+ "name": "2021 Research Payment Data",
104
+ "description": "Program year 2021. Research payments: one row per payment, with study name, principal investigators, amount",
105
+ "endpoint": "query",
106
+ "page": "https://openpaymentsdata.cms.gov/dataset/ce1d28dd-0094-5060-a036-580329439600"
107
+ },
108
+ "ownership_2021": {
109
+ "id": "b0c03b8d-06df-58f2-8ce2-4daeffee147e",
110
+ "name": "2021 Ownership Payment Data",
111
+ "description": "Program year 2021. Ownership and investment interests held by physicians or their immediate family",
112
+ "endpoint": "query",
113
+ "page": "https://openpaymentsdata.cms.gov/dataset/b0c03b8d-06df-58f2-8ce2-4daeffee147e"
114
+ },
115
+ "general_2022": {
116
+ "id": "df01c2f8-dc1f-4e79-96cb-8208beaf143c",
117
+ "name": "2022 General Payment Data",
118
+ "description": "Program year 2022. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
119
+ "endpoint": "query",
120
+ "page": "https://openpaymentsdata.cms.gov/dataset/df01c2f8-dc1f-4e79-96cb-8208beaf143c"
121
+ },
122
+ "research_2022": {
123
+ "id": "fdc3c773-018a-412c-8a81-d7b8a13a037b",
124
+ "name": "2022 Research Payment Data",
125
+ "description": "Program year 2022. Research payments: one row per payment, with study name, principal investigators, amount",
126
+ "endpoint": "query",
127
+ "page": "https://openpaymentsdata.cms.gov/dataset/fdc3c773-018a-412c-8a81-d7b8a13a037b"
128
+ },
129
+ "ownership_2022": {
130
+ "id": "37792388-800f-427a-9e02-b11601454eeb",
131
+ "name": "2022 Ownership Payment Data",
132
+ "description": "Program year 2022. Ownership and investment interests held by physicians or their immediate family",
133
+ "endpoint": "query",
134
+ "page": "https://openpaymentsdata.cms.gov/dataset/37792388-800f-427a-9e02-b11601454eeb"
135
+ },
136
+ "general_2023": {
137
+ "id": "fb3a65aa-c901-4a38-a813-b04b00dfa2a9",
138
+ "name": "2023 General Payment Data",
139
+ "description": "Program year 2023. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
140
+ "endpoint": "query",
141
+ "page": "https://openpaymentsdata.cms.gov/dataset/fb3a65aa-c901-4a38-a813-b04b00dfa2a9"
142
+ },
143
+ "research_2023": {
144
+ "id": "ec9521bf-9d97-4603-814c-f4132d34bc4f",
145
+ "name": "2023 Research Payment Data",
146
+ "description": "Program year 2023. Research payments: one row per payment, with study name, principal investigators, amount",
147
+ "endpoint": "query",
148
+ "page": "https://openpaymentsdata.cms.gov/dataset/ec9521bf-9d97-4603-814c-f4132d34bc4f"
149
+ },
150
+ "ownership_2023": {
151
+ "id": "ac0bc85c-02e3-45d9-89e8-2ff43da85df7",
152
+ "name": "2023 Ownership Payment Data",
153
+ "description": "Program year 2023. Ownership and investment interests held by physicians or their immediate family",
154
+ "endpoint": "query",
155
+ "page": "https://openpaymentsdata.cms.gov/dataset/ac0bc85c-02e3-45d9-89e8-2ff43da85df7"
156
+ },
157
+ "general_2024": {
158
+ "id": "e6b17c6a-2534-4207-a4a1-6746a14911ff",
159
+ "name": "2024 General Payment Data",
160
+ "description": "Program year 2024. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
161
+ "endpoint": "query",
162
+ "page": "https://openpaymentsdata.cms.gov/dataset/e6b17c6a-2534-4207-a4a1-6746a14911ff"
163
+ },
164
+ "research_2024": {
165
+ "id": "2f15cb85-8887-4dcc-a318-1f8ec1d815b3",
166
+ "name": "2024 Research Payment Data",
167
+ "description": "Program year 2024. Research payments: one row per payment, with study name, principal investigators, amount",
168
+ "endpoint": "query",
169
+ "page": "https://openpaymentsdata.cms.gov/dataset/2f15cb85-8887-4dcc-a318-1f8ec1d815b3"
170
+ },
171
+ "ownership_2024": {
172
+ "id": "9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02",
173
+ "name": "2024 Ownership Payment Data",
174
+ "description": "Program year 2024. Ownership and investment interests held by physicians or their immediate family",
175
+ "endpoint": "query",
176
+ "page": "https://openpaymentsdata.cms.gov/dataset/9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02"
177
+ },
178
+ "general_2025": {
179
+ "id": "fb0b1734-1410-429d-92f6-3f4b35218e5e",
180
+ "name": "2025 General Payment Data",
181
+ "description": "Program year 2025. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
182
+ "endpoint": "query",
183
+ "page": "https://openpaymentsdata.cms.gov/dataset/fb0b1734-1410-429d-92f6-3f4b35218e5e"
184
+ },
185
+ "research_2025": {
186
+ "id": "f0d1de67-6852-4093-a036-c9328c256a05",
187
+ "name": "2025 Research Payment Data",
188
+ "description": "Program year 2025. Research payments: one row per payment, with study name, principal investigators, amount",
189
+ "endpoint": "query",
190
+ "page": "https://openpaymentsdata.cms.gov/dataset/f0d1de67-6852-4093-a036-c9328c256a05"
191
+ },
192
+ "ownership_2025": {
193
+ "id": "800aed1b-20ed-4d19-b0c9-dcd10f197ffc",
194
+ "name": "2025 Ownership Payment Data",
195
+ "description": "Program year 2025. Ownership and investment interests held by physicians or their immediate family",
196
+ "endpoint": "query",
197
+ "page": "https://openpaymentsdata.cms.gov/dataset/800aed1b-20ed-4d19-b0c9-dcd10f197ffc"
198
+ },
199
+ "national_totals": {
200
+ "id": "aaaddc12-a3a7-4cc5-9c12-4a726317aa1c",
201
+ "name": "National level payment total and averages for all years",
202
+ "description": "National totals, counts and mean/median payments by program year, payment type and recipient type",
203
+ "endpoint": "query",
204
+ "page": "https://openpaymentsdata.cms.gov/dataset/aaaddc12-a3a7-4cc5-9c12-4a726317aa1c"
205
+ },
206
+ "national_by_specialty": {
207
+ "id": "04c3355f-955b-4620-b3a8-08020cc9c1f2",
208
+ "name": "National level payment total and averages by provider specialty for all years",
209
+ "description": "National totals and averages by provider specialty and program year",
210
+ "endpoint": "query",
211
+ "page": "https://openpaymentsdata.cms.gov/dataset/04c3355f-955b-4620-b3a8-08020cc9c1f2"
212
+ },
213
+ "state_totals": {
214
+ "id": "02157882-0f43-473a-a777-c96eb5b1b623",
215
+ "name": "State level payment total and averages for all years",
216
+ "description": "State totals, counts, mean and median payments by program year, payment type and recipient type",
217
+ "endpoint": "query",
218
+ "page": "https://openpaymentsdata.cms.gov/dataset/02157882-0f43-473a-a777-c96eb5b1b623"
219
+ },
220
+ "state_by_nature": {
221
+ "id": "7c5144d9-1b2a-5039-a91a-cccb8ed7805c",
222
+ "name": "State payment totals and averages grouped by Nature of Payment for all years",
223
+ "description": "State totals by nature of payment (food, consulting, royalty...) and program year",
224
+ "endpoint": "query",
225
+ "page": "https://openpaymentsdata.cms.gov/dataset/7c5144d9-1b2a-5039-a91a-cccb8ed7805c"
226
+ },
227
+ "by_reporting_entity": {
228
+ "id": "d5762bed-26ca-4035-91c9-9d67297dc77c",
229
+ "name": "Payments grouped by reporting entities",
230
+ "description": "Totals by company (applicable manufacturer or GPO) and program year",
231
+ "endpoint": "query",
232
+ "page": "https://openpaymentsdata.cms.gov/dataset/d5762bed-26ca-4035-91c9-9d67297dc77c"
233
+ },
234
+ "by_entity_and_nature": {
235
+ "id": "61efcbef-b01d-47c5-a996-b6f09613f856",
236
+ "name": "Payments grouped by reporting entities and nature of payments for all years",
237
+ "description": "Totals by company, nature of payment and program year",
238
+ "endpoint": "query",
239
+ "page": "https://openpaymentsdata.cms.gov/dataset/61efcbef-b01d-47c5-a996-b6f09613f856"
240
+ },
241
+ "by_recipient_and_entity": {
242
+ "id": "e49defac-4013-408d-b36f-665fc0ad51b2",
243
+ "name": "Payments grouped by covered recipient and reporting entities for all years",
244
+ "description": "Totals by recipient and company, all program years",
245
+ "endpoint": "query",
246
+ "page": "https://openpaymentsdata.cms.gov/dataset/e49defac-4013-408d-b36f-665fc0ad51b2"
247
+ },
248
+ "by_recipient_and_nature": {
249
+ "id": "8d4d1fa0-9419-4993-97ff-9134c95c27a9",
250
+ "name": "Payments grouped by covered recipient and nature of payments for all years",
251
+ "description": "Totals by recipient and nature of payment, all program years",
252
+ "endpoint": "query",
253
+ "page": "https://openpaymentsdata.cms.gov/dataset/8d4d1fa0-9419-4993-97ff-9134c95c27a9"
254
+ },
255
+ "by_physician": {
256
+ "id": "895260f5-1ce9-4e7d-9cb2-90564322eed2",
257
+ "name": "Payments grouped by physician (distinct) for all years",
258
+ "description": "Totals per physician, all program years",
259
+ "endpoint": "query",
260
+ "page": "https://openpaymentsdata.cms.gov/dataset/895260f5-1ce9-4e7d-9cb2-90564322eed2"
261
+ },
262
+ "by_teaching_hospital": {
263
+ "id": "217ad1a7-b659-41f6-8159-c41b73f47de4",
264
+ "name": "Payments grouped by Teaching Hospital",
265
+ "description": "Totals per teaching hospital",
266
+ "endpoint": "query",
267
+ "page": "https://openpaymentsdata.cms.gov/dataset/217ad1a7-b659-41f6-8159-c41b73f47de4"
268
+ },
269
+ "summary_dashboard": {
270
+ "id": "e0d225fc-8230-401d-8fad-e2262fb22b4c",
271
+ "name": "Summary Dashboard - all years",
272
+ "description": "Headline totals shown on the Open Payments summary dashboard",
273
+ "endpoint": "query",
274
+ "page": "https://openpaymentsdata.cms.gov/dataset/e0d225fc-8230-401d-8fad-e2262fb22b4c"
275
+ },
276
+ "recipient_profiles": {
277
+ "id": "23160558-6742-54ff-8b9f-cac7d514ff4e",
278
+ "name": "Covered Recipient Profile Supplement",
279
+ "description": "Covered recipient profiles: profile id, NPI, name, specialty, address",
280
+ "endpoint": "query",
281
+ "page": "https://openpaymentsdata.cms.gov/dataset/23160558-6742-54ff-8b9f-cac7d514ff4e"
282
+ },
283
+ "entity_profiles": {
284
+ "id": "1cf0c6c0-c377-466e-b78f-037b442559f8",
285
+ "name": "Reporting entity profile information",
286
+ "description": "Reporting entity (company) profiles",
287
+ "endpoint": "query",
288
+ "page": "https://openpaymentsdata.cms.gov/dataset/1cf0c6c0-c377-466e-b78f-037b442559f8"
289
+ },
290
+ "teaching_hospital_profiles": {
291
+ "id": "8219fcb3-fb3d-4b51-9f65-be8a048c0608",
292
+ "name": "Teaching Hospital profile information",
293
+ "description": "Teaching hospital profiles: CCN, name, address",
294
+ "endpoint": "query",
295
+ "page": "https://openpaymentsdata.cms.gov/dataset/8219fcb3-fb3d-4b51-9f65-be8a048c0608"
296
+ }
297
+ }
298
+ }
@@ -0,0 +1,101 @@
1
+ {
2
+ "id": "open-payments",
3
+ "title": "CMS Open Payments (openpaymentsdata.cms.gov)",
4
+ "agency": "Centers for Medicare & Medicaid Services",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "health",
8
+ "health care",
9
+ "industry payments"
10
+ ],
11
+ "keywords": [
12
+ "open payments",
13
+ "sunshine act",
14
+ "industry payments",
15
+ "pharma payments",
16
+ "payments to doctors",
17
+ "physician payments",
18
+ "drug company",
19
+ "device company",
20
+ "manufacturer",
21
+ "consulting fee",
22
+ "speaking fee",
23
+ "food and beverage",
24
+ "royalty",
25
+ "research payments",
26
+ "ownership interest",
27
+ "teaching hospital",
28
+ "npi"
29
+ ],
30
+ "questions": [
31
+ "payments from drug and device companies to doctors in a state",
32
+ "which companies paid the most to physicians",
33
+ "payments to a specific physician by NPI",
34
+ "industry payments by specialty",
35
+ "research payments to teaching hospitals"
36
+ ],
37
+ "homepage": "https://openpaymentsdata.cms.gov/",
38
+ "terms_url": "https://www.usa.gov/government-works",
39
+ "auth": {
40
+ "env": null,
41
+ "required": "none",
42
+ "placement": "none",
43
+ "signup_url": null,
44
+ "echoes_key": false
45
+ },
46
+ "limits": {
47
+ "rps": 2,
48
+ "burst": 4,
49
+ "max_rows": 100000
50
+ },
51
+ "routes": {
52
+ "api": {
53
+ "base": "https://openpaymentsdata.cms.gov/api/1",
54
+ "probe": "https://openpaymentsdata.cms.gov/api/1/metastore/schemas/dataset/items/02157882-0f43-473a-a777-c96eb5b1b623",
55
+ "hosts": [
56
+ "openpaymentsdata.cms.gov"
57
+ ]
58
+ },
59
+ "manual": {
60
+ "how": "Open the JSON links in INSTRUCTIONS.md (filters applied, 500 rows a page), save each under the shown name and upload; or search https://openpaymentsdata.cms.gov/ (Search > by physician, hospital or company) and export the results. Full-year payment files are several GB: download them from the dataset page only on a computer with room, then upload a filtered extract."
61
+ }
62
+ },
63
+ "cache": {
64
+ "mode": "run_only",
65
+ "ttl_hours": null,
66
+ "why": "Filtered queries are small; every dataset is republished when CMS refreshes the program years (all were last modified 2026-06-30). data/ is reused within a run."
67
+ },
68
+ "redistribution": {
69
+ "mode": "allowed",
70
+ "why": "Open Payments datasets carry the licence https://www.usa.gov/government-works (U.S. government work, public domain, 17 U.S.C. 105) in the CMS metastore."
71
+ },
72
+ "notices": [
73
+ "Open Payments records are reported by manufacturers and group purchasing organizations and published as reported (recipients may dispute them); a payment does not by itself indicate a conflict of interest or wrongdoing."
74
+ ],
75
+ "retention": null,
76
+ "citation": "Centers for Medicare & Medicaid Services, Open Payments: {dataset}, openpaymentsdata.cms.gov, retrieved {retrieved_long}.",
77
+ "audit_hooks": [
78
+ {
79
+ "id": "op_not_wrongdoing",
80
+ "kind": "require_text",
81
+ "any": [
82
+ "not verified",
83
+ "does not indicate",
84
+ "not necessarily",
85
+ "conflict of interest",
86
+ "wrongdoing",
87
+ "reported by"
88
+ ],
89
+ "why": "Reports using Open Payments must say that payments are self-reported by industry and do not imply wrongdoing."
90
+ }
91
+ ],
92
+ "clarify": [
93
+ "Which program year(s)? Each year is a separate file; the latest published year is 2025 (published June 2026).",
94
+ "General payments only, or also research payments and ownership interests? They are separate datasets and are not additive with the summaries.",
95
+ "Physicians only, or also nurse practitioners and other non-physician practitioners (reported since program year 2021) and teaching hospitals?"
96
+ ],
97
+ "formats": [
98
+ "json",
99
+ "csv"
100
+ ]
101
+ }
@@ -0,0 +1,99 @@
1
+ # CMS Open Payments (openpaymentsdata.cms.gov)
2
+ Depth: standard. Key: none. Payments and other transfers of value from drug and device manufacturers and
3
+ group purchasing organizations to physicians, non-physician practitioners and teaching hospitals
4
+ (the Sunshine Act data), program years 2019-2025, plus CMS's summary tables.
5
+
6
+ ## When to use
7
+ - Payments to a named physician (NPI), hospital, or the recipients in a state or city; payments by a
8
+ company; totals by state, specialty, company or nature of payment (food, consulting, royalties).
9
+ - Research payments and physician ownership or investment interests (separate datasets).
10
+ - Not here: Medicare payments to providers for care (cms), drug approvals, recalls and adverse events (fda),
11
+ clinical trials (clinical-trials), NIH grants (nih), lobbying (senate-lobbying). Program years before 2019
12
+ are not in this API (CMS archives them on its website).
13
+
14
+ ## Endpoints and datasets
15
+ | Endpoint | Returns | Parameters |
16
+ |---|---|---|
17
+ | `query` | rows of one dataset (500 a page) | `dataset` (alias or UUID), `where`, `conditions`, `sort`, `columns` |
18
+
19
+ Catalog aliases (35, with ids; `request_schema` with `search: "teaching hospital"` searches them and the live
20
+ metastore of 74 datasets):
21
+ - Payment-level files, one per program year 2019-2025: `general_<year>`, `research_<year>`,
22
+ `ownership_<year>` (e.g. `general_2024`; about 91 columns; millions of rows a year, so a filter is
23
+ required).
24
+ - Summaries (all years, a `program_year` column, plus `program_year` "ALL" rollup rows in some, e.g.
25
+ `state_totals`: filter one year and never sum across ALL, verified 2026-10): `national_totals`, `national_by_specialty`,
26
+ `state_totals`, `state_by_nature`, `by_reporting_entity`, `by_entity_and_nature`,
27
+ `by_recipient_and_entity`, `by_recipient_and_nature`, `by_physician`, `by_teaching_hospital`,
28
+ `summary_dashboard`; profiles: `recipient_profiles`, `entity_profiles`, `teaching_hospital_profiles`.
29
+
30
+ Useful payment-file columns: `covered_recipient_npi`, `covered_recipient_profile_id`,
31
+ `covered_recipient_type`, `covered_recipient_specialty_1`, `recipient_state`, `recipient_city`,
32
+ `applicable_manufacturer_or_applicable_gpo_making_payment_name` (the payer),
33
+ `submitting_applicable_manufacturer_or_applicable_gpo_name` (the filer, can differ),
34
+ `total_amount_of_payment_usdollars`, `date_of_payment`, `nature_of_payment_or_transfer_of_value`,
35
+ `form_of_payment_or_transfer_of_value`, `name_of_drug_or_biological_or_device_or_medical_supply_1`,
36
+ `dispute_status_for_publication`, `change_type`, `program_year`, `record_id`.
37
+
38
+ Filters: `where` `{"recipient_state": "VT"}` (equality; a list value means IN); `conditions`
39
+ `[{"property": ..., "value": "%pfizer%", "operator": "LIKE"}]` with `= <> < <= > >= LIKE IN "NOT IN"
40
+ BETWEEN CONTAINS "STARTS WITH"` (the last two from the host's OpenAPI at /api/1; verified 2026-10). LIKE is case-insensitive (verified); company names vary ("PFIZER INC.", "Pfizer Laboratories"),
41
+ so match with `%name%` and check the distinct names returned.
42
+
43
+ ## Spec examples
44
+ ```json
45
+ {"description": "Industry payments in Vermont by recipient type and payment type, 2024",
46
+ "requests": [{"name": "vt_totals_2024", "endpoint": "query",
47
+ "params": {"dataset": "state_totals", "where": {"state_code": "VT", "program_year": "2024"}}}]}
48
+ ```
49
+ ```json
50
+ {"description": "Pfizer general payments to Vermont recipients, 2024",
51
+ "requests": [{"name": "vt_pfizer_2024", "endpoint": "query",
52
+ "params": {"dataset": "general_2024", "where": {"recipient_state": "VT"},
53
+ "conditions": [{"property": "applicable_manufacturer_or_applicable_gpo_making_payment_name",
54
+ "value": "%pfizer%", "operator": "LIKE"}],
55
+ "columns": ["record_id", "covered_recipient_type", "recipient_city", "total_amount_of_payment_usdollars",
56
+ "date_of_payment", "nature_of_payment_or_transfer_of_value"]}}]}
57
+ ```
58
+ ```json
59
+ {"description": "All general payments to one physician, 2023 and 2024",
60
+ "requests": [{"name": "npi_2023", "endpoint": "query", "params": {"dataset": "general_2023", "where": {"covered_recipient_npi": "1234567890"}}, "allow_empty": true},
61
+ {"name": "npi_2024", "endpoint": "query", "params": {"dataset": "general_2024", "where": {"covered_recipient_npi": "1234567890"}}, "allow_empty": true}]}
62
+ ```
63
+ (1234567890 is a placeholder that matches nothing; replace it with the real NPI, looked up in
64
+ `recipient_profiles` by name and state, and drop `allow_empty` so a wrong NPI fails loudly.)
65
+
66
+ ## Data format and traps
67
+ - Every column is stored and returned as text, amounts included (`"16.38"`), and dates are MM/DD/YYYY
68
+ text. So `sort` and `<`, `>`, `BETWEEN` compare characters: sorting amounts descending returns
69
+ "995.27", "99.99", ... and `> 900` matches "91.06" (both verified). The pack refuses such comparisons
70
+ (override with `"text_compare_ok": true`); filter by equality and rank or sum with `compute`.
71
+ - A program year is the year of payment; files for a year are published the following June 30 and
72
+ republished when CMS refreshes the data (all datasets were last modified 2026-06-30). Totals for recent
73
+ years can change after a refresh: report the retrieval date.
74
+ - Records are self-reported by the paying companies. Recipients may dispute them
75
+ (`dispute_status_for_publication`); some are delayed for product development
76
+ (`delay_in_publication_indicator`). A payment does not imply wrongdoing or a conflict of interest; say so.
77
+ - `number_of_payments_included_in_total_amount` > 1 means one row bundles several payments; count rows
78
+ as records, not as individual payments, unless you use that column.
79
+ - Non-physician practitioners (nurse practitioners, physician assistants, etc.) are covered recipients from
80
+ program year 2021; physician-only trends must filter `covered_recipient_type`.
81
+ - The research and ownership files are not part of general-payment totals; summary tables split amounts by
82
+ `payment_type` (General, Research) and recipient type. Do not add summary rows across both splits.
83
+ - Names are upper-case in payment files; city and company spellings vary. Prefer NPI or
84
+ `covered_recipient_profile_id` to identify a person.
85
+ - `limit` is capped at 500 by this API (verified); the pack pages. Queries on the payment files take 2-5 s
86
+ a page; sort makes them slower.
87
+ - Old dataset ids stop working when CMS republishes; summaries are addressed by alias here.
88
+
89
+ ## Access
90
+ No key. `fetch` works when openpaymentsdata.cms.gov answers (the host sits behind a bot filter that has
91
+ refused some user agents with HTTP 403; the pack's client is accepted). Manual: `manual_bundle`'s INSTRUCTIONS.md
92
+ lists JSON links with the filters applied (500 rows each; save under the shown names, upload, then `ingest`), or use the
93
+ site's search (by physician, hospital or company) and its export, then upload the file.
94
+
95
+ ## Citation and terms
96
+ "Centers for Medicare & Medicaid Services, Open Payments: <dataset>, openpaymentsdata.cms.gov, retrieved
97
+ <date>." The datasets carry the licence https://www.usa.gov/government-works (public domain);
98
+ redistribution allowed. Reports must state that the records are reported by industry, published as
99
+ reported, and do not by themselves indicate wrongdoing (policy notice and audit hook).