data-analyst-mcp 0.3.0 → 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 (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. package/packs/world-bank/policy.json +101 -101
@@ -1,520 +1,520 @@
1
- {
2
- "base_url": "https://api.govinfo.gov",
3
- "endpoints": {
4
- "search": {
5
- "path": "/search",
6
- "method": "POST",
7
- "description": "Full-text and metadata search across GovInfo collections (bills, laws, Federal Register, CFR, reports, hearings). The pack builds the query string from text/phrase plus filters and escapes the user text.",
8
- "params": {
9
- "text": {
10
- "in": "body",
11
- "desc": "plain words (all must match); query operators and punctuation are removed"
12
- },
13
- "phrase": {
14
- "in": "body",
15
- "desc": "exact phrase of two or more words, e.g. child tax credit (quoted: only that exact form matches; one word is searched unquoted). GovInfo's quoted search can miss documents: the fetch counts the all-words search too and notes when the phrase result is under half of it (and 20 or more short)"
16
- },
17
- "all_words": {
18
- "in": "body",
19
- "desc": "words that must all appear, anywhere, unquoted: the complete candidate list for a phrase (an upper bound: the words may stand apart)"
20
- },
21
- "any": {
22
- "in": "body",
23
- "desc": "list of words or phrases, any of which may match (OR), e.g. every form of a term: [\"levy\", \"levies\", \"levied\"]; escaped like text"
24
- },
25
- "title": {
26
- "in": "body",
27
- "desc": "words or a phrase that must be in the document's title field (for bills: official, short and display titles), sent as title:\"...\" and escaped like text. This is the title search: phrase and text search the full text instead"
28
- },
29
- "query": {
30
- "in": "body",
31
- "desc": "raw GovInfo query syntax for experts, passed unchanged (field:value, AND/OR/NOT, quotes)"
32
- },
33
- "collection": {
34
- "in": "body",
35
- "desc": "collection code or list, e.g. BILLS, PLAW, CRPT, FR (catalog lists all)"
36
- },
37
- "congress": {
38
- "in": "body",
39
- "desc": "Congress number, e.g. 118"
40
- },
41
- "billtype": {
42
- "in": "body",
43
- "desc": "hr | s | hjres | sjres | hconres | sconres | hres | sres"
44
- },
45
- "publisher": {
46
- "in": "body",
47
- "desc": "government author / publisher, e.g. Government Accountability Office"
48
- },
49
- "date_from": {
50
- "in": "body",
51
- "desc": "published on or after YYYY-MM-DD"
52
- },
53
- "date_to": {
54
- "in": "body",
55
- "desc": "published on or before YYYY-MM-DD"
56
- },
57
- "sort": {
58
- "in": "body",
59
- "desc": "relevance (default) | newest | oldest"
60
- }
61
- },
62
- "body": {
63
- "offsetMark": "*",
64
- "resultLevel": "default"
65
- },
66
- "records": "results",
67
- "total": "count",
68
- "paging": {
69
- "type": "cursor",
70
- "cursor_param": "offsetMark",
71
- "next": "offsetMark",
72
- "size_param": "pageSize",
73
- "size": 100,
74
- "in": "body"
75
- },
76
- "max_rows": 10000
77
- },
78
- "published": {
79
- "path": "/published/{start_date}/{end_date}",
80
- "method": "GET",
81
- "description": "Packages of one or more collections issued between two dates, both included (a complete list, unlike search; fetch turns the inclusive end_date into GovInfo's exclusive one).",
82
- "params": {
83
- "start_date": {
84
- "in": "path",
85
- "required": true,
86
- "desc": "YYYY-MM-DD"
87
- },
88
- "end_date": {
89
- "in": "path",
90
- "required": true,
91
- "desc": "YYYY-MM-DD"
92
- },
93
- "collection": {
94
- "required": true,
95
- "desc": "comma-separated codes, e.g. PLAW or BILLS,BILLSTATUS"
96
- },
97
- "congress": {
98
- "desc": "Congress number"
99
- },
100
- "docClass": {
101
- "desc": "e.g. hr, s (BILLS) or PUBLIC (PLAW)"
102
- },
103
- "billVersion": {
104
- "desc": "BILLS version code, e.g. enr"
105
- },
106
- "modifiedSince": {
107
- "desc": "ISO timestamp"
108
- }
109
- },
110
- "defaults": {
111
- "offsetMark": "*",
112
- "pageSize": 1000
113
- },
114
- "records": "packages",
115
- "total": "count",
116
- "paging": {
117
- "type": "link",
118
- "next": "nextPage"
119
- },
120
- "max_rows": 100000
121
- },
122
- "package": {
123
- "path": "/packages/{packageId}/summary",
124
- "method": "GET",
125
- "description": "One package's metadata (title, dates, congress, pages, references, download links; committees only where the collection records them at package level: committee reports and hearings carry them per granule).",
126
- "params": {
127
- "packageId": {
128
- "in": "path",
129
- "required": true,
130
- "desc": "e.g. PLAW-117publ169, BILLS-117hr5376enr, CRPT-118hrpt100"
131
- }
132
- },
133
- "records": "",
134
- "paging": {
135
- "type": "none"
136
- }
137
- },
138
- "granules": {
139
- "path": "/packages/{packageId}/granules",
140
- "method": "GET",
141
- "description": "Granules (sections, articles, CFR parts) inside a package.",
142
- "params": {
143
- "packageId": {
144
- "in": "path",
145
- "required": true,
146
- "desc": "e.g. CREC-2024-03-07, FR-2024-01-02"
147
- }
148
- },
149
- "defaults": {
150
- "offsetMark": "*",
151
- "pageSize": 1000
152
- },
153
- "records": "granules",
154
- "total": "count",
155
- "paging": {
156
- "type": "link",
157
- "next": "nextPage"
158
- },
159
- "max_rows": 100000
160
- },
161
- "related": {
162
- "path": "/related/{accessId}",
163
- "method": "GET",
164
- "description": "Related collections for a package (bill versions, bill status, reports, Congressional Record, signing statements).",
165
- "params": {
166
- "accessId": {
167
- "in": "path",
168
- "required": true,
169
- "desc": "package id, e.g. BILLS-117hr5376enr"
170
- }
171
- },
172
- "records": "relationships",
173
- "paging": {
174
- "type": "none"
175
- }
176
- },
177
- "related_collection": {
178
- "path": "/related/{accessId}/{collection}",
179
- "method": "GET",
180
- "description": "The packages of one collection related to a package: the public law of an enrolled bill (collection PLAW: packageId, citation, dateIssued, title), its committee reports (CRPT), its Congressional Record pages (CREC).",
181
- "params": {
182
- "accessId": {
183
- "in": "path",
184
- "required": true,
185
- "desc": "package id, e.g. BILLS-119s5enr"
186
- },
187
- "collection": {
188
- "in": "path",
189
- "required": true,
190
- "desc": "collection code from the related endpoint, e.g. PLAW, CRPT, CREC, BILLS"
191
- }
192
- },
193
- "records": "results",
194
- "paging": {
195
- "type": "none"
196
- }
197
- },
198
- "text": {
199
- "path": "/packages/{packageId}/htm",
200
- "method": "GET",
201
- "description": "Plain text of a bill version, law, report or other package (one row: package_id, title, date_issued, characters, text_status (full, pdf_only, partial_pdf, near_empty: GPO serves a 'TEXT NOT AVAILABLE, REFER TO PDF' placeholder as text for some documents), pdf_url, text). Give packageId, or congress + billtype + number (+ version, default enr) for a bill; add granuleId for one granule.",
202
- "params": {
203
- "packageId": {
204
- "desc": "e.g. PLAW-118publ201 or BILLS-117hr5376enr"
205
- },
206
- "congress": {
207
- "desc": "with billtype and number: builds BILLS-{congress}{billtype}{number}{version}"
208
- },
209
- "billtype": {
210
- "desc": "hr | s | hjres | sjres | hconres | sconres | hres | sres"
211
- },
212
- "number": {
213
- "desc": "bill number"
214
- },
215
- "version": {
216
- "desc": "version code, default enr (enrolled)"
217
- },
218
- "granuleId": {
219
- "desc": "one granule of the package (from endpoint granules): a Congressional Record article, CFR part, report part; e.g. CREC-2025-06-30-pt1-PgS4067"
220
- },
221
- "max_chars": {
222
- "desc": "cut the text at this many characters (default: no cut)"
223
- }
224
- },
225
- "records": "",
226
- "paging": {
227
- "type": "none"
228
- }
229
- },
230
- "sections": {
231
- "path": "/packages/{packageId}/uslm",
232
- "method": "GET",
233
- "description": "One row per section of a public law, from GPO's USLM XML (113th Congress on): identifier, number, heading, enclosing titles, the U.S. Code sections it amends, cites, or is classified to, amending-action count, text.",
234
- "params": {
235
- "packageId": {
236
- "desc": "PLAW package id, e.g. PLAW-117publ169"
237
- },
238
- "max_chars": {
239
- "desc": "cut each section's text at this many characters (default: no cut)"
240
- }
241
- },
242
- "records": "",
243
- "paging": {
244
- "type": "none"
245
- }
246
- }
247
- },
248
- "catalog": {
249
- "bills": {
250
- "id": "BILLS",
251
- "name": "Congressional Bills (every printed version)",
252
- "description": "GovInfo collection BILLS: Congressional Bills (every printed version)",
253
- "endpoint": "search"
254
- },
255
- "billstatus": {
256
- "id": "BILLSTATUS",
257
- "name": "Bill Status XML (from Congress.gov)",
258
- "description": "GovInfo collection BILLSTATUS: Bill Status XML (from Congress.gov)",
259
- "endpoint": "search"
260
- },
261
- "billsum": {
262
- "id": "BILLSUM",
263
- "name": "Bill summaries (CRS)",
264
- "description": "GovInfo collection BILLSUM: Bill summaries (CRS)",
265
- "endpoint": "search"
266
- },
267
- "plaw": {
268
- "id": "PLAW",
269
- "name": "Public and Private Laws (slip laws)",
270
- "description": "GovInfo collection PLAW: Public and Private Laws (slip laws)",
271
- "endpoint": "search"
272
- },
273
- "statute": {
274
- "id": "STATUTE",
275
- "name": "Statutes at Large",
276
- "description": "GovInfo collection STATUTE: Statutes at Large",
277
- "endpoint": "search"
278
- },
279
- "uscode": {
280
- "id": "USCODE",
281
- "name": "United States Code",
282
- "description": "GovInfo collection USCODE: United States Code",
283
- "endpoint": "search"
284
- },
285
- "crpt": {
286
- "id": "CRPT",
287
- "name": "Congressional Reports (committee reports; many reprint cost estimates)",
288
- "description": "GovInfo collection CRPT: Congressional Reports (committee reports; many reprint cost estimates)",
289
- "endpoint": "search"
290
- },
291
- "crec": {
292
- "id": "CREC",
293
- "name": "Congressional Record (daily)",
294
- "description": "GovInfo collection CREC: Congressional Record (daily)",
295
- "endpoint": "search"
296
- },
297
- "crecb": {
298
- "id": "CRECB",
299
- "name": "Congressional Record (bound)",
300
- "description": "GovInfo collection CRECB: Congressional Record (bound)",
301
- "endpoint": "search"
302
- },
303
- "chrg": {
304
- "id": "CHRG",
305
- "name": "Congressional Hearings",
306
- "description": "GovInfo collection CHRG: Congressional Hearings",
307
- "endpoint": "search"
308
- },
309
- "cprt": {
310
- "id": "CPRT",
311
- "name": "Congressional Committee Prints",
312
- "description": "GovInfo collection CPRT: Congressional Committee Prints",
313
- "endpoint": "search"
314
- },
315
- "cdoc": {
316
- "id": "CDOC",
317
- "name": "Congressional Documents",
318
- "description": "GovInfo collection CDOC: Congressional Documents",
319
- "endpoint": "search"
320
- },
321
- "ccal": {
322
- "id": "CCAL",
323
- "name": "Congressional Calendars",
324
- "description": "GovInfo collection CCAL: Congressional Calendars",
325
- "endpoint": "search"
326
- },
327
- "cdir": {
328
- "id": "CDIR",
329
- "name": "Congressional Directory",
330
- "description": "GovInfo collection CDIR: Congressional Directory",
331
- "endpoint": "search"
332
- },
333
- "serialset": {
334
- "id": "SERIALSET",
335
- "name": "U.S. Congressional Serial Set",
336
- "description": "GovInfo collection SERIALSET: U.S. Congressional Serial Set",
337
- "endpoint": "search"
338
- },
339
- "hjournal": {
340
- "id": "HJOURNAL",
341
- "name": "House Journal",
342
- "description": "GovInfo collection HJOURNAL: House Journal",
343
- "endpoint": "search"
344
- },
345
- "sjournal": {
346
- "id": "SJOURNAL",
347
- "name": "Senate Journal",
348
- "description": "GovInfo collection SJOURNAL: Senate Journal",
349
- "endpoint": "search"
350
- },
351
- "fr": {
352
- "id": "FR",
353
- "name": "Federal Register (daily issues, official edition)",
354
- "description": "GovInfo collection FR: Federal Register (daily issues, official edition)",
355
- "endpoint": "search"
356
- },
357
- "cfr": {
358
- "id": "CFR",
359
- "name": "Code of Federal Regulations (annual edition)",
360
- "description": "GovInfo collection CFR: Code of Federal Regulations (annual edition)",
361
- "endpoint": "search"
362
- },
363
- "ecfr": {
364
- "id": "ECFR",
365
- "name": "Electronic CFR (point-in-time, limited)",
366
- "description": "GovInfo collection ECFR: Electronic CFR (point-in-time, limited)",
367
- "endpoint": "search"
368
- },
369
- "lsa": {
370
- "id": "LSA",
371
- "name": "List of CFR Sections Affected",
372
- "description": "GovInfo collection LSA: List of CFR Sections Affected",
373
- "endpoint": "search"
374
- },
375
- "cpd": {
376
- "id": "CPD",
377
- "name": "Compilation of Presidential Documents",
378
- "description": "GovInfo collection CPD: Compilation of Presidential Documents",
379
- "endpoint": "search"
380
- },
381
- "ppp": {
382
- "id": "PPP",
383
- "name": "Public Papers of the Presidents",
384
- "description": "GovInfo collection PPP: Public Papers of the Presidents",
385
- "endpoint": "search"
386
- },
387
- "budget": {
388
- "id": "BUDGET",
389
- "name": "Budget of the United States Government",
390
- "description": "GovInfo collection BUDGET: Budget of the United States Government",
391
- "endpoint": "search"
392
- },
393
- "erp": {
394
- "id": "ERP",
395
- "name": "Economic Report of the President",
396
- "description": "GovInfo collection ERP: Economic Report of the President",
397
- "endpoint": "search"
398
- },
399
- "econi": {
400
- "id": "ECONI",
401
- "name": "Economic Indicators",
402
- "description": "GovInfo collection ECONI: Economic Indicators",
403
- "endpoint": "search"
404
- },
405
- "gaoreports": {
406
- "id": "GAOREPORTS",
407
- "name": "GAO Reports and Comptroller General Decisions (1994-2008)",
408
- "description": "GovInfo collection GAOREPORTS: GAO Reports and Comptroller General Decisions, an archive dated 1989-06-22 to 2008-09-18 (1989-2008)",
409
- "endpoint": "search"
410
- },
411
- "govpub": {
412
- "id": "GOVPUB",
413
- "name": "Government publications catalogued by GPO (agency reports, including some from legislative-branch agencies)",
414
- "description": "GovInfo collection GOVPUB: Government publications catalogued by GPO (agency reports, including some from legislative-branch agencies)",
415
- "endpoint": "search"
416
- },
417
- "uscourts": {
418
- "id": "USCOURTS",
419
- "name": "U.S. Courts opinions",
420
- "description": "GovInfo collection USCOURTS: U.S. Courts opinions",
421
- "endpoint": "search"
422
- },
423
- "usreports": {
424
- "id": "USREPORTS",
425
- "name": "U.S. Reports (Supreme Court)",
426
- "description": "GovInfo collection USREPORTS: U.S. Reports (Supreme Court)",
427
- "endpoint": "search"
428
- },
429
- "govman": {
430
- "id": "GOVMAN",
431
- "name": "U.S. Government Manual",
432
- "description": "GovInfo collection GOVMAN: U.S. Government Manual",
433
- "endpoint": "search"
434
- },
435
- "cmr": {
436
- "id": "CMR",
437
- "name": "Congressionally Mandated Reports",
438
- "description": "GovInfo collection CMR: Congressionally Mandated Reports",
439
- "endpoint": "search"
440
- },
441
- "pai": {
442
- "id": "PAI",
443
- "name": "Privacy Act Issuances",
444
- "description": "GovInfo collection PAI: Privacy Act Issuances",
445
- "endpoint": "search"
446
- },
447
- "hob": {
448
- "id": "HOB",
449
- "name": "History of Bills",
450
- "description": "GovInfo collection HOB: History of Bills",
451
- "endpoint": "search"
452
- },
453
- "comps": {
454
- "id": "COMPS",
455
- "name": "Statute Compilations",
456
- "description": "GovInfo collection COMPS: Statute Compilations",
457
- "endpoint": "search"
458
- },
459
- "cri": {
460
- "id": "CRI",
461
- "name": "Congressional Research Index",
462
- "description": "GovInfo collection CRI: Congressional Research Index",
463
- "endpoint": "search"
464
- },
465
- "czic": {
466
- "id": "CZIC",
467
- "name": "Coastal Zone Information Center",
468
- "description": "GovInfo collection CZIC: Coastal Zone Information Center",
469
- "endpoint": "search"
470
- },
471
- "eric": {
472
- "id": "ERIC",
473
- "name": "Education Reports from ERIC",
474
- "description": "GovInfo collection ERIC: Education Reports from ERIC",
475
- "endpoint": "search"
476
- },
477
- "gpo": {
478
- "id": "GPO",
479
- "name": "GPO publications",
480
- "description": "GovInfo collection GPO: GPO publications",
481
- "endpoint": "search"
482
- },
483
- "hman": {
484
- "id": "HMAN",
485
- "name": "House Rules and Manual",
486
- "description": "GovInfo collection HMAN: House Rules and Manual",
487
- "endpoint": "search"
488
- },
489
- "sman": {
490
- "id": "SMAN",
491
- "name": "Senate Manual",
492
- "description": "GovInfo collection SMAN: Senate Manual",
493
- "endpoint": "search"
494
- },
495
- "annualrep": {
496
- "id": "ANNUALREP",
497
- "name": "Annual reports",
498
- "description": "GovInfo collection ANNUALREP: Annual reports",
499
- "endpoint": "search"
500
- },
501
- "cbo_publications": {
502
- "id": "GOVPUB",
503
- "name": "Budget office publications catalogued by GPO",
504
- "description": "search with collection GOVPUB and publisher \"Congressional Budget Office\": a GPO-catalogued subset of the budget office's reports (765 records in Oct 2026, of which 129 mention \"cost estimate\"), not its full list of publications",
505
- "endpoint": "search"
506
- },
507
- "cost_estimates_in_committee_reports": {
508
- "id": "CRPT",
509
- "name": "Committee reports that reprint cost estimates",
510
- "description": "search with collection CRPT and phrase \"cost estimate\": House and Senate committee reports, which usually reprint the budget office's cost estimate for a reported bill as text",
511
- "endpoint": "search"
512
- },
513
- "bill_versions": {
514
- "id": "ih; is; rh; rs; eh; es; enr; pcs; ats; rfs; rfh; cph; cps",
515
- "name": "Bill version codes",
516
- "description": "BILLS package id = BILLS-{congress}{type}{number}{version}: ih/is introduced, rh/rs reported, eh/es engrossed (passed one chamber), enr enrolled (passed both, sent to the President)",
517
- "endpoint": "text"
518
- }
519
- }
1
+ {
2
+ "base_url": "https://api.govinfo.gov",
3
+ "endpoints": {
4
+ "search": {
5
+ "path": "/search",
6
+ "method": "POST",
7
+ "description": "Full-text and metadata search across GovInfo collections (bills, laws, Federal Register, CFR, reports, hearings). The pack builds the query string from text/phrase plus filters and escapes the user text.",
8
+ "params": {
9
+ "text": {
10
+ "in": "body",
11
+ "desc": "plain words (all must match); query operators and punctuation are removed"
12
+ },
13
+ "phrase": {
14
+ "in": "body",
15
+ "desc": "exact phrase of two or more words, e.g. child tax credit (quoted: only that exact form matches; one word is searched unquoted). GovInfo's quoted search can miss documents: the fetch counts the all-words search too and notes when the phrase result is under half of it (and 20 or more short)"
16
+ },
17
+ "all_words": {
18
+ "in": "body",
19
+ "desc": "words that must all appear, anywhere, unquoted: the complete candidate list for a phrase (an upper bound: the words may stand apart)"
20
+ },
21
+ "any": {
22
+ "in": "body",
23
+ "desc": "list of words or phrases, any of which may match (OR), e.g. every form of a term: [\"levy\", \"levies\", \"levied\"]; escaped like text"
24
+ },
25
+ "title": {
26
+ "in": "body",
27
+ "desc": "words or a phrase that must be in the document's title field (for bills: official, short and display titles), sent as title:\"...\" and escaped like text. This is the title search: phrase and text search the full text instead"
28
+ },
29
+ "query": {
30
+ "in": "body",
31
+ "desc": "raw GovInfo query syntax for experts, passed unchanged (field:value, AND/OR/NOT, quotes)"
32
+ },
33
+ "collection": {
34
+ "in": "body",
35
+ "desc": "collection code or list, e.g. BILLS, PLAW, CRPT, FR (catalog lists all)"
36
+ },
37
+ "congress": {
38
+ "in": "body",
39
+ "desc": "Congress number, e.g. 118"
40
+ },
41
+ "billtype": {
42
+ "in": "body",
43
+ "desc": "hr | s | hjres | sjres | hconres | sconres | hres | sres"
44
+ },
45
+ "publisher": {
46
+ "in": "body",
47
+ "desc": "government author / publisher, e.g. Government Accountability Office"
48
+ },
49
+ "date_from": {
50
+ "in": "body",
51
+ "desc": "published on or after YYYY-MM-DD"
52
+ },
53
+ "date_to": {
54
+ "in": "body",
55
+ "desc": "published on or before YYYY-MM-DD"
56
+ },
57
+ "sort": {
58
+ "in": "body",
59
+ "desc": "relevance (default) | newest | oldest"
60
+ }
61
+ },
62
+ "body": {
63
+ "offsetMark": "*",
64
+ "resultLevel": "default"
65
+ },
66
+ "records": "results",
67
+ "total": "count",
68
+ "paging": {
69
+ "type": "cursor",
70
+ "cursor_param": "offsetMark",
71
+ "next": "offsetMark",
72
+ "size_param": "pageSize",
73
+ "size": 100,
74
+ "in": "body"
75
+ },
76
+ "max_rows": 10000
77
+ },
78
+ "published": {
79
+ "path": "/published/{start_date}/{end_date}",
80
+ "method": "GET",
81
+ "description": "Packages of one or more collections issued between two dates, both included (a complete list, unlike search; fetch turns the inclusive end_date into GovInfo's exclusive one).",
82
+ "params": {
83
+ "start_date": {
84
+ "in": "path",
85
+ "required": true,
86
+ "desc": "YYYY-MM-DD"
87
+ },
88
+ "end_date": {
89
+ "in": "path",
90
+ "required": true,
91
+ "desc": "YYYY-MM-DD"
92
+ },
93
+ "collection": {
94
+ "required": true,
95
+ "desc": "comma-separated codes, e.g. PLAW or BILLS,BILLSTATUS"
96
+ },
97
+ "congress": {
98
+ "desc": "Congress number"
99
+ },
100
+ "docClass": {
101
+ "desc": "e.g. hr, s (BILLS) or PUBLIC (PLAW)"
102
+ },
103
+ "billVersion": {
104
+ "desc": "BILLS version code, e.g. enr"
105
+ },
106
+ "modifiedSince": {
107
+ "desc": "ISO timestamp"
108
+ }
109
+ },
110
+ "defaults": {
111
+ "offsetMark": "*",
112
+ "pageSize": 1000
113
+ },
114
+ "records": "packages",
115
+ "total": "count",
116
+ "paging": {
117
+ "type": "link",
118
+ "next": "nextPage"
119
+ },
120
+ "max_rows": 100000
121
+ },
122
+ "package": {
123
+ "path": "/packages/{packageId}/summary",
124
+ "method": "GET",
125
+ "description": "One package's metadata (title, dates, congress, pages, references, download links; committees only where the collection records them at package level: committee reports and hearings carry them per granule).",
126
+ "params": {
127
+ "packageId": {
128
+ "in": "path",
129
+ "required": true,
130
+ "desc": "e.g. PLAW-117publ169, BILLS-117hr5376enr, CRPT-118hrpt100"
131
+ }
132
+ },
133
+ "records": "",
134
+ "paging": {
135
+ "type": "none"
136
+ }
137
+ },
138
+ "granules": {
139
+ "path": "/packages/{packageId}/granules",
140
+ "method": "GET",
141
+ "description": "Granules (sections, articles, CFR parts) inside a package.",
142
+ "params": {
143
+ "packageId": {
144
+ "in": "path",
145
+ "required": true,
146
+ "desc": "e.g. CREC-2024-03-07, FR-2024-01-02"
147
+ }
148
+ },
149
+ "defaults": {
150
+ "offsetMark": "*",
151
+ "pageSize": 1000
152
+ },
153
+ "records": "granules",
154
+ "total": "count",
155
+ "paging": {
156
+ "type": "link",
157
+ "next": "nextPage"
158
+ },
159
+ "max_rows": 100000
160
+ },
161
+ "related": {
162
+ "path": "/related/{accessId}",
163
+ "method": "GET",
164
+ "description": "Related collections for a package (bill versions, bill status, reports, Congressional Record, signing statements).",
165
+ "params": {
166
+ "accessId": {
167
+ "in": "path",
168
+ "required": true,
169
+ "desc": "package id, e.g. BILLS-117hr5376enr"
170
+ }
171
+ },
172
+ "records": "relationships",
173
+ "paging": {
174
+ "type": "none"
175
+ }
176
+ },
177
+ "related_collection": {
178
+ "path": "/related/{accessId}/{collection}",
179
+ "method": "GET",
180
+ "description": "The packages of one collection related to a package: the public law of an enrolled bill (collection PLAW: packageId, citation, dateIssued, title), its committee reports (CRPT), its Congressional Record pages (CREC).",
181
+ "params": {
182
+ "accessId": {
183
+ "in": "path",
184
+ "required": true,
185
+ "desc": "package id, e.g. BILLS-119s5enr"
186
+ },
187
+ "collection": {
188
+ "in": "path",
189
+ "required": true,
190
+ "desc": "collection code from the related endpoint, e.g. PLAW, CRPT, CREC, BILLS"
191
+ }
192
+ },
193
+ "records": "results",
194
+ "paging": {
195
+ "type": "none"
196
+ }
197
+ },
198
+ "text": {
199
+ "path": "/packages/{packageId}/htm",
200
+ "method": "GET",
201
+ "description": "Plain text of a bill version, law, report or other package (one row: package_id, title, date_issued, characters, text_status (full, pdf_only, partial_pdf, near_empty: GPO serves a 'TEXT NOT AVAILABLE, REFER TO PDF' placeholder as text for some documents), pdf_url, text). Give packageId, or congress + billtype + number (+ version, default enr) for a bill; add granuleId for one granule.",
202
+ "params": {
203
+ "packageId": {
204
+ "desc": "e.g. PLAW-118publ201 or BILLS-117hr5376enr"
205
+ },
206
+ "congress": {
207
+ "desc": "with billtype and number: builds BILLS-{congress}{billtype}{number}{version}"
208
+ },
209
+ "billtype": {
210
+ "desc": "hr | s | hjres | sjres | hconres | sconres | hres | sres"
211
+ },
212
+ "number": {
213
+ "desc": "bill number"
214
+ },
215
+ "version": {
216
+ "desc": "version code, default enr (enrolled)"
217
+ },
218
+ "granuleId": {
219
+ "desc": "one granule of the package (from endpoint granules): a Congressional Record article, CFR part, report part; e.g. CREC-2025-06-30-pt1-PgS4067"
220
+ },
221
+ "max_chars": {
222
+ "desc": "cut the text at this many characters (default: no cut)"
223
+ }
224
+ },
225
+ "records": "",
226
+ "paging": {
227
+ "type": "none"
228
+ }
229
+ },
230
+ "sections": {
231
+ "path": "/packages/{packageId}/uslm",
232
+ "method": "GET",
233
+ "description": "One row per section of a public law, from GPO's USLM XML (113th Congress on): identifier, number, heading, enclosing titles, the U.S. Code sections it amends, cites, or is classified to, amending-action count, text.",
234
+ "params": {
235
+ "packageId": {
236
+ "desc": "PLAW package id, e.g. PLAW-117publ169"
237
+ },
238
+ "max_chars": {
239
+ "desc": "cut each section's text at this many characters (default: no cut)"
240
+ }
241
+ },
242
+ "records": "",
243
+ "paging": {
244
+ "type": "none"
245
+ }
246
+ }
247
+ },
248
+ "catalog": {
249
+ "bills": {
250
+ "id": "BILLS",
251
+ "name": "Congressional Bills (every printed version)",
252
+ "description": "GovInfo collection BILLS: Congressional Bills (every printed version)",
253
+ "endpoint": "search"
254
+ },
255
+ "billstatus": {
256
+ "id": "BILLSTATUS",
257
+ "name": "Bill Status XML (from Congress.gov)",
258
+ "description": "GovInfo collection BILLSTATUS: Bill Status XML (from Congress.gov)",
259
+ "endpoint": "search"
260
+ },
261
+ "billsum": {
262
+ "id": "BILLSUM",
263
+ "name": "Bill summaries (CRS)",
264
+ "description": "GovInfo collection BILLSUM: Bill summaries (CRS)",
265
+ "endpoint": "search"
266
+ },
267
+ "plaw": {
268
+ "id": "PLAW",
269
+ "name": "Public and Private Laws (slip laws)",
270
+ "description": "GovInfo collection PLAW: Public and Private Laws (slip laws)",
271
+ "endpoint": "search"
272
+ },
273
+ "statute": {
274
+ "id": "STATUTE",
275
+ "name": "Statutes at Large",
276
+ "description": "GovInfo collection STATUTE: Statutes at Large",
277
+ "endpoint": "search"
278
+ },
279
+ "uscode": {
280
+ "id": "USCODE",
281
+ "name": "United States Code",
282
+ "description": "GovInfo collection USCODE: United States Code",
283
+ "endpoint": "search"
284
+ },
285
+ "crpt": {
286
+ "id": "CRPT",
287
+ "name": "Congressional Reports (committee reports; many reprint cost estimates)",
288
+ "description": "GovInfo collection CRPT: Congressional Reports (committee reports; many reprint cost estimates)",
289
+ "endpoint": "search"
290
+ },
291
+ "crec": {
292
+ "id": "CREC",
293
+ "name": "Congressional Record (daily)",
294
+ "description": "GovInfo collection CREC: Congressional Record (daily)",
295
+ "endpoint": "search"
296
+ },
297
+ "crecb": {
298
+ "id": "CRECB",
299
+ "name": "Congressional Record (bound)",
300
+ "description": "GovInfo collection CRECB: Congressional Record (bound)",
301
+ "endpoint": "search"
302
+ },
303
+ "chrg": {
304
+ "id": "CHRG",
305
+ "name": "Congressional Hearings",
306
+ "description": "GovInfo collection CHRG: Congressional Hearings",
307
+ "endpoint": "search"
308
+ },
309
+ "cprt": {
310
+ "id": "CPRT",
311
+ "name": "Congressional Committee Prints",
312
+ "description": "GovInfo collection CPRT: Congressional Committee Prints",
313
+ "endpoint": "search"
314
+ },
315
+ "cdoc": {
316
+ "id": "CDOC",
317
+ "name": "Congressional Documents",
318
+ "description": "GovInfo collection CDOC: Congressional Documents",
319
+ "endpoint": "search"
320
+ },
321
+ "ccal": {
322
+ "id": "CCAL",
323
+ "name": "Congressional Calendars",
324
+ "description": "GovInfo collection CCAL: Congressional Calendars",
325
+ "endpoint": "search"
326
+ },
327
+ "cdir": {
328
+ "id": "CDIR",
329
+ "name": "Congressional Directory",
330
+ "description": "GovInfo collection CDIR: Congressional Directory",
331
+ "endpoint": "search"
332
+ },
333
+ "serialset": {
334
+ "id": "SERIALSET",
335
+ "name": "U.S. Congressional Serial Set",
336
+ "description": "GovInfo collection SERIALSET: U.S. Congressional Serial Set",
337
+ "endpoint": "search"
338
+ },
339
+ "hjournal": {
340
+ "id": "HJOURNAL",
341
+ "name": "House Journal",
342
+ "description": "GovInfo collection HJOURNAL: House Journal",
343
+ "endpoint": "search"
344
+ },
345
+ "sjournal": {
346
+ "id": "SJOURNAL",
347
+ "name": "Senate Journal",
348
+ "description": "GovInfo collection SJOURNAL: Senate Journal",
349
+ "endpoint": "search"
350
+ },
351
+ "fr": {
352
+ "id": "FR",
353
+ "name": "Federal Register (daily issues, official edition)",
354
+ "description": "GovInfo collection FR: Federal Register (daily issues, official edition)",
355
+ "endpoint": "search"
356
+ },
357
+ "cfr": {
358
+ "id": "CFR",
359
+ "name": "Code of Federal Regulations (annual edition)",
360
+ "description": "GovInfo collection CFR: Code of Federal Regulations (annual edition)",
361
+ "endpoint": "search"
362
+ },
363
+ "ecfr": {
364
+ "id": "ECFR",
365
+ "name": "Electronic CFR (point-in-time, limited)",
366
+ "description": "GovInfo collection ECFR: Electronic CFR (point-in-time, limited)",
367
+ "endpoint": "search"
368
+ },
369
+ "lsa": {
370
+ "id": "LSA",
371
+ "name": "List of CFR Sections Affected",
372
+ "description": "GovInfo collection LSA: List of CFR Sections Affected",
373
+ "endpoint": "search"
374
+ },
375
+ "cpd": {
376
+ "id": "CPD",
377
+ "name": "Compilation of Presidential Documents",
378
+ "description": "GovInfo collection CPD: Compilation of Presidential Documents",
379
+ "endpoint": "search"
380
+ },
381
+ "ppp": {
382
+ "id": "PPP",
383
+ "name": "Public Papers of the Presidents",
384
+ "description": "GovInfo collection PPP: Public Papers of the Presidents",
385
+ "endpoint": "search"
386
+ },
387
+ "budget": {
388
+ "id": "BUDGET",
389
+ "name": "Budget of the United States Government",
390
+ "description": "GovInfo collection BUDGET: Budget of the United States Government",
391
+ "endpoint": "search"
392
+ },
393
+ "erp": {
394
+ "id": "ERP",
395
+ "name": "Economic Report of the President",
396
+ "description": "GovInfo collection ERP: Economic Report of the President",
397
+ "endpoint": "search"
398
+ },
399
+ "econi": {
400
+ "id": "ECONI",
401
+ "name": "Economic Indicators",
402
+ "description": "GovInfo collection ECONI: Economic Indicators",
403
+ "endpoint": "search"
404
+ },
405
+ "gaoreports": {
406
+ "id": "GAOREPORTS",
407
+ "name": "GAO Reports and Comptroller General Decisions (1994-2008)",
408
+ "description": "GovInfo collection GAOREPORTS: GAO Reports and Comptroller General Decisions, an archive dated 1989-06-22 to 2008-09-18 (1989-2008)",
409
+ "endpoint": "search"
410
+ },
411
+ "govpub": {
412
+ "id": "GOVPUB",
413
+ "name": "Government publications catalogued by GPO (agency reports, including some from legislative-branch agencies)",
414
+ "description": "GovInfo collection GOVPUB: Government publications catalogued by GPO (agency reports, including some from legislative-branch agencies)",
415
+ "endpoint": "search"
416
+ },
417
+ "uscourts": {
418
+ "id": "USCOURTS",
419
+ "name": "U.S. Courts opinions",
420
+ "description": "GovInfo collection USCOURTS: U.S. Courts opinions",
421
+ "endpoint": "search"
422
+ },
423
+ "usreports": {
424
+ "id": "USREPORTS",
425
+ "name": "U.S. Reports (Supreme Court)",
426
+ "description": "GovInfo collection USREPORTS: U.S. Reports (Supreme Court)",
427
+ "endpoint": "search"
428
+ },
429
+ "govman": {
430
+ "id": "GOVMAN",
431
+ "name": "U.S. Government Manual",
432
+ "description": "GovInfo collection GOVMAN: U.S. Government Manual",
433
+ "endpoint": "search"
434
+ },
435
+ "cmr": {
436
+ "id": "CMR",
437
+ "name": "Congressionally Mandated Reports",
438
+ "description": "GovInfo collection CMR: Congressionally Mandated Reports",
439
+ "endpoint": "search"
440
+ },
441
+ "pai": {
442
+ "id": "PAI",
443
+ "name": "Privacy Act Issuances",
444
+ "description": "GovInfo collection PAI: Privacy Act Issuances",
445
+ "endpoint": "search"
446
+ },
447
+ "hob": {
448
+ "id": "HOB",
449
+ "name": "History of Bills",
450
+ "description": "GovInfo collection HOB: History of Bills",
451
+ "endpoint": "search"
452
+ },
453
+ "comps": {
454
+ "id": "COMPS",
455
+ "name": "Statute Compilations",
456
+ "description": "GovInfo collection COMPS: Statute Compilations",
457
+ "endpoint": "search"
458
+ },
459
+ "cri": {
460
+ "id": "CRI",
461
+ "name": "Congressional Research Index",
462
+ "description": "GovInfo collection CRI: Congressional Research Index",
463
+ "endpoint": "search"
464
+ },
465
+ "czic": {
466
+ "id": "CZIC",
467
+ "name": "Coastal Zone Information Center",
468
+ "description": "GovInfo collection CZIC: Coastal Zone Information Center",
469
+ "endpoint": "search"
470
+ },
471
+ "eric": {
472
+ "id": "ERIC",
473
+ "name": "Education Reports from ERIC",
474
+ "description": "GovInfo collection ERIC: Education Reports from ERIC",
475
+ "endpoint": "search"
476
+ },
477
+ "gpo": {
478
+ "id": "GPO",
479
+ "name": "GPO publications",
480
+ "description": "GovInfo collection GPO: GPO publications",
481
+ "endpoint": "search"
482
+ },
483
+ "hman": {
484
+ "id": "HMAN",
485
+ "name": "House Rules and Manual",
486
+ "description": "GovInfo collection HMAN: House Rules and Manual",
487
+ "endpoint": "search"
488
+ },
489
+ "sman": {
490
+ "id": "SMAN",
491
+ "name": "Senate Manual",
492
+ "description": "GovInfo collection SMAN: Senate Manual",
493
+ "endpoint": "search"
494
+ },
495
+ "annualrep": {
496
+ "id": "ANNUALREP",
497
+ "name": "Annual reports",
498
+ "description": "GovInfo collection ANNUALREP: Annual reports",
499
+ "endpoint": "search"
500
+ },
501
+ "cbo_publications": {
502
+ "id": "GOVPUB",
503
+ "name": "Budget office publications catalogued by GPO",
504
+ "description": "search with collection GOVPUB and publisher \"Congressional Budget Office\": a GPO-catalogued subset of the budget office's reports (765 records in Oct 2026, of which 129 mention \"cost estimate\"), not its full list of publications",
505
+ "endpoint": "search"
506
+ },
507
+ "cost_estimates_in_committee_reports": {
508
+ "id": "CRPT",
509
+ "name": "Committee reports that reprint cost estimates",
510
+ "description": "search with collection CRPT and phrase \"cost estimate\": House and Senate committee reports, which usually reprint the budget office's cost estimate for a reported bill as text",
511
+ "endpoint": "search"
512
+ },
513
+ "bill_versions": {
514
+ "id": "ih; is; rh; rs; eh; es; enr; pcs; ats; rfs; rfh; cph; cps",
515
+ "name": "Bill version codes",
516
+ "description": "BILLS package id = BILLS-{congress}{type}{number}{version}: ih/is introduced, rh/rs reported, eh/es engrossed (passed one chamber), enr enrolled (passed both, sent to the President)",
517
+ "endpoint": "text"
518
+ }
519
+ }
520
520
  }