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,117 @@
1
+ # openFDA (api.fda.gov)
2
+ Depth: standard. Key: optional (DATA_GOV_API_KEY). FDA's open data: drug, device, food, animal and tobacco
3
+ adverse event reports; drug, device and food recalls; drug labels, NDC directory, Drugs@FDA approvals,
4
+ drug shortages; device 510(k), PMA, classification, UDI; substances and UNII.
5
+
6
+ ## When to use
7
+ - What is reported about a product: top adverse reactions for a drug, device malfunction reports over
8
+ time, supplement adverse events (CAERS), tobacco problem reports.
9
+ - Recalls (enforcement reports) by class, firm, state, reason and date; drug shortages; label text
10
+ (boxed warnings, indications); approvals and application history; device clearances.
11
+ - Not here: incidence or risk of side effects (no denominators: use trials or studies), clinical trials
12
+ (clinical-trials), Medicare drug spending (cms), payments to doctors (open-payments), deaths by cause
13
+ (cdc), nutrition facts (usda-fooddata).
14
+
15
+ ## Endpoints and datasets
16
+ | Endpoint | Returns | Parameters |
17
+ |---|---|---|
18
+ | `search` | records (1,000 a page, at most 26,000) | `dataset`, `search`, `sort` |
19
+ | `count` | `term,count` rows (top 1,000; 999 without a key) or `time,count` for a date field | `dataset`, `search`, `count`, `limit` |
20
+
21
+ `dataset` aliases (24 in the catalog, found with a `request_schema` search; the path form `drug/event` works too): `drug_event`
22
+ (FAERS), `drug_label`, `drug_ndc`, `drug_enforcement`, `drugsfda`, `drug_shortages`, `device_event`
23
+ (MAUDE), `device_510k`, `device_classification`, `device_enforcement`, `device_recall`, `device_pma`,
24
+ `device_registration`, `device_udi`, `food_enforcement`, `food_event` (CAERS), `animal_event`,
25
+ `tobacco_problem`, `nsde`, `substance`, `unii`, `crl` (complete response letters),
26
+ `historical_document`, `device_covid19serology` (archived).
27
+
28
+ Search syntax (Lucene-like; the pack URL-encodes it): `field:value`, `field:"exact phrase"`,
29
+ `receivedate:[20240101 TO 20241231]`, `AND` / `OR` / `NOT`, `_exists_:field`, `_missing_:field`. Use
30
+ `.exact` for whole phrases in `count` and exact matches (`patient.drug.openfda.generic_name.exact:"METFORMIN
31
+ HYDROCHLORIDE"`); without `.exact`, counts split phrases into words.
32
+
33
+ Common count fields: drug_event `patient.reaction.reactionmeddrapt.exact`,
34
+ `patient.drug.openfda.brand_name.exact`, `serious`, `receivedate`; enforcement `classification.exact`,
35
+ `status.exact`, `state.exact`, `report_date`; device_event `event_type.exact`,
36
+ `device.generic_name.exact`; drug_ndc `pharm_class.exact`, `dea_schedule`; drug_shortages `status` and
37
+ `therapeutic_category` (their `.exact` variants answer 404 "Nothing to count"; verified 2026-10-22).
38
+
39
+ ## Spec examples
40
+ ```json
41
+ {"description": "Metformin adverse-event reports received in 2024: top 10 reactions",
42
+ "requests": [{"name": "metformin_reactions_2024", "endpoint": "count",
43
+ "params": {"dataset": "drug_event",
44
+ "search": "patient.drug.openfda.generic_name.exact:\"METFORMIN HYDROCHLORIDE\" AND receivedate:[20240101 TO 20241231]",
45
+ "count": "patient.reaction.reactionmeddrapt.exact", "limit": 10}}]}
46
+ ```
47
+ ```json
48
+ {"description": "Class I food recalls reported in 2024",
49
+ "requests": [{"name": "food_recalls_class1_2024", "endpoint": "search",
50
+ "params": {"dataset": "food_enforcement", "search": "classification:\"Class I\" AND report_date:[20240101 TO 20241231]",
51
+ "sort": "report_date:asc"}}]}
52
+ ```
53
+ ```json
54
+ {"description": "Drug recall enforcement reports by report date, 2023-2024",
55
+ "requests": [{"name": "drug_recalls_daily", "endpoint": "count",
56
+ "params": {"dataset": "drug_enforcement", "search": "report_date:[20230101 TO 20241231]", "count": "report_date"}}]}
57
+ ```
58
+ A date-field count gives one row per date that has records (`time` = YYYYMMDD; enforcement reports
59
+ are published weekly, so 104 dates for 2023-2024); dates with no records are absent. Aggregate to months
60
+ or years in analysis.
61
+
62
+ ## Data format and traps
63
+ - Adverse event reports (FAERS, MAUDE, CAERS, animal, tobacco) are voluntary, unverified reports. A
64
+ report does not show the product caused the event; counts reflect reporting (publicity, litigation,
65
+ market size) as much as harm, and they are not incidence or risk rates. Say so in every use.
66
+ - A FAERS report lists every drug the patient took (`patient.drug[].drugcharacterization`: 1 suspect,
67
+ 2 concomitant, 3 interacting) and several reactions. Searching a drug name matches reports where it
68
+ was only concomitant; a `count` on reactions counts reports containing each term, so terms overlap.
69
+ - `count` returns at most 1,000 terms (the API refuses more), sorted by count: the tail is cut off. Without
70
+ a key, `limit=1000` answers HTTP 403 API_KEY_MISSING on some datasets (drug_event, device_event) while 999
71
+ works, so keyless counts are sent with at most 999 (verified 2026-10-22). When the list is as long as
72
+ the limit the pack says "stopped at N terms" (status partial). A date-field count ignores `limit` and
73
+ returns every date.
74
+ - A count on a field that the dataset cannot count answers HTTP 404 "Nothing to count"; the pack reports
75
+ openFDA's message (it is not a "no match"): fix the field name or drop or add `.exact`.
76
+ - `search` pages with `limit` (at most 1,000) and `skip` (at most 25,000), so one request yields at most
77
+ 26,000 records (verified); split larger pulls by date range, or use the bulk downloads.
78
+ - A search that matches nothing is HTTP 404 "No matches found" in openFDA; the pack reports it as an
79
+ error naming the search (set `"allow_empty": true` to keep an empty table).
80
+ - Dates are text `YYYYMMDD` (`report_date`, `receivedate`, `recall_initiation_date`). Recall
81
+ `report_date` is when FDA published the enforcement report, often weeks after initiation.
82
+ - Two device recall datasets with different fields. `device_enforcement` (enforcement reports, like drug and
83
+ food) has `report_date`, `recall_initiation_date`, `classification` and `recall_number`.
84
+ `device_recall` (FDA's recall database, one row per product recall) has no `report_date` or class: its
85
+ dates are `event_date_initiated`, `event_date_posted` (when FDA posted it) and `event_date_terminated`
86
+ (`YYYY-MM-DD`; a range search takes `event_date_posted:[20250101 TO 20251231]`), the firm is
87
+ `recalling_firm` (word match: `recalling_firm:acme`), and it adds `root_cause_description`,
88
+ `recall_status`, `product_res_number`, `res_event_number` (one event spans several product recalls: count
89
+ events, not rows, for "how many recalls") and `product_code` (verified 2026-10-28).
90
+ - Exception: drug_shortages dates (`initial_posting_date`, `update_date`, `discontinued_date`) are
91
+ `MM/DD/YYYY` text. A range search on them needs ISO dates (`initial_posting_date:[2020-01-01 TO
92
+ 2020-12-31]`); the `[20200101 TO 20201231]` form finds nothing (verified 2026-10-22). Sorting and date
93
+ counts on them work (count `time` comes back as YYYYMMDD). Convert before comparing with other datasets.
94
+ - Enforcement reports (drug, device and food recalls) start on 2012-06-20 (`sort=report_date:asc`, verified
95
+ 2026-10-22); earlier recalls are not in the API. Say so for questions about recalls before mid-2012.
96
+ - Nested records: lists of objects become JSON text columns (`patient.drug`, `products`, `openfda.*`
97
+ lists joined by "; "). Use `count` for tallies instead of parsing them where possible.
98
+ - `serious` is 1 (serious) or 2 (not serious); `patient.patientsex` 0 unknown, 1 male, 2 female.
99
+ - Freshness differs by dataset; report `meta.last_updated`. On 2026-10-20 FAERS was last updated
100
+ 2026-07-30 (quarterly releases), recalls, MAUDE, labels, NDC and shortages within the previous two weeks,
101
+ and `device_covid19serology` in 2022 (archived).
102
+ - The `openfda` annotation block (brand, generic name, manufacturer) is missing on many records,
103
+ especially older ones; a search on `openfda.*` fields misses those records.
104
+
105
+ ## Access
106
+ Key optional: `DATA_GOV_API_KEY` (an api.data.gov key; sign up at https://open.fda.gov/apis/authentication/),
107
+ sent as `api_key`. That page says a key is required to call the API, but keyless calls work (verified
108
+ 2026-10-22), within the lower limits below and the 999-term count limit. Without a key openFDA allows
109
+ 240 requests a minute and 1,000 a day per IP; with one, 120,000 a day (openFDA documentation). `fetch` works either way. Manual route (`manual_bundle`): INSTRUCTIONS.md lists the
110
+ query URLs (JSON, no key needed; one per 1,000 records); open, save under the shown name, upload. Whole
111
+ datasets: https://open.fda.gov/data/downloads/ (zipped JSON).
112
+
113
+ ## Citation and terms
114
+ "U.S. Food and Drug Administration, openFDA: <dataset>, api.fda.gov, retrieved <date>." Public domain,
115
+ CC0 1.0 (https://open.fda.gov/license/); redistribution allowed. Reports must carry the notice that the
116
+ data are not validated for clinical use and that adverse event counts are not rates (policy notice and
117
+ audit hook).
@@ -0,0 +1,417 @@
1
+ {
2
+ "base_url": "https://api.fdic.gov/banks",
3
+ "endpoints": {
4
+ "institutions": {
5
+ "path": "/institutions",
6
+ "method": "GET",
7
+ "description": "Institutions (open and closed): name, location, charter, regulator, latest assets/deposits. One row per institution (CERT).",
8
+ "params": {
9
+ "filters": {
10
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
11
+ },
12
+ "fields": {
13
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
14
+ },
15
+ "sort_by": {
16
+ "desc": "field to sort on"
17
+ },
18
+ "sort_order": {
19
+ "desc": "ASC or DESC",
20
+ "enum": [
21
+ "ASC",
22
+ "DESC"
23
+ ]
24
+ },
25
+ "search": {
26
+ "desc": "flexible text search, e.g. NAME:Wells"
27
+ }
28
+ },
29
+ "defaults": {
30
+ "sort_by": "ASSET",
31
+ "sort_order": "DESC"
32
+ },
33
+ "records": "data",
34
+ "total": "meta.total",
35
+ "paging": {
36
+ "type": "offset",
37
+ "limit_param": "limit",
38
+ "offset_param": "offset",
39
+ "size": 1000
40
+ },
41
+ "max_rows": 100000,
42
+ "missing": [
43
+ ""
44
+ ],
45
+ "flatten": true
46
+ },
47
+ "failures": {
48
+ "path": "/failures",
49
+ "method": "GET",
50
+ "description": "Every FDIC-insured institution failure since 1934: NAME, CERT, FAILDATE, FAILYR, COST (estimated loss to the Deposit Insurance Fund), QBFASSET, QBFDEP, RESTYPE, RESTYPE1, SAVR, PSTALP.",
51
+ "params": {
52
+ "filters": {
53
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
54
+ },
55
+ "fields": {
56
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
57
+ },
58
+ "sort_by": {
59
+ "desc": "field to sort on"
60
+ },
61
+ "sort_order": {
62
+ "desc": "ASC or DESC",
63
+ "enum": [
64
+ "ASC",
65
+ "DESC"
66
+ ]
67
+ },
68
+ "agg_by": {
69
+ "desc": "field to aggregate by, e.g. FAILYR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
70
+ },
71
+ "agg_sum_fields": {
72
+ "desc": "fields to sum per bucket, e.g. QBFASSET,QBFDEP,COST"
73
+ },
74
+ "agg_term_fields": {
75
+ "desc": "fields whose values are counted per bucket, e.g. RESTYPE"
76
+ },
77
+ "agg_limit": {
78
+ "desc": "number of aggregation buckets"
79
+ }
80
+ },
81
+ "defaults": {
82
+ "sort_by": "FAILDATE",
83
+ "sort_order": "DESC"
84
+ },
85
+ "records": "data",
86
+ "total": "meta.total",
87
+ "paging": {
88
+ "type": "offset",
89
+ "limit_param": "limit",
90
+ "offset_param": "offset",
91
+ "size": 1000
92
+ },
93
+ "max_rows": 100000,
94
+ "missing": [
95
+ ""
96
+ ],
97
+ "flatten": true
98
+ },
99
+ "financials": {
100
+ "path": "/financials",
101
+ "method": "GET",
102
+ "description": "Quarterly Call Report financials per institution (CERT, REPDTE YYYYMMDD) from 1984: ASSET, DEP, NETINC, ROA, ROE, LNLSNET, INTINC, EINTEXP, NONII, ... (over 1,000 fields).",
103
+ "params": {
104
+ "filters": {
105
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
106
+ },
107
+ "fields": {
108
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
109
+ },
110
+ "sort_by": {
111
+ "desc": "field to sort on"
112
+ },
113
+ "sort_order": {
114
+ "desc": "ASC or DESC",
115
+ "enum": [
116
+ "ASC",
117
+ "DESC"
118
+ ]
119
+ },
120
+ "agg_by": {
121
+ "desc": "field to aggregate by, e.g. STALP: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
122
+ },
123
+ "agg_sum_fields": {
124
+ "desc": "fields to sum per bucket, e.g. ASSET,DEP"
125
+ },
126
+ "agg_term_fields": {
127
+ "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
128
+ },
129
+ "agg_limit": {
130
+ "desc": "number of aggregation buckets"
131
+ }
132
+ },
133
+ "defaults": {
134
+ "sort_by": "REPDTE",
135
+ "sort_order": "DESC"
136
+ },
137
+ "records": "data",
138
+ "total": "meta.total",
139
+ "paging": {
140
+ "type": "offset",
141
+ "limit_param": "limit",
142
+ "offset_param": "offset",
143
+ "size": 1000
144
+ },
145
+ "max_rows": 100000,
146
+ "missing": [
147
+ ""
148
+ ],
149
+ "flatten": true
150
+ },
151
+ "summary": {
152
+ "path": "/summary",
153
+ "method": "GET",
154
+ "description": "Annual aggregates by state (STNAME) and charter group (CB_SI: CB commercial banks, SI savings institutions) since 1934: BANKS, ASSET, DEP, NETINC, ... Includes aggregate rows 'All States and Territories', 'U.S. States and DC', 'U.S. Territories'.",
155
+ "params": {
156
+ "filters": {
157
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
158
+ },
159
+ "fields": {
160
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
161
+ },
162
+ "sort_by": {
163
+ "desc": "field to sort on"
164
+ },
165
+ "sort_order": {
166
+ "desc": "ASC or DESC",
167
+ "enum": [
168
+ "ASC",
169
+ "DESC"
170
+ ]
171
+ },
172
+ "agg_by": {
173
+ "desc": "field to aggregate by, e.g. YEAR"
174
+ },
175
+ "agg_sum_fields": {
176
+ "desc": "fields to sum, e.g. ASSET,DEP"
177
+ },
178
+ "agg_term_fields": {
179
+ "desc": "fields to count terms of"
180
+ },
181
+ "agg_limit": {
182
+ "desc": "number of aggregation buckets"
183
+ }
184
+ },
185
+ "defaults": {
186
+ "sort_by": "YEAR",
187
+ "sort_order": "DESC"
188
+ },
189
+ "records": "data",
190
+ "total": "meta.total",
191
+ "paging": {
192
+ "type": "offset",
193
+ "limit_param": "limit",
194
+ "offset_param": "offset",
195
+ "size": 1000
196
+ },
197
+ "max_rows": 100000,
198
+ "missing": [
199
+ ""
200
+ ],
201
+ "flatten": true
202
+ },
203
+ "sod": {
204
+ "path": "/sod",
205
+ "method": "GET",
206
+ "description": "Summary of Deposits: one row per branch per year (as of June 30, 1994-): CERT, NAMEFULL, BRNUM, CITYBR, STALPBR, CNTYNAMB, DEPSUMBR (branch deposits), YEAR.",
207
+ "params": {
208
+ "filters": {
209
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
210
+ },
211
+ "fields": {
212
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
213
+ },
214
+ "sort_by": {
215
+ "desc": "field to sort on"
216
+ },
217
+ "sort_order": {
218
+ "desc": "ASC or DESC",
219
+ "enum": [
220
+ "ASC",
221
+ "DESC"
222
+ ]
223
+ },
224
+ "agg_by": {
225
+ "desc": "field to aggregate by, e.g. STALPBR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
226
+ },
227
+ "agg_sum_fields": {
228
+ "desc": "fields to sum per bucket, e.g. DEPSUMBR"
229
+ },
230
+ "agg_term_fields": {
231
+ "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
232
+ },
233
+ "agg_limit": {
234
+ "desc": "number of aggregation buckets"
235
+ }
236
+ },
237
+ "defaults": {
238
+ "sort_by": "DEPSUMBR",
239
+ "sort_order": "DESC"
240
+ },
241
+ "records": "data",
242
+ "total": "meta.total",
243
+ "paging": {
244
+ "type": "offset",
245
+ "limit_param": "limit",
246
+ "offset_param": "offset",
247
+ "size": 1000
248
+ },
249
+ "max_rows": 100000,
250
+ "missing": [
251
+ ""
252
+ ],
253
+ "flatten": true
254
+ },
255
+ "history": {
256
+ "path": "/history",
257
+ "method": "GET",
258
+ "description": "Structure change events: mergers, failures, name and charter changes, branch openings and closings (CERT, EFFDATE, CHANGECODE, CHANGECODE_DESC, INSTNAME).",
259
+ "params": {
260
+ "filters": {
261
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
262
+ },
263
+ "fields": {
264
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
265
+ },
266
+ "sort_by": {
267
+ "desc": "field to sort on"
268
+ },
269
+ "sort_order": {
270
+ "desc": "ASC or DESC",
271
+ "enum": [
272
+ "ASC",
273
+ "DESC"
274
+ ]
275
+ },
276
+ "search": {
277
+ "desc": "flexible text search"
278
+ },
279
+ "agg_by": {
280
+ "desc": "field to aggregate by, e.g. CHANGECODE: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
281
+ },
282
+ "agg_sum_fields": {
283
+ "desc": "fields to sum per bucket (numeric fields)"
284
+ },
285
+ "agg_term_fields": {
286
+ "desc": "fields whose values are counted per bucket, e.g. CLASS"
287
+ },
288
+ "agg_limit": {
289
+ "desc": "number of aggregation buckets"
290
+ }
291
+ },
292
+ "defaults": {
293
+ "sort_by": "EFFDATE",
294
+ "sort_order": "DESC"
295
+ },
296
+ "records": "data",
297
+ "total": "meta.total",
298
+ "paging": {
299
+ "type": "offset",
300
+ "limit_param": "limit",
301
+ "offset_param": "offset",
302
+ "size": 1000
303
+ },
304
+ "max_rows": 100000,
305
+ "missing": [
306
+ ""
307
+ ],
308
+ "flatten": true
309
+ },
310
+ "locations": {
311
+ "path": "/locations",
312
+ "method": "GET",
313
+ "description": "Branch and office locations of institutions (CERT, NAME, OFFNAME, ADDRESS, CITY, STALP, ZIP, COUNTY, LATITUDE, LONGITUDE, SERVTYPE).",
314
+ "params": {
315
+ "filters": {
316
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
317
+ },
318
+ "fields": {
319
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
320
+ },
321
+ "sort_by": {
322
+ "desc": "field to sort on"
323
+ },
324
+ "sort_order": {
325
+ "desc": "ASC or DESC",
326
+ "enum": [
327
+ "ASC",
328
+ "DESC"
329
+ ]
330
+ }
331
+ },
332
+ "defaults": {},
333
+ "records": "data",
334
+ "total": "meta.total",
335
+ "paging": {
336
+ "type": "offset",
337
+ "limit_param": "limit",
338
+ "offset_param": "offset",
339
+ "size": 1000
340
+ },
341
+ "max_rows": 100000,
342
+ "missing": [
343
+ ""
344
+ ],
345
+ "flatten": true
346
+ },
347
+ "demographics": {
348
+ "path": "/demographics",
349
+ "method": "GET",
350
+ "description": "Quarterly demographic and geographic attributes of institutions (office counts, CBSA, metro flags) keyed by CERT and REPDTE.",
351
+ "params": {
352
+ "filters": {
353
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
354
+ },
355
+ "fields": {
356
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
357
+ },
358
+ "sort_by": {
359
+ "desc": "field to sort on"
360
+ },
361
+ "sort_order": {
362
+ "desc": "ASC or DESC",
363
+ "enum": [
364
+ "ASC",
365
+ "DESC"
366
+ ]
367
+ }
368
+ },
369
+ "defaults": {},
370
+ "records": "data",
371
+ "total": "meta.total",
372
+ "paging": {
373
+ "type": "offset",
374
+ "limit_param": "limit",
375
+ "offset_param": "offset",
376
+ "size": 1000
377
+ },
378
+ "max_rows": 100000,
379
+ "missing": [
380
+ ""
381
+ ],
382
+ "flatten": true
383
+ }
384
+ },
385
+ "catalog": {},
386
+ "fields": {
387
+ "CERT": "FDIC certificate number: the institution id used by every endpoint",
388
+ "NAME": "institution name (institutions, failures, locations)",
389
+ "INSTNAME": "institution name (history, financials)",
390
+ "STALP": "state postal code (institutions, financials, locations); PSTALP in failures and history",
391
+ "STNAME": "state name (summary, institutions)",
392
+ "ACTIVE": "1 = open institution (institutions)",
393
+ "ASSET": "total assets, thousands of dollars",
394
+ "DEP": "total deposits, thousands of dollars",
395
+ "DEPDOM": "domestic deposits, thousands of dollars",
396
+ "NETINC": "net income, thousands of dollars; year-to-date in financials",
397
+ "ROA": "return on assets, percent (annualized)",
398
+ "ROE": "return on equity, percent (annualized)",
399
+ "LNLSNET": "net loans and leases, thousands of dollars",
400
+ "REPDTE": "report date: YYYYMMDD in financials, MM/DD/YYYY in institutions",
401
+ "FAILDATE": "failure date, M/D/YYYY text (failures)",
402
+ "FAILYR": "failure year (failures)",
403
+ "COST": "estimated loss to the Deposit Insurance Fund, thousands of dollars (failures)",
404
+ "QBFASSET": "total assets at failure, thousands of dollars",
405
+ "QBFDEP": "total deposits at failure, thousands of dollars",
406
+ "RESTYPE1": "transaction type code (failures): PA, P&A, PI, PO (payout), A/A, IDT, MGR, DINB, OBAM, ABT, REP",
407
+ "CB_SI": "summary charter group: CB commercial banks, SI savings institutions",
408
+ "BANKS": "number of institutions (summary)",
409
+ "DEPSUMBR": "branch deposits as of June 30, thousands of dollars (sod)",
410
+ "YEAR": "year (summary, sod)",
411
+ "EFFDATE": "event effective date (history)",
412
+ "CHANGECODE_DESC": "event type (history)",
413
+ "BKCLASS": "charter class (institutions): N national, SM state member, NM state nonmember, SB savings bank, SI state savings institution, SL savings and loan, NC, OI",
414
+ "RESTYPE": "FAILURE or ASSISTANCE (open-bank assistance); filter RESTYPE:\"FAILURE\" to count failures (failures)",
415
+ "REGAGNT": "primary federal regulator: OCC, FED, FDIC, ... (institutions)"
416
+ }
417
+ }
@@ -0,0 +1,83 @@
1
+ {
2
+ "id": "fdic",
3
+ "title": "FDIC BankFind Suite API",
4
+ "agency": "Federal Deposit Insurance Corporation",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "finance",
8
+ "banking"
9
+ ],
10
+ "keywords": [
11
+ "bank",
12
+ "banks",
13
+ "bank failure",
14
+ "failed banks",
15
+ "fdic",
16
+ "deposits",
17
+ "branch deposits",
18
+ "call report",
19
+ "bank assets",
20
+ "net income",
21
+ "return on assets",
22
+ "summary of deposits",
23
+ "merger",
24
+ "insured institutions",
25
+ "savings institution",
26
+ "community bank"
27
+ ],
28
+ "questions": [
29
+ "bank failures by year since 2000",
30
+ "largest banks in a state by total assets",
31
+ "quarterly assets and net income of one bank",
32
+ "branch deposits by county",
33
+ "number of banks over time"
34
+ ],
35
+ "homepage": "https://banks.data.fdic.gov/",
36
+ "terms_url": "https://www.fdic.gov/about/website-policies",
37
+ "auth": {
38
+ "env": null,
39
+ "required": "none",
40
+ "placement": "none",
41
+ "signup_url": null,
42
+ "echoes_key": false
43
+ },
44
+ "limits": {
45
+ "rps": 3,
46
+ "burst": 5,
47
+ "max_rows": 100000
48
+ },
49
+ "routes": {
50
+ "api": {
51
+ "base": "https://api.fdic.gov/banks",
52
+ "probe": "https://api.fdic.gov/banks/failures?limit=1&fields=CERT",
53
+ "hosts": [
54
+ "api.fdic.gov",
55
+ "banks.data.fdic.gov"
56
+ ]
57
+ },
58
+ "manual": {
59
+ "how": "Open the CSV links in INSTRUCTIONS.md (format=csv) in a browser, or use BankFind Suite (https://banks.data.fdic.gov/bankfind-suite/) > the matching tab > filter > Download, and upload the files."
60
+ }
61
+ },
62
+ "cache": {
63
+ "mode": "run_only",
64
+ "ttl_hours": null,
65
+ "why": "Call Report data are updated quarterly and the institution file daily; data/ is reused within a run."
66
+ },
67
+ "redistribution": {
68
+ "mode": "allowed",
69
+ "why": "FDIC BankFind data are U.S. government works in the public domain (17 U.S.C. 105); FDIC asks users not to imply endorsement."
70
+ },
71
+ "notices": [],
72
+ "retention": null,
73
+ "citation": "Federal Deposit Insurance Corporation, BankFind Suite API ({dataset}), api.fdic.gov/banks, retrieved {retrieved_long}.",
74
+ "audit_hooks": [],
75
+ "clarify": [
76
+ "Count failures only, or failures plus open-bank assistance transactions? The failures table holds both (RESTYPE).",
77
+ "Quarterly income as reported (year-to-date) or converted to quarterly flows? Call Report income fields are year-to-date."
78
+ ],
79
+ "formats": [
80
+ "json",
81
+ "csv"
82
+ ]
83
+ }