data-analyst-mcp 0.0.0-stage → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (640) hide show
  1. package/README.md +261 -2
  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 +716 -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 +24 -0
  396. package/dist/report/scan_secrets.js +265 -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 +247 -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 +54 -4
  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 +170 -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,241 @@
1
+ # GovInfo (Government Publishing Office API)
2
+ Depth: standard. Key: optional (DATA_GOV_API_KEY; the public DEMO_KEY works at about 10 requests an hour).
3
+ Official publications of all three branches: bill text versions, public laws, Statutes at Large, U.S.
4
+ Code, Congressional Record, committee reports and hearings, Federal Register and CFR, the Budget,
5
+ agency publications catalogued by GPO.
6
+
7
+ ## When to use
8
+ - Which bills or reports use a phrase; full text of a bill version or law; a law's sections and the U.S.
9
+ Code sections it amends; public laws enacted in a date range; committee reports, hearings and Congressional Record issues on a topic; agency reports in GOVPUB.
10
+ - Not here: bill status, sponsors, cosponsors, actions and votes (congress); rule metadata and counts
11
+ (federal-register); public comments (regulations). Cost estimates as numbers are not available from
12
+ any API here (see traps).
13
+
14
+ ## Endpoints and datasets
15
+ | Endpoint | Returns (one row per) | Key parameters |
16
+ |---|---|---|
17
+ | `search` (POST) | matching package or granule: title, packageId, dateIssued, collectionCode, governmentAuthor, links | `text` (plain words, escaped), `phrase` (exact, escaped), `all_words` (every word, anywhere: an upper bound), `any` (list of words or phrases, OR), `title` (words or phrase in the title field: the title search, escaped), `query` (raw syntax, unescaped), `collection`, `congress`, `billtype`, `publisher`, `date_from`, `date_to`, `sort` (relevance, newest, oldest) |
18
+ | `published` | package issued in a date range (complete list) | `start_date`, `end_date`, `collection` (required), `congress`, `docClass`, `billVersion` |
19
+ | `package` | one package's metadata | `packageId` |
20
+ | `related_collection` | related package of one collection (an enrolled bill's public law) | `accessId`, `collection` |
21
+ | `granules` | granule in a package (CREC articles, FR documents, CFR parts) | `packageId` |
22
+ | `related` | related collection for a package (bill versions, status, reports, CREC, signing statements) | `accessId` |
23
+ | `text` | one row: package_id, title, date_issued, pages, characters, text_status, pdf_url, text (+ granule_id, granule_class with `granuleId`) | `packageId`, or `congress` + `billtype` + `number` (+ `version`, default `enr`); `granuleId` for one granule (a Record article: packages of over 25 granules have no whole text); `max_chars` |
24
+ | `sections` | section of a public law (USLM XML): identifier, num, heading, within (enclosing titles), usc_amended, usc_cited, usc_classified, amending_actions, characters, text | `packageId` (PLAW, 113th Congress on), `max_chars` (per section) |
25
+
26
+ Collections (catalog aliases, `request_schema` with `search: "reports"`): BILLS, BILLSTATUS, BILLSUM, PLAW, STATUTE, USCODE,
27
+ CRPT, CREC, CRECB, CHRG, CPRT, CDOC, SERIALSET, FR, CFR, ECFR, CPD, PPP, BUDGET, ERP, ECONI, GAOREPORTS
28
+ (an archive: 16,569 GAO reports and decisions dated 1989-06-22 to 2008-09-18 only, verified 2026-10-22;
29
+ later ones are on gao.gov, which no pack serves),
30
+ GOVPUB, USCOURTS and more. Package ids: `BILLS-118hr4763eh` (congress, type, number, version),
31
+ `PLAW-117publ169` (public law 117-169), `CRPT-118hrpt100`, `CREC-2024-03-07`, `FR-2024-01-02`,
32
+ `CFR-2024-title40-vol1`. Bill versions: ih/is introduced, rh/rs reported, eh/es engrossed (passed one
33
+ chamber), enr enrolled (passed both).
34
+
35
+ ## Spec examples
36
+ ```json
37
+ {"description": "Bills in the 118th Congress that use the phrase 'payment stablecoin'",
38
+ "requests": [{"name": "stablecoin_bills", "endpoint": "search",
39
+ "params": {"collection": "BILLS", "congress": 118, "phrase": "payment stablecoin", "sort": "newest"}}]}
40
+ ```
41
+ ```json
42
+ {"description": "Laws (public and private) issued in 2024, and the text of one",
43
+ "requests": [
44
+ {"name": "laws_2024", "endpoint": "published",
45
+ "params": {"start_date": "2024-01-01", "end_date": "2024-12-31", "collection": "PLAW"}},
46
+ {"name": "law_text", "endpoint": "text", "params": {"packageId": "PLAW-118publ201"}}]}
47
+ ```
48
+ ```json
49
+ {"description": "The sections of Public Law 118-190 and the U.S. Code sections each one amends",
50
+ "requests": [{"name": "law_sections", "endpoint": "sections",
51
+ "params": {"packageId": "PLAW-118publ190", "max_chars": 500}}]}
52
+ ```
53
+ ```json
54
+ {"description": "Budget office publications catalogued by GPO since June 2026 (a subset of its reports)",
55
+ "requests": [{"endpoint": "search", "params": {"collection": "GOVPUB", "date_from": "2026-06-01",
56
+ "sort": "newest", "publisher": "Congressional Budget Office"}, "name": "budget_office_reports"}]}
57
+ ```
58
+
59
+ ## Data format and traps
60
+ - Filters go inside the query string. GovInfo ignores `collection`, `congress` or `billType` sent as
61
+ separate JSON fields (verified: a body field `collection` returned other collections); the pack writes
62
+ them as `collection:BILLS AND congress:118 AND (...)`. Words in `text` all have to match (implicit AND).
63
+ - Escaping: `text` and `phrase` lose `: ( ) [ ] { } " \ * ? ~ ^ !` and the words AND/OR/NOT, so user text
64
+ cannot change the query (a stray backslash once drew HTTP 500; it did not on 2026-10-22, but the
65
+ escaping stays). Use `query` only for deliberate
66
+ GovInfo syntax (`title:"tax"`, `OR`), and quote phrases there yourself. Never put `dateIssued:` in
67
+ `query` (HTTP 500 every time, verified 2026-10-28; `fetch` refuses it as `invalid_request`): use `date_from`/`date_to`.
68
+ An HTTP 500 that repeats for one query while simpler searches answer is caused by the query, not an outage.
69
+ - **Completeness of "documents that mention X"**: GovInfo's quoted (exact-phrase) search can miss documents
70
+ that hold the phrase, even in their titles (BILLS of one Congress: a two-word phrase quoted 58, as
71
+ `title:"..."` 110; one word quoted 44 vs 92 unquoted; checked 2026-10-28). `phrase` stays the quoted search
72
+ (a one-word phrase is sent unquoted); for a multi-word phrase the fetch also counts the same search with
73
+ all the words and notes when the phrase result is under half that count and at least 20 documents short
74
+ (a phrase is always rarer than its words apart, so a smaller gap is expected). `all_words` returns that complete
75
+ candidate list: an upper bound, since the words may stand apart; confirm the phrase in the text of the
76
+ documents that matter (`text`, `for_each` on `packageId`), or call the count "documents containing all
77
+ the words". Unquoted words are stemmed only for dictionary words (a new coinage's plural is not): search
78
+ every form with `any` (`["levy", "levies", "levied"]`), deduplicate by `packageId`, and say in the method
79
+ note which forms and which search (`text`, `phrase`, `all_words`, `any`) were used.
80
+ - **A full-text phrase search is not a title search.** `phrase`, `text`, `all_words` and `any` search the whole
81
+ document, and the quoted search misses many documents (above). For "X in the title" (a bill's official or
82
+ short title), search the title field: `query: 'title:"<phrase>"'` with `collection: BILLS` and `congress`
83
+ (`collection:BILLS AND congress:<n> AND title:"<phrase>"` is what is sent), deduplicate versions to bills,
84
+ then confirm each bill's titles with the congress pack's `bill_titles` (`for_each`). That is the route the
85
+ congress pack's `title_contains` note points to.
86
+ - BILLS has one package per printed version, so a search counts versions, not bills: strip the version
87
+ suffix from `packageId` (`BILLS-118hr4763eh` -> 118 hr 4763) and deduplicate before counting bills. A
88
+ version code can end in a digit (`BILLS-118hr7643rh2`, a second reported print): parse `[a-z]+\d*`.
89
+ - `search` stops at `max_rows` (default 10,000); `count` is GovInfo's estimate of all matches. Relevance
90
+ order changes as content is added; use `published` for complete, stable lists by date and collection.
91
+ - `dateIssued` and the search date filters mean different things by collection: for hearings (CHRG) it is
92
+ the hearing date (equal to `heldDates`), and `date_from`/`date_to` filter on it; when a document became
93
+ available is `dateIngested` (search rows; `published` rows and package summaries carry no ingestion date, so
94
+ "how soon after signing did a law reach GovInfo" needs `search` with collection PLAW). Search returns one row
95
+ per granule: count distinct packages.
96
+ Addenda and errata are packages of their own ("Addendum to ...", "Errata for ...": 25 of 303 Senate CHRG
97
+ packages for 2025, 23 of them Judiciary): drop them by title before counting hearings. CHRG holds printed
98
+ hearings only, months after they are held; meetings as held (hearings, markups) are the congress pack's
99
+ `committee_meetings`. A committee's hearings are best selected by its SuDoc class
100
+ (`query: 'collection:CHRG AND congress:118 AND sudocclass:"y 4.j 89/2:"'`, Senate Judiciary), which also
101
+ leaves out joint hearings another committee printed.
102
+ - `dateIssued` is otherwise the publication date; for GOVPUB catalog records it can be a cataloguing date that is
103
+ later than the document itself (seen in Oct 2026: a record ingested in 2024 shows dateIssued 2026-06-27).
104
+ Check the PDF before dating a document from GOVPUB.
105
+ - Cost estimates: the budget office's own estimates are not a GovInfo collection. Two partial routes,
106
+ both text, not tables: (1) `collection: GOVPUB` with the publisher filter
107
+ (`publisher: "Congressional Budget Office"`, a report subset) returns the reports GPO has catalogued
108
+ (765 records in Oct 2026, far from the office's full list of publications);
109
+ (2) `collection: CRPT` with `phrase: "cost estimate"` finds committee reports, which usually reprint the
110
+ estimate for a reported bill in the report text. Congress.gov bill records (congress pack, endpoint
111
+ `bill_cbo_estimates`) list the titles and links of the estimates for a bill. No API here returns the
112
+ estimated dollar figures as data.
113
+ - `text` returns the GPO plain-text rendition (`[[Page 138 STAT. 2687]]` page markers kept). Large
114
+ packages (an omnibus law) give a text column of several MB; set `max_chars` to keep a sample. Some
115
+ packages have only PDF: the request then fails with "no text rendition". Committee reports and hearings
116
+ keep their text per granule: `text` reads the granules and fills `committees` from them; a package of
117
+ more than 25 granules fails with a hint (list `granules`, then `text` per `granuleId`), it is never cut.
118
+ - **A text rendition can be a placeholder.** For a document GPO did not convert, the text is a cover page plus
119
+ `[TEXT NOT AVAILABLE REFER TO PDF]`, served like real text (`truncated` false). Every `text` row carries
120
+ `text_status`: `full`; `pdf_only` (the placeholder and little else); `partial_pdf` (a placeholder inside
121
+ real text: some parts are only in the PDF); `near_empty` (no placeholder, but under 100 characters per PDF
122
+ page). The fetch marks the table incomplete and names the `pdf_only`/`near_empty` rows. Their words were not
123
+ read: keep them out of term counts and "the full text of all N" (say "N - k read; k only as PDF"), and read
124
+ them at `pdf_url` (GovInfo's public PDF) when they matter.
125
+ - `sections` reads GPO's USLM XML (United States Legislative Markup), which GovInfo has for public laws from
126
+ the 113th Congress (2013) on. Bills have only the older bill XML, Statutes at Large only a whole-volume file
127
+ (tens of MB), and most private laws have no USLM: use `text` for those (GovInfo answers a missing USLM
128
+ file with HTTP 400). Sections inside a title carry it in `within`. Sections quoted inside an amendment are
129
+ the new Code text and are not rows. U.S. Code references are split three ways. `usc_amended`: a
130
+ reference in the same sentence as an amending action ("is amended", "striking", "inserting").
131
+ `usc_cited`: other references. `usc_classified`: margin notes ("31 USC 1101 note"), which show where the
132
+ Office of the Law Revision Counsel places the provision. All are `"; "`-joined: split them before
133
+ counting. Amendments to a named Act that cite no Code section ("Section 102(d) of the ... Act") appear
134
+ only in `text`. GPO converts laws to USLM automatically and warns that compacts and unusual structures
135
+ may be marked up inconsistently, so check a surprising count against `text`.
136
+ - Committees: the package summary and `governmentAuthor` name only the chamber. Per committee, search with
137
+ `query: 'collection:CRPT AND congress:118 AND committee:"Natural Resources"'`: the field matches words of
138
+ any committee name in either chamber (that query also returns Senate Energy and Natural Resources
139
+ reports), so split by `packageId` (`hrpt` House, `srpt` Senate) and confirm with `text`'s `committees`.
140
+ - `published` dates are inclusive here (GovInfo's own end date is exclusive; the adapter adds a day). The FR
141
+ collection also holds a yearly index package (`GPO-FR-INDEX-2024`, docClass GPO): count issues on
142
+ docClass FR. For FR, `pages` (package summary) counts the PDF's pages including unnumbered front matter,
143
+ about 8 more per issue than the Office of the Federal Register's numbered pages.
144
+ - Per-package figures (pages; volume and issue, which CREC's `published` titles also carry: "Volume 171,
145
+ Issue 45") are in `package` summaries: fetch the `published` list,
146
+ then one `package` request per row with `"for_each": {"csv": "data/govinfo/<list>.csv", "column":
147
+ "packageId"}`.
148
+ - CREC (daily Congressional Record): one package per issue date, but a two-book day can appear twice
149
+ (`CREC-2025-03-11` and `CREC-2025-03-11-i45`, same pages; `-i46` the second book): deduplicate by
150
+ `volume` + `issue` before counting issues or summing pages. Other suffixes are distinct issues, not
151
+ duplicates: `-v169`/`-v170` on January 3 (two volumes, the outgoing and incoming Congress) and a day with
152
+ `-i64`/`-i65`. Chamber sections are granules of class SENATE, HOUSE, EXTENSIONS and DAILYDIGEST (the
153
+ summary's `download.pdfSenateLink` / `pdfHouseLink` too). Early-January issues of a calendar year
154
+ belong to the outgoing Congress (volume and congress differ; `CREC-2015-01-02` is volume 160 but is
155
+ labelled congress 114), and an issue can be missing. Proceedings print under the legislative day, not the calendar day: a
156
+ Senate session that runs on (July 1, 2025, a continuation of June 30's legislative day) has no issue of its
157
+ own, so `granules` for that date returns no rows; find the issue with `search` (CREC, a phrase from the
158
+ proceedings) instead. `pages` counts PDF pages (Daily Digest and front
159
+ matter included), so it runs about 1 percent above the Résumé of Congressional Activity's numbered pages.
160
+ - "How many pages is the law": the convention is its Statutes at Large pages (first page to the last
161
+ `[[Page ... STAT. ...]]` marker of `text`, e.g. 139 Stat. 72-401 is 330 pages); the slip-law and enrolled-bill
162
+ PDFs differ by a page or so (cover, signatures). Say which measure the answer uses.
163
+ - CPD (Compilation of Presidential Documents, 1993 on; daily from 2009-01-20): one package per document,
164
+ docClass PRESDOC plus a few DIGEST, ACTSAPPROVED, CHECKLIST and NOMINATIONS rows (in a transition year the
165
+ outgoing President's supplements, `DCPD-2025DIGEST-BIDEN` and the like, are docClass PRESDOC too: count
166
+ numbered DCPD-YYYY0NNNN packages). The `published` list has no document type; each `package` summary has
167
+ `dcpdCategory` (level1 "Executive Orders", "Proclamations" ...), and `search` takes `collection:CPD AND
168
+ cpdcategory:proclamation` (signing remarks included). Some orders are missing or have no number in the
169
+ title, and `dateIssued` can be a day after signing. Count executive orders from the
170
+ federal-register pack (`executive_orders`, by signing date) and use CPD as the cross-check.
171
+ - CRPT (committee reports): one package per numbered report (its parts and errata inside it); GovInfo's
172
+ browse pages count documents (parts and errata), so they run above the report count. `published` CRPT also
173
+ lists GPO duplicate packages (GPO-J6-REPORT, GPO-CRPT-117hrpt646): keep `packageId` CRPT-*. A few
174
+ `dateIssued` values are wrong (three Dec-2022 reports dated 2021-12-31): count by Congress, not by date.
175
+ - CPRT (committee prints, "select prints": GovInfo is not a census of them): summaries carry no
176
+ `committees`; attribute a print to its committee by `suDocClassNumber` (the `Y 4.` stem, without the
177
+ `-NN` series suffix; a few prints have two classes or none). `published` with collection CPRT also returns
178
+ packages of other collections (GPO-PLUMBOOK-2024, collectionCode GPO): keep `collectionCode` CPRT.
179
+ GovInfo's browse pages count documents (errata included), not packages.
180
+ - STATUTE: one package per volume and volume = a session of Congress, not a calendar year. A law goes in
181
+ the volume of the session that passed it, not the year it was signed: laws signed in early January after
182
+ a session ends are in the closing session's volume (116-344, signed 2021-01-13, in vol. 134; 118-274,
183
+ 2025-01-06, in vol. 138), and numbering can interleave (113-74, signed 2014-01-16, closes vol. 127 while
184
+ 113-73 opens vol. 128). Assign laws to volumes from the granules, never by date. Granule `dateIssued` can
185
+ be wrong by a year (117-343's granule says 2022-01-05; signed 2023-01-05). Count laws by granules
186
+ with `granuleClass` PUBLICLAW (granules also hold proclamations and concurrent resolutions). Older
187
+ summaries (vol. 127) have no `pages`; `pages` counts front matter too. A granule id carries its start page
188
+ (`STATUTE-136-Pg6299`; a continuation adds a suffix, `STATUTE-135-Pg2531-2`). Each volume prints public
189
+ laws, then private laws, then concurrent resolutions and proclamations, with a few blank pages between the
190
+ parts. The public laws' pages run from the first law's start page to the **last law's last page**: the last
191
+ `[[Page N STAT. M]]` marker in that law's `text` (`packageId` PLAW-...). The next granule's start page
192
+ overstates it by 3 or 4 pages (6 more in vol. 136, where private laws come first); with the end from the
193
+ text, the 116th-118th Congresses give 8,432, 8,742 and 4,350 pages, the figures in Brookings' Vital
194
+ Statistics on Congress (Table 6-4).
195
+ - BUDGET: one package per volume (`BUDGET-2027-BUD` main volume, `-PER` Analytical Perspectives, `-APP`
196
+ Appendix). Summaries report collectionCode GPO (FY2017 and FY2027 alike) although `published` with
197
+ collection BUDGET lists them. Recent summaries' `pages` equals the PDF's page count; older ones (FY2017)
198
+ carry none: download `https://www.govinfo.gov/content/pkg/<packageId>/pdf/<packageId>.pdf`, count its pages
199
+ (pypdf) and record them in `published/`. A missing volume (FY2026 had no Analytical
200
+ Perspectives) is a 404: allow_empty. OMB posts supplemental chapters outside the volumes.
201
+ - USCOURTS (federal court opinions): one package per case, one granule per opinion; `search` returns one row
202
+ per opinion (`collection:USCOURTS AND courttype:appellate`, `courtname:fifth`; `ingestdate:range(...)`
203
+ filters on the date added to GovInfo, not the opinion date, and 2025 opinions keep arriving in 2026). A year of appellate opinions (about 15,000) passes the
204
+ 10,000-row search cap: split by half-year. The court code is in the packageId (`USCOURTS-ca5-...`; the
205
+ Federal Circuit is ca13). Courts choose what they send (the Ninth Circuit sends precedential opinions only),
206
+ so a ranking reflects submission practice, not caseload: say so; the AO's Judicial Business tables (B-12)
207
+ count opinions by circuit.
208
+ - CFR: one package per title, edition and volume (`CFR-2025-title40-vol17`). `dateIssued` is the
209
+ "revised as of" date (January 1 for titles 1-16, April 1 for 17-27, July 1 for 28-41, October 1 for
210
+ 42-50), not the posting date, which lags by months: a recent
211
+ edition can be incomplete, with volumes missing (404) while `volumeCount` counts them. `published`
212
+ rows carry no page count, so a title's pages take one `package` call per volume (`pages`, every PDF page
213
+ including front matter); give missing volumes `"allow_empty": true` and say they are missing, or fill
214
+ them from the prior edition as a labeled sensitivity case. Some volumes are covers only (`coveronly`).
215
+ - Bill to law: `related_collection` with `accessId` BILLS-...enr and `collection` PLAW gives the law's
216
+ package, citation and date (the plain `related` lists only the collections). An enrolled version's
217
+ `dateIssued` is GPO's print date, not the enrollment date: it can fall after the signing (BILLS-119hr1enr
218
+ is dated 2025-07-09, signed 2025-07-04).
219
+ - PLAW holds private laws too: `published` rows carry `docClass` PUBLIC or PRIVATE (packageId `publ` /
220
+ `pvtl`); 2022 had 247 public and 2 private. Count public laws on `docClass == "PUBLIC"`. For PLAW,
221
+ `dateIssued` is usually the approval date, but GovInfo has errors (PLAW-119publ76 is dated 2025-02-06; it
222
+ was approved 2026-02-06): for counts by date, check the Office of the Federal Register's list or the
223
+ congress pack's `laws`.
224
+ - `governmentAuthor` is a "; "-joined list. `collectionCode` can hold two codes (`SERIALSET;CRPT`).
225
+ - Paging: `search` uses GovInfo's `offsetMark` cursor (100 per page); `published` and `granules` follow
226
+ `nextPage` (1,000 per page).
227
+
228
+ ## Access
229
+ Key optional: DATA_GOV_API_KEY (https://api.data.gov/signup/, also linked from GovInfo's own
230
+ https://www.govinfo.gov/api-signup), sent as `api_key` to api.govinfo.gov only.
231
+ Without it the pack uses DEMO_KEY (observed limit 10 requests an hour per IP); a spec needing more than about 8
232
+ calls makes `fetch` stop with `key_missing` (the message gives the call count). Text pages on www.govinfo.gov
233
+ never get the key. Manual route (`manual_bundle`): GET links in
234
+ INSTRUCTIONS.md carry `api_key=DEMO_KEY`; text items link the keyless public page
235
+ `https://www.govinfo.gov/content/pkg/<id>/html/<id>.htm`; searches are POST requests (one command
236
+ runs download_data.sh / .ps1), or search on https://www.govinfo.gov/app/search and save the result list.
237
+
238
+ ## Citation and terms
239
+ "U.S. Government Publishing Office, GovInfo, <query or package>, api.govinfo.gov, retrieved <date>."
240
+ Public domain unless a document marks copyrighted content; redistribution allowed. Cite the package id
241
+ and the official PDF for legal text.
@@ -0,0 +1,93 @@
1
+ {
2
+ "base_url": "https://api.gsa.gov/acquisition/calc/v3/api",
3
+ "endpoints": {
4
+ "rates": {
5
+ "path": "/ceilingrates/",
6
+ "description": "Awarded ceiling rates (fully burdened, not-to-exceed hourly prices) on GSA MAS labor categories: one row per labor category per contract and worksite. JSON, pages of 500, at most 10,000 rows (use rates_export for more).",
7
+ "params": {
8
+ "keyword": {"desc": "wildcard search over labor category, vendor and contract number (2+ characters): 'data scientist'"},
9
+ "search": {"desc": "exact, case-sensitive match field:value: 'labor_category:Data Scientist', 'vendor_name:BOOZ ALLEN HAMILTON INC', 'idv_piid:47QREA22D000R'"},
10
+ "education_level": {"desc": "filter: HS, AA, BA, MA, PHD (upper case); several with |: BA|MA"},
11
+ "experience_range": {"desc": "filter: min,max years, e.g. 3,10"},
12
+ "min_years_experience": {"desc": "filter: exact minimum years, e.g. 5"},
13
+ "price_range": {"desc": "filter: min,max dollars per hour, e.g. 50,150"},
14
+ "current_price": {"desc": "filter: exact current price"},
15
+ "worksite": {"desc": "filter: customer, contractor or virtual (lower case; the pack lowercases)"},
16
+ "business_size": {"desc": "filter: S (small) or O (other than small)"},
17
+ "security_clearance": {"desc": "filter: yes or no"},
18
+ "sin": {"desc": "filter: GSA Special Item Number, e.g. 54151S"},
19
+ "category": {"desc": "filter: e.g. Information Technology, Professional Services"},
20
+ "subcategory": {"desc": "filter: e.g. IT Services"},
21
+ "filter": {"desc": "raw filters as a list of field:value strings (sent as repeated filter=)"},
22
+ "ordering": {"desc": "sort field: current_price (default), labor_category, vendor_name, education_level, min_years_experience"},
23
+ "sort": {"enum": ["asc", "desc"], "desc": "asc (default) or desc"},
24
+ "exclude": {"desc": "record ids to leave out, separated by |"}
25
+ },
26
+ "defaults": {"ordering": "current_price", "sort": "asc"},
27
+ "records": "hits.hits", "total": "hits.total.value",
28
+ "paging": {"type": "page", "page_param": "page", "size_param": "page_size", "size": 500, "start": 1, "max_pages": 20},
29
+ "max_rows": 10000
30
+ },
31
+ "rates_export": {
32
+ "path": "/ceilingrates/",
33
+ "description": "The same search as one CSV export (export=y): every matching row, no 10,000 cap (55,000+ rows for 'engineer'); columns renamed to the rates names.",
34
+ "params": {
35
+ "keyword": {"desc": "as in rates"}, "search": {"desc": "as in rates"},
36
+ "education_level": {"desc": "as in rates"}, "experience_range": {"desc": "as in rates"},
37
+ "min_years_experience": {"desc": "as in rates"}, "price_range": {"desc": "as in rates"},
38
+ "current_price": {"desc": "as in rates"}, "worksite": {"desc": "as in rates"},
39
+ "business_size": {"desc": "as in rates"}, "security_clearance": {"desc": "as in rates"},
40
+ "sin": {"desc": "as in rates"}, "category": {"desc": "as in rates"}, "subcategory": {"desc": "as in rates"},
41
+ "filter": {"desc": "raw filters"}, "ordering": {"desc": "sort field"}, "sort": {"enum": ["asc", "desc"], "desc": "asc or desc"}
42
+ },
43
+ "defaults": {"export": "y"},
44
+ "records": "$csv", "paging": {"type": "none"}, "max_rows": 200000
45
+ },
46
+ "rate_stats": {
47
+ "path": "/ceilingrates/",
48
+ "description": "Summary of current_price over every matching rate (all matches, not only 10,000): count, min, max, mean, standard deviation, percentiles 10-90. One row.",
49
+ "params": {
50
+ "keyword": {"desc": "as in rates"}, "search": {"desc": "as in rates"},
51
+ "education_level": {"desc": "as in rates"}, "experience_range": {"desc": "as in rates"},
52
+ "min_years_experience": {"desc": "as in rates"}, "price_range": {"desc": "as in rates"},
53
+ "worksite": {"desc": "as in rates"}, "business_size": {"desc": "as in rates"},
54
+ "security_clearance": {"desc": "as in rates"}, "sin": {"desc": "as in rates"},
55
+ "category": {"desc": "as in rates"}, "subcategory": {"desc": "as in rates"}, "filter": {"desc": "raw filters"}
56
+ },
57
+ "defaults": {"page": 1, "page_size": 0},
58
+ "records": "aggregations", "paging": {"type": "none"}
59
+ },
60
+ "rate_facets": {
61
+ "path": "/ceilingrates/",
62
+ "description": "Counts of matching rates by education level, worksite, business size, security clearance, minimum years of experience and labor category (top 500): rows facet, key, doc_count.",
63
+ "params": {
64
+ "keyword": {"desc": "as in rates"}, "search": {"desc": "as in rates"},
65
+ "education_level": {"desc": "as in rates"}, "experience_range": {"desc": "as in rates"},
66
+ "price_range": {"desc": "as in rates"}, "worksite": {"desc": "as in rates"},
67
+ "business_size": {"desc": "as in rates"}, "security_clearance": {"desc": "as in rates"},
68
+ "sin": {"desc": "as in rates"}, "category": {"desc": "as in rates"}, "filter": {"desc": "raw filters"}
69
+ },
70
+ "defaults": {"page": 1, "page_size": 0},
71
+ "records": "aggregations", "paging": {"type": "none"}
72
+ },
73
+ "suggest_labor_category": {
74
+ "path": "/ceilingrates/",
75
+ "description": "Labor category titles containing a text (suggest-contains), with counts: the exact spellings for search=labor_category:...",
76
+ "params": {"prefix": {"required": true, "desc": "2+ characters, e.g. 'data sci'"}},
77
+ "records": "aggregations.labor_category.buckets", "paging": {"type": "none"}
78
+ },
79
+ "suggest_vendor_name": {
80
+ "path": "/ceilingrates/",
81
+ "description": "Vendor names containing a text, with counts.",
82
+ "params": {"prefix": {"required": true, "desc": "2+ characters, e.g. 'booz'"}},
83
+ "records": "aggregations.vendor_name.buckets", "paging": {"type": "none"}
84
+ },
85
+ "suggest_contract": {
86
+ "path": "/ceilingrates/",
87
+ "description": "Contract numbers (IDV PIID) containing a text, with counts.",
88
+ "params": {"prefix": {"required": true, "desc": "2+ characters, e.g. '47QTCA'"}},
89
+ "records": "aggregations.idv_piid.buckets", "paging": {"type": "none"}
90
+ }
91
+ },
92
+ "catalog": {}
93
+ }
@@ -0,0 +1,97 @@
1
+ {
2
+ "id": "gsa-calc",
3
+ "title": "GSA CALC+ Labor Ceiling Rates (Quick Rate API)",
4
+ "agency": "U.S. General Services Administration, Federal Acquisition Service",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "federal procurement",
8
+ "contracting",
9
+ "labor rates"
10
+ ],
11
+ "keywords": [
12
+ "calc",
13
+ "calc+",
14
+ "ceiling rate",
15
+ "ceiling rates",
16
+ "labor rate",
17
+ "labor rates",
18
+ "hourly rate",
19
+ "billing rate",
20
+ "contractor rates",
21
+ "gsa schedule",
22
+ "mas",
23
+ "multiple award schedule",
24
+ "igce",
25
+ "market research",
26
+ "price analysis",
27
+ "labor category",
28
+ "professional services",
29
+ "consultant rates",
30
+ "it services",
31
+ "sin"
32
+ ],
33
+ "questions": [
34
+ "what do GSA schedule contractors charge per hour for a data scientist",
35
+ "ceiling rates for a labor category by education and experience",
36
+ "median hourly rate for software engineers on GSA MAS contracts",
37
+ "all labor rates on one GSA contract",
38
+ "rates of small versus other-than-small businesses"
39
+ ],
40
+ "homepage": "https://buy.gsa.gov/pricing/",
41
+ "terms_url": "https://www.gsa.gov/website-information/website-policies",
42
+ "auth": {
43
+ "env": null,
44
+ "required": "none",
45
+ "placement": "none",
46
+ "signup_url": null,
47
+ "echoes_key": false
48
+ },
49
+ "limits": {
50
+ "rps": 2,
51
+ "burst": 4,
52
+ "max_rows": 200000
53
+ },
54
+ "routes": {
55
+ "api": {
56
+ "base": "https://api.gsa.gov/acquisition/calc/v3/api",
57
+ "probe": "https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?page=1&page_size=0&keyword=analyst",
58
+ "hosts": [
59
+ "api.gsa.gov"
60
+ ]
61
+ },
62
+ "manual": {
63
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser: each downloads a CSV export (ceilingrates_results.csv) of every matching rate; rename it to the name shown and upload. Without the links: search at https://buy.gsa.gov/pricing/ (CALC+ Labor Ceiling Rates), set the filters, use Export to CSV, and upload the file."
64
+ }
65
+ },
66
+ "cache": {
67
+ "mode": "run_only",
68
+ "ttl_hours": null,
69
+ "why": "The index is rebuilt every night (the _timestamp column), so data/ is reused only within a run."
70
+ },
71
+ "redistribution": {
72
+ "mode": "allowed",
73
+ "why": "CALC+ ceiling rates are published by GSA, a U.S. government agency; federal government works are in the public domain (17 U.S.C. 105) and GSA's website policies place its content in the public domain unless noted."
74
+ },
75
+ "notices": [],
76
+ "retention": null,
77
+ "citation": "U.S. General Services Administration, CALC+ Labor Ceiling Rates ({dataset}), api.gsa.gov/acquisition/calc/v3, retrieved {retrieved_long}.",
78
+ "audit_hooks": [
79
+ {
80
+ "id": "calc_ceiling_not_paid",
81
+ "kind": "require_text",
82
+ "any": [
83
+ "ceiling"
84
+ ],
85
+ "why": "CALC+ rates are awarded ceiling (maximum) prices on schedule contracts, not prices actually paid or wages; a report must say so."
86
+ }
87
+ ],
88
+ "clarify": [
89
+ "Which labor categories, exactly? Titles are free text set by each vendor ('Data Scientist III', 'Sr. Data Scientist'): use a keyword search and say how titles were grouped.",
90
+ "Which filters change the comparison: education, minimum years of experience, worksite (customer, contractor, virtual), business size? Default: none, and report the mix.",
91
+ "Current-year price or next/second option-year prices? Default: current_price."
92
+ ],
93
+ "formats": [
94
+ "json",
95
+ "csv"
96
+ ]
97
+ }
@@ -0,0 +1,108 @@
1
+ # GSA CALC+ Labor Ceiling Rates (Quick Rate API)
2
+ Depth: standard. Key: none. Awarded hourly ceiling rates for labor categories on GSA Multiple Award
3
+ Schedule (MAS) services contracts: labor category title, vendor, contract, price for the current and
4
+ next two option years, education, minimum experience, worksite, business size, clearance, SIN.
5
+
6
+ ## When to use
7
+ - Market research and cost estimates (IGCEs): what schedule contractors may charge per hour for a kind
8
+ of labor, by education, experience, worksite or business size; every rate on one contract.
9
+ - Not here: wages actually paid to workers (bls OEWS, opm for federal pay), what agencies actually spent
10
+ or ordered (usaspending, fpds), GSA per diem rates (gsa per diem pack if present).
11
+ - These are ceiling prices (maximum, fully burdened hourly prices including overhead and profit), not
12
+ prices paid and not wages. Task orders are often priced below the ceiling.
13
+
14
+ ## Endpoints and datasets
15
+ One host: `https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/` (no key; verified 2026-10).
16
+
17
+ | Endpoint | Returns | Key parameters |
18
+ |---|---|---|
19
+ | `rates` | rate rows (JSON), pages of 500, at most 10,000 rows | `keyword` or `search`, filters, `ordering`, `sort` |
20
+ | `rates_export` | the same search as one CSV export, no 10,000 cap; rates identical in every exported column appear once | same |
21
+ | `rate_stats` | one row over all matches: count, min, max, mean, std_dev_sample, median, p10-p90 | same filters |
22
+ | `rate_facets` | counts by education_level, worksite, business_size, security_clearance, min_years_experience, labor_category (top 500) | same filters |
23
+ | `suggest_labor_category` / `suggest_vendor_name` / `suggest_contract` | values containing a text, with counts | `prefix` |
24
+
25
+ Search modes: `keyword` = wildcard over labor category, vendor and contract number (2+ characters);
26
+ `search` = exact, case-sensitive `field:value` on `labor_category`, `vendor_name` or `idv_piid`.
27
+ Filter parameters (the pack turns them into `filter=field:value`): `education_level` (HS, AA, BA, MA,
28
+ PHD; several as `BA|MA`), `experience_range` (`3,10`), `min_years_experience`, `price_range` (`50,150`),
29
+ `current_price`, `worksite` (customer, contractor, virtual), `business_size` (S, O), `security_clearance`
30
+ (yes, no), `sin` (54151S), `category`, `subcategory`; or a raw list in `filter`.
31
+ Columns (rates, rates_export): `labor_category`, `vendor_name`, `idv_piid` (contract), `current_price`,
32
+ `next_year_price`, `second_year_price`, `education_level`, `min_years_experience`, `worksite`,
33
+ `business_size`, `security_clearance`, `schedule`, `sin`, `category`, `subcategory`, `contract_start`,
34
+ `contract_end`; `rates` adds `id`, `data_source`, `_timestamp` (index build time) and date codes.
35
+
36
+ ## Spec examples
37
+ ```json
38
+ {"description": "Data scientist ceiling rates, master's degree, small business; statistics over all matches",
39
+ "requests": [{"name": "ds_ma_small", "endpoint": "rates",
40
+ "params": {"keyword": "data scientist", "education_level": "MA", "business_size": "S"}},
41
+ {"name": "ds_stats", "endpoint": "rate_stats", "params": {"keyword": "data scientist"}}]}
42
+ ```
43
+ ```json
44
+ {"description": "Every rate on one contract, and exact title spellings",
45
+ "requests": [{"name": "contract_rates", "endpoint": "rates", "params": {"search": "idv_piid:47QREA22D000R"}},
46
+ {"name": "titles", "endpoint": "suggest_labor_category", "params": {"prefix": "software eng"}}]}
47
+ ```
48
+ ```json
49
+ {"description": "All engineer rates, 5-15 years experience, customer site (more than 10,000 rows)",
50
+ "requests": [{"name": "eng_export", "endpoint": "rates_export",
51
+ "params": {"keyword": "engineer", "experience_range": "5,15", "worksite": "customer"}}]}
52
+ ```
53
+
54
+ ## Data format and traps
55
+ - **One rate appears once per worksite.** A vendor that offers a category at both customer and contractor
56
+ sites has two rows with the same price. Counts, means and medians over rows (including `rate_stats`)
57
+ weight such categories twice. De-duplicate on (`idv_piid`, `labor_category`, `current_price`) when the
58
+ question is about distinct offers, and say which way you counted.
59
+ - Titles are free text chosen by each vendor ("Data Scientist III", "Sr. Data Scientist", "DATA
60
+ SCIENTIST 03"); levels are not comparable across vendors. A `keyword` search also matches vendor names
61
+ and contract numbers. Report the search used and look at `suggest_labor_category` before grouping.
62
+ - Filter values are case-sensitive and a wrong value fails silently (verified 2026-10): `worksite` must
63
+ be lower case customer / contractor / virtual ("Contractor/Customer/Both" are ignored and
64
+ return everything); `education_level` must be upper case (lower case is ignored); `business_size` upper
65
+ case (lower case matches nothing). The pack fixes the case and rejects other values. An unknown filter
66
+ field is also silently ignored (HTTP 200, every rate returned; verified 2026-10-22: `filter=schedule:MAS`,
67
+ `filter=labor_category:...` do nothing), so the pack accepts raw `filter` entries only for the fields
68
+ listed above; labor category, vendor and contract go in `search`. An unknown `search` or `ordering`
69
+ field answers HTTP 406 with an empty body (`search` takes only labor_category, vendor_name, idv_piid;
70
+ the pack checks it).
71
+ - `search` is exact and case-sensitive ("labor_category:data scientist" finds nothing).
72
+ - The JSON search stops at 10,000 rows (hits.total says "10000, gte"); a page past row 10,000 answers HTTP
73
+ 406 with an empty body (verified 2026-10-22; the pack never asks for one). Use `rates_export` (CSV, all
74
+ rows; 55,000+ rows for "engineer", about 19 MB) or `rate_stats`.
75
+ - `rates_export` writes one line per distinct row of its exported columns: rates identical in all of them
76
+ (same contract, category and prices; different JSON `id`) appear once, so the export can hold fewer rows
77
+ than the search matches ("data scientist": 1,504 rows for 1,516 matches; "accountant" 751 for 755;
78
+ verified 2026-10-28). The fetch counts the matches (one
79
+ `rate_stats` call) and notes any shortfall. Count rates with `rate_stats`; when every rate must be a row,
80
+ use `rates` (JSON, with `id`; at most 10,000).
81
+ - A `rates_export` with no matches is only the SEARCH VALUES / FILTER VALUES preamble with no header line;
82
+ the pack reads it as zero rows and fails with "returned no rows" (as the other endpoints do).
83
+ - `page_size` is ignored unless `page` is also sent (the pack always sends both).
84
+ - `rate_stats` statistics are computed by the search engine over rows: mean and standard deviation are
85
+ exact over the matches; percentiles and median are approximations that can move slightly between calls
86
+ (168.97 and 168.91 for the same query). Prices are dollars per hour, not adjusted for inflation; option
87
+ years (`next_year_price`, `second_year_price`) carry the contract's escalation and may be empty.
88
+ - `rates_export` columns are renamed to the JSON names, and two codings are aligned with the JSON:
89
+ business size "small business" / "other than small business" become S / O, security clearance
90
+ "Yes" / "No" become True / False. Education spellings differ from the filter codes (Bachelors, Masters,
91
+ PhD, High School, plus "None" and "Other Tech School or Certification").
92
+ - `security_clearance` is True/False text; `worksite` values are Customer_Facility, Contractor_Facility,
93
+ Virtual. Contract dates are YYYY-MM-DD; contracts past `contract_end` drop out of the index.
94
+ - The index is rebuilt nightly; results change from day to day. Record the retrieval date.
95
+ - The API documentation marks the service as beta; the legacy CALC API was retired in February 2025.
96
+
97
+ ## Access
98
+ No key (no api.data.gov key needed; verified without one). `fetch` downloads when api.gsa.gov answers; the
99
+ pack keeps to 2 requests a second. Manual route (`manual_bundle`): `manual_download/INSTRUCTIONS.md` gives one CSV export
100
+ link per request (`export=y`, every matching row, identical rows once); the browser saves `ceilingrates_results.csv`: rename
101
+ it to the name shown, upload, then `ingest` (the export layout is parsed and renamed as above).
102
+ Aggregation and suggestion requests get JSON links instead. Without the links: https://buy.gsa.gov/pricing/
103
+ (CALC+ Labor Ceiling Rates), search, set filters, Export, upload.
104
+
105
+ ## Citation and terms
106
+ "U.S. General Services Administration, CALC+ Labor Ceiling Rates, api.gsa.gov, retrieved <date>."
107
+ Public domain (U.S. government work; GSA website policies). Redistribution allowed. Reports must call
108
+ the numbers ceiling rates (audit hook `calc_ceiling_not_paid`).