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,554 +1,554 @@
1
- {
2
- "base_url": "https://lda.gov/api/v1",
3
- "endpoints": {
4
- "filings": {
5
- "path": "/filings/",
6
- "method": "GET",
7
- "description": "LD-1 registrations and LD-2 quarterly activity reports: one row per filing (registrant, client, income or expenses, period, posted date; activities as JSON).",
8
- "params": {
9
- "filing_year": {
10
- "desc": "year, e.g. 2024"
11
- },
12
- "filing_period": {
13
- "desc": "first_quarter | second_quarter | third_quarter | fourth_quarter | mid_year | year_end (older semiannual reports)"
14
- },
15
- "filing_type": {
16
- "desc": "code, e.g. Q1, 1A (Q1 amendment), RR (registration); endpoint filing_types lists all"
17
- },
18
- "registrant_name": {
19
- "desc": "lobbying firm or self-filing organization (substring match)"
20
- },
21
- "registrant_id": {
22
- "desc": "registrant id"
23
- },
24
- "client_name": {
25
- "desc": "client (who the lobbying is for; substring match)"
26
- },
27
- "client_id": {
28
- "desc": "client id"
29
- },
30
- "client_state": {
31
- "desc": "client state, two-letter code"
32
- },
33
- "client_country": {
34
- "desc": "client country code, e.g. US, CN"
35
- },
36
- "lobbyist_name": {
37
- "desc": "lobbyist name (substring)"
38
- },
39
- "lobbyist_covered_position": {
40
- "desc": "former covered government position text, e.g. Chief of Staff"
41
- },
42
- "filing_specific_lobbying_issues": {
43
- "desc": "words in the specific-issues text, e.g. semiconductor or H.R. 4763"
44
- },
45
- "foreign_entity_name": {
46
- "desc": "foreign entity name"
47
- },
48
- "foreign_entity_country": {
49
- "desc": "two-letter country code"
50
- },
51
- "affiliated_organization_name": {
52
- "desc": "affiliated organization"
53
- },
54
- "filing_amount_reported_min": {
55
- "desc": "income or expenses at least (dollars)"
56
- },
57
- "filing_amount_reported_max": {
58
- "desc": "income or expenses at most (dollars)"
59
- },
60
- "filing_dt_posted_after": {
61
- "desc": "posted on or after YYYY-MM-DD"
62
- },
63
- "filing_dt_posted_before": {
64
- "desc": "posted on or before YYYY-MM-DD"
65
- },
66
- "ordering": {
67
- "desc": "e.g. -dt_posted, filing_year, registrant__name"
68
- },
69
- "client_ppb_state": {
70
- "desc": "client principal place of business state"
71
- },
72
- "lobbyist_conviction_disclosure_indicator": {
73
- "desc": "true = a listed lobbyist disclosed a conviction"
74
- },
75
- "foreign_entity_listed_indicator": {
76
- "desc": "true = the filing lists a foreign entity"
77
- }
78
- },
79
- "defaults": {
80
- "page_size": 25
81
- },
82
- "records": "results",
83
- "total": "count",
84
- "paging": {
85
- "type": "link",
86
- "next": "next"
87
- },
88
- "max_rows": 20000
89
- },
90
- "filing_activities": {
91
- "path": "/filings/",
92
- "method": "GET",
93
- "description": "The same filings, one row per lobbying activity (issue code, specific issues text, lobbyists, government entities contacted). Optional issue_code filters client-side (the API has no issue filter).",
94
- "params": {
95
- "filing_year": {
96
- "desc": "year, e.g. 2024"
97
- },
98
- "filing_period": {
99
- "desc": "first_quarter | second_quarter | third_quarter | fourth_quarter | mid_year | year_end (older semiannual reports)"
100
- },
101
- "filing_type": {
102
- "desc": "code, e.g. Q1, 1A (Q1 amendment), RR (registration); endpoint filing_types lists all"
103
- },
104
- "registrant_name": {
105
- "desc": "lobbying firm or self-filing organization (substring match)"
106
- },
107
- "registrant_id": {
108
- "desc": "registrant id"
109
- },
110
- "client_name": {
111
- "desc": "client (who the lobbying is for; substring match)"
112
- },
113
- "client_id": {
114
- "desc": "client id"
115
- },
116
- "client_state": {
117
- "desc": "client state, two-letter code"
118
- },
119
- "client_country": {
120
- "desc": "client country code, e.g. US, CN"
121
- },
122
- "lobbyist_name": {
123
- "desc": "lobbyist name (substring)"
124
- },
125
- "lobbyist_covered_position": {
126
- "desc": "former covered government position text, e.g. Chief of Staff"
127
- },
128
- "filing_specific_lobbying_issues": {
129
- "desc": "words in the specific-issues text, e.g. semiconductor or H.R. 4763"
130
- },
131
- "foreign_entity_name": {
132
- "desc": "foreign entity name"
133
- },
134
- "foreign_entity_country": {
135
- "desc": "two-letter country code"
136
- },
137
- "affiliated_organization_name": {
138
- "desc": "affiliated organization"
139
- },
140
- "filing_amount_reported_min": {
141
- "desc": "income or expenses at least (dollars)"
142
- },
143
- "filing_amount_reported_max": {
144
- "desc": "income or expenses at most (dollars)"
145
- },
146
- "filing_dt_posted_after": {
147
- "desc": "posted on or after YYYY-MM-DD"
148
- },
149
- "filing_dt_posted_before": {
150
- "desc": "posted on or before YYYY-MM-DD"
151
- },
152
- "ordering": {
153
- "desc": "e.g. -dt_posted, filing_year, registrant__name"
154
- },
155
- "issue_code": {
156
- "desc": "general issue code kept after download, e.g. TAX, HCR, TRD (filter applied by the pack)"
157
- },
158
- "client_ppb_state": {
159
- "desc": "client principal place of business state"
160
- },
161
- "lobbyist_conviction_disclosure_indicator": {
162
- "desc": "true = a listed lobbyist disclosed a conviction"
163
- },
164
- "foreign_entity_listed_indicator": {
165
- "desc": "true = the filing lists a foreign entity"
166
- }
167
- },
168
- "defaults": {
169
- "page_size": 25
170
- },
171
- "records": "results",
172
- "total": "count",
173
- "paging": {
174
- "type": "link",
175
- "next": "next"
176
- },
177
- "max_rows": 20000
178
- },
179
- "filing": {
180
- "path": "/filings/{filing_uuid}/",
181
- "method": "GET",
182
- "description": "One filing with every field.",
183
- "params": {
184
- "filing_uuid": {
185
- "in": "path",
186
- "required": true,
187
- "desc": "filing uuid"
188
- }
189
- },
190
- "records": "",
191
- "paging": {
192
- "type": "none"
193
- }
194
- },
195
- "contributions": {
196
- "path": "/contributions/",
197
- "method": "GET",
198
- "description": "LD-203 contribution reports (semiannual): one row per contribution item (contributor, payee, honoree, amount, date); reports with no contributions give one row with no_contributions=True.",
199
- "params": {
200
- "filing_year": {
201
- "desc": "year"
202
- },
203
- "filing_period": {
204
- "desc": "mid_year | year_end"
205
- },
206
- "filing_type": {
207
- "desc": "MM (mid-year) | YE (year-end) and amendments"
208
- },
209
- "registrant_name": {
210
- "desc": "registrant (substring)"
211
- },
212
- "registrant_id": {
213
- "desc": "registrant id"
214
- },
215
- "lobbyist_name": {
216
- "desc": "lobbyist (substring)"
217
- },
218
- "lobbyist_id": {
219
- "desc": "lobbyist id"
220
- },
221
- "contribution_contributor": {
222
- "desc": "contributor name"
223
- },
224
- "contribution_payee": {
225
- "desc": "payee name, e.g. a campaign committee"
226
- },
227
- "contribution_honoree": {
228
- "desc": "honoree name, e.g. a member of Congress"
229
- },
230
- "contribution_type": {
231
- "desc": "feca | he (honorary expense) | me (meeting expense) | ple (presidential library) | pic (inaugural committee)"
232
- },
233
- "contribution_amount_min": {
234
- "desc": "item amount at least"
235
- },
236
- "contribution_amount_max": {
237
- "desc": "item amount at most"
238
- },
239
- "contribution_date_after": {
240
- "desc": "YYYY-MM-DD"
241
- },
242
- "contribution_date_before": {
243
- "desc": "YYYY-MM-DD"
244
- },
245
- "filing_dt_posted_after": {
246
- "desc": "YYYY-MM-DD"
247
- },
248
- "filing_dt_posted_before": {
249
- "desc": "YYYY-MM-DD"
250
- }
251
- },
252
- "defaults": {
253
- "page_size": 25
254
- },
255
- "records": "results",
256
- "total": "count",
257
- "paging": {
258
- "type": "link",
259
- "next": "next"
260
- },
261
- "max_rows": 20000
262
- },
263
- "registrants": {
264
- "path": "/registrants/",
265
- "method": "GET",
266
- "description": "Registrants (lobbying firms and self-filers).",
267
- "params": {
268
- "registrant_name": {
269
- "desc": "name (substring)"
270
- },
271
- "id": {
272
- "desc": "registrant id (registrant_id is accepted and sent as id)"
273
- },
274
- "state": {
275
- "desc": "two-letter"
276
- }
277
- },
278
- "defaults": {
279
- "page_size": 25
280
- },
281
- "records": "results",
282
- "total": "count",
283
- "paging": {
284
- "type": "link",
285
- "next": "next"
286
- },
287
- "max_rows": 20000
288
- },
289
- "clients": {
290
- "path": "/clients/",
291
- "method": "GET",
292
- "description": "Clients (organizations on whose behalf lobbying is done).",
293
- "params": {
294
- "client_name": {
295
- "desc": "name (substring)"
296
- },
297
- "id": {
298
- "desc": "client id (client_id is accepted and sent as id)"
299
- },
300
- "client_state": {
301
- "desc": "two-letter (state is accepted and sent as client_state)"
302
- },
303
- "registrant_name": {
304
- "desc": "registrant"
305
- }
306
- },
307
- "defaults": {
308
- "page_size": 25
309
- },
310
- "records": "results",
311
- "total": "count",
312
- "paging": {
313
- "type": "link",
314
- "next": "next"
315
- },
316
- "max_rows": 20000
317
- },
318
- "lobbyists": {
319
- "path": "/lobbyists/",
320
- "method": "GET",
321
- "description": "Individual lobbyists and their registrants.",
322
- "params": {
323
- "lobbyist_name": {
324
- "desc": "name (substring)"
325
- },
326
- "registrant_name": {
327
- "desc": "registrant"
328
- }
329
- },
330
- "defaults": {
331
- "page_size": 25
332
- },
333
- "records": "results",
334
- "total": "count",
335
- "paging": {
336
- "type": "link",
337
- "next": "next"
338
- },
339
- "max_rows": 20000
340
- },
341
- "issue_codes": {
342
- "path": "/constants/filing/lobbyingactivityissues/",
343
- "method": "GET",
344
- "description": "General issue codes (value, name).",
345
- "params": {},
346
- "records": "",
347
- "paging": {
348
- "type": "none"
349
- }
350
- },
351
- "filing_types": {
352
- "path": "/constants/filing/filingtypes/",
353
- "method": "GET",
354
- "description": "Filing type codes (value, name), amendments and terminations included.",
355
- "params": {},
356
- "records": "",
357
- "paging": {
358
- "type": "none"
359
- }
360
- },
361
- "government_entities": {
362
- "path": "/constants/filing/governmententities/",
363
- "method": "GET",
364
- "description": "Government entities that can be listed as contacted.",
365
- "params": {},
366
- "records": "",
367
- "paging": {
368
- "type": "none"
369
- }
370
- }
371
- },
372
- "catalog": {
373
- "hcr": {
374
- "id": "HCR",
375
- "name": "Health Issues",
376
- "description": "general issue code HCR: Health Issues (use issue_code with filing_activities)",
377
- "endpoint": "filing_activities"
378
- },
379
- "mmm": {
380
- "id": "MMM",
381
- "name": "Medicare/Medicaid",
382
- "description": "general issue code MMM: Medicare/Medicaid (use issue_code with filing_activities)",
383
- "endpoint": "filing_activities"
384
- },
385
- "pha": {
386
- "id": "PHA",
387
- "name": "Pharmacy",
388
- "description": "general issue code PHA: Pharmacy (use issue_code with filing_activities)",
389
- "endpoint": "filing_activities"
390
- },
391
- "tax": {
392
- "id": "TAX",
393
- "name": "Taxation/Internal Revenue Code",
394
- "description": "general issue code TAX: Taxation/Internal Revenue Code (use issue_code with filing_activities)",
395
- "endpoint": "filing_activities"
396
- },
397
- "bud": {
398
- "id": "BUD",
399
- "name": "Budget/Appropriations",
400
- "description": "general issue code BUD: Budget/Appropriations (use issue_code with filing_activities)",
401
- "endpoint": "filing_activities"
402
- },
403
- "def": {
404
- "id": "DEF",
405
- "name": "Defense",
406
- "description": "general issue code DEF: Defense (use issue_code with filing_activities)",
407
- "endpoint": "filing_activities"
408
- },
409
- "env": {
410
- "id": "ENV",
411
- "name": "Environment/Superfund",
412
- "description": "general issue code ENV: Environment/Superfund (use issue_code with filing_activities)",
413
- "endpoint": "filing_activities"
414
- },
415
- "eng": {
416
- "id": "ENG",
417
- "name": "Energy/Nuclear",
418
- "description": "general issue code ENG: Energy/Nuclear (use issue_code with filing_activities)",
419
- "endpoint": "filing_activities"
420
- },
421
- "fue": {
422
- "id": "FUE",
423
- "name": "Fuel/Gas/Oil",
424
- "description": "general issue code FUE: Fuel/Gas/Oil (use issue_code with filing_activities)",
425
- "endpoint": "filing_activities"
426
- },
427
- "trd": {
428
- "id": "TRD",
429
- "name": "Trade (domestic/foreign)",
430
- "description": "general issue code TRD: Trade (domestic/foreign) (use issue_code with filing_activities)",
431
- "endpoint": "filing_activities"
432
- },
433
- "fin": {
434
- "id": "FIN",
435
- "name": "Financial Institutions/Investments/Securities",
436
- "description": "general issue code FIN: Financial Institutions/Investments/Securities (use issue_code with filing_activities)",
437
- "endpoint": "filing_activities"
438
- },
439
- "ban": {
440
- "id": "BAN",
441
- "name": "Banking",
442
- "description": "general issue code BAN: Banking (use issue_code with filing_activities)",
443
- "endpoint": "filing_activities"
444
- },
445
- "sci": {
446
- "id": "SCI",
447
- "name": "Science/Technology",
448
- "description": "general issue code SCI: Science/Technology (use issue_code with filing_activities)",
449
- "endpoint": "filing_activities"
450
- },
451
- "tec": {
452
- "id": "TEC",
453
- "name": "Telecommunications",
454
- "description": "general issue code TEC: Telecommunications (use issue_code with filing_activities)",
455
- "endpoint": "filing_activities"
456
- },
457
- "cpi": {
458
- "id": "CPI",
459
- "name": "Computer Industry",
460
- "description": "general issue code CPI: Computer Industry (use issue_code with filing_activities)",
461
- "endpoint": "filing_activities"
462
- },
463
- "edu": {
464
- "id": "EDU",
465
- "name": "Education",
466
- "description": "general issue code EDU: Education (use issue_code with filing_activities)",
467
- "endpoint": "filing_activities"
468
- },
469
- "imm": {
470
- "id": "IMM",
471
- "name": "Immigration",
472
- "description": "general issue code IMM: Immigration (use issue_code with filing_activities)",
473
- "endpoint": "filing_activities"
474
- },
475
- "lbr": {
476
- "id": "LBR",
477
- "name": "Labor Issues/Antitrust/Workplace",
478
- "description": "general issue code LBR: Labor Issues/Antitrust/Workplace (use issue_code with filing_activities)",
479
- "endpoint": "filing_activities"
480
- },
481
- "tra": {
482
- "id": "TRA",
483
- "name": "Transportation",
484
- "description": "general issue code TRA: Transportation (use issue_code with filing_activities)",
485
- "endpoint": "filing_activities"
486
- },
487
- "agr": {
488
- "id": "AGR",
489
- "name": "Agriculture",
490
- "description": "general issue code AGR: Agriculture (use issue_code with filing_activities)",
491
- "endpoint": "filing_activities"
492
- },
493
- "hou": {
494
- "id": "HOU",
495
- "name": "Housing",
496
- "description": "general issue code HOU: Housing (use issue_code with filing_activities)",
497
- "endpoint": "filing_activities"
498
- },
499
- "csp": {
500
- "id": "CSP",
501
- "name": "Consumer Issues/Safety/Products",
502
- "description": "general issue code CSP: Consumer Issues/Safety/Products (use issue_code with filing_activities)",
503
- "endpoint": "filing_activities"
504
- },
505
- "gov": {
506
- "id": "GOV",
507
- "name": "Government Issues",
508
- "description": "general issue code GOV: Government Issues (use issue_code with filing_activities)",
509
- "endpoint": "filing_activities"
510
- },
511
- "law": {
512
- "id": "LAW",
513
- "name": "Law Enforcement/Crime/Criminal Justice",
514
- "description": "general issue code LAW: Law Enforcement/Crime/Criminal Justice (use issue_code with filing_activities)",
515
- "endpoint": "filing_activities"
516
- },
517
- "hom": {
518
- "id": "HOM",
519
- "name": "Homeland Security",
520
- "description": "general issue code HOM: Homeland Security (use issue_code with filing_activities)",
521
- "endpoint": "filing_activities"
522
- },
523
- "ins": {
524
- "id": "INS",
525
- "name": "Insurance",
526
- "description": "general issue code INS: Insurance (use issue_code with filing_activities)",
527
- "endpoint": "filing_activities"
528
- },
529
- "cpt": {
530
- "id": "CPT",
531
- "name": "Copyright/Patent/Trademark",
532
- "description": "general issue code CPT: Copyright/Patent/Trademark (use issue_code with filing_activities)",
533
- "endpoint": "filing_activities"
534
- },
535
- "ret": {
536
- "id": "RET",
537
- "name": "Retirement",
538
- "description": "general issue code RET: Retirement (use issue_code with filing_activities)",
539
- "endpoint": "filing_activities"
540
- },
541
- "vet": {
542
- "id": "VET",
543
- "name": "Veterans",
544
- "description": "general issue code VET: Veterans (use issue_code with filing_activities)",
545
- "endpoint": "filing_activities"
546
- },
547
- "filing_type_codes": {
548
- "id": "Q1 Q2 Q3 Q4; 1A-4A amendments; 1T-4T terminations; RR registration; RA registration amendment; MM / YE contribution periods",
549
- "name": "Filing types",
550
- "description": "filing_type values; endpoint filing_types lists every code with its name",
551
- "endpoint": "filing_types"
552
- }
553
- }
1
+ {
2
+ "base_url": "https://lda.gov/api/v1",
3
+ "endpoints": {
4
+ "filings": {
5
+ "path": "/filings/",
6
+ "method": "GET",
7
+ "description": "LD-1 registrations and LD-2 quarterly activity reports: one row per filing (registrant, client, income or expenses, period, posted date; activities as JSON).",
8
+ "params": {
9
+ "filing_year": {
10
+ "desc": "year, e.g. 2024"
11
+ },
12
+ "filing_period": {
13
+ "desc": "first_quarter | second_quarter | third_quarter | fourth_quarter | mid_year | year_end (older semiannual reports)"
14
+ },
15
+ "filing_type": {
16
+ "desc": "code, e.g. Q1, 1A (Q1 amendment), RR (registration); endpoint filing_types lists all"
17
+ },
18
+ "registrant_name": {
19
+ "desc": "lobbying firm or self-filing organization (substring match)"
20
+ },
21
+ "registrant_id": {
22
+ "desc": "registrant id"
23
+ },
24
+ "client_name": {
25
+ "desc": "client (who the lobbying is for; substring match)"
26
+ },
27
+ "client_id": {
28
+ "desc": "client id"
29
+ },
30
+ "client_state": {
31
+ "desc": "client state, two-letter code"
32
+ },
33
+ "client_country": {
34
+ "desc": "client country code, e.g. US, CN"
35
+ },
36
+ "lobbyist_name": {
37
+ "desc": "lobbyist name (substring)"
38
+ },
39
+ "lobbyist_covered_position": {
40
+ "desc": "former covered government position text, e.g. Chief of Staff"
41
+ },
42
+ "filing_specific_lobbying_issues": {
43
+ "desc": "words in the specific-issues text, e.g. semiconductor or H.R. 4763"
44
+ },
45
+ "foreign_entity_name": {
46
+ "desc": "foreign entity name"
47
+ },
48
+ "foreign_entity_country": {
49
+ "desc": "two-letter country code"
50
+ },
51
+ "affiliated_organization_name": {
52
+ "desc": "affiliated organization"
53
+ },
54
+ "filing_amount_reported_min": {
55
+ "desc": "income or expenses at least (dollars)"
56
+ },
57
+ "filing_amount_reported_max": {
58
+ "desc": "income or expenses at most (dollars)"
59
+ },
60
+ "filing_dt_posted_after": {
61
+ "desc": "posted on or after YYYY-MM-DD"
62
+ },
63
+ "filing_dt_posted_before": {
64
+ "desc": "posted on or before YYYY-MM-DD"
65
+ },
66
+ "ordering": {
67
+ "desc": "e.g. -dt_posted, filing_year, registrant__name"
68
+ },
69
+ "client_ppb_state": {
70
+ "desc": "client principal place of business state"
71
+ },
72
+ "lobbyist_conviction_disclosure_indicator": {
73
+ "desc": "true = a listed lobbyist disclosed a conviction"
74
+ },
75
+ "foreign_entity_listed_indicator": {
76
+ "desc": "true = the filing lists a foreign entity"
77
+ }
78
+ },
79
+ "defaults": {
80
+ "page_size": 25
81
+ },
82
+ "records": "results",
83
+ "total": "count",
84
+ "paging": {
85
+ "type": "link",
86
+ "next": "next"
87
+ },
88
+ "max_rows": 20000
89
+ },
90
+ "filing_activities": {
91
+ "path": "/filings/",
92
+ "method": "GET",
93
+ "description": "The same filings, one row per lobbying activity (issue code, specific issues text, lobbyists, government entities contacted). Optional issue_code filters client-side (the API has no issue filter).",
94
+ "params": {
95
+ "filing_year": {
96
+ "desc": "year, e.g. 2024"
97
+ },
98
+ "filing_period": {
99
+ "desc": "first_quarter | second_quarter | third_quarter | fourth_quarter | mid_year | year_end (older semiannual reports)"
100
+ },
101
+ "filing_type": {
102
+ "desc": "code, e.g. Q1, 1A (Q1 amendment), RR (registration); endpoint filing_types lists all"
103
+ },
104
+ "registrant_name": {
105
+ "desc": "lobbying firm or self-filing organization (substring match)"
106
+ },
107
+ "registrant_id": {
108
+ "desc": "registrant id"
109
+ },
110
+ "client_name": {
111
+ "desc": "client (who the lobbying is for; substring match)"
112
+ },
113
+ "client_id": {
114
+ "desc": "client id"
115
+ },
116
+ "client_state": {
117
+ "desc": "client state, two-letter code"
118
+ },
119
+ "client_country": {
120
+ "desc": "client country code, e.g. US, CN"
121
+ },
122
+ "lobbyist_name": {
123
+ "desc": "lobbyist name (substring)"
124
+ },
125
+ "lobbyist_covered_position": {
126
+ "desc": "former covered government position text, e.g. Chief of Staff"
127
+ },
128
+ "filing_specific_lobbying_issues": {
129
+ "desc": "words in the specific-issues text, e.g. semiconductor or H.R. 4763"
130
+ },
131
+ "foreign_entity_name": {
132
+ "desc": "foreign entity name"
133
+ },
134
+ "foreign_entity_country": {
135
+ "desc": "two-letter country code"
136
+ },
137
+ "affiliated_organization_name": {
138
+ "desc": "affiliated organization"
139
+ },
140
+ "filing_amount_reported_min": {
141
+ "desc": "income or expenses at least (dollars)"
142
+ },
143
+ "filing_amount_reported_max": {
144
+ "desc": "income or expenses at most (dollars)"
145
+ },
146
+ "filing_dt_posted_after": {
147
+ "desc": "posted on or after YYYY-MM-DD"
148
+ },
149
+ "filing_dt_posted_before": {
150
+ "desc": "posted on or before YYYY-MM-DD"
151
+ },
152
+ "ordering": {
153
+ "desc": "e.g. -dt_posted, filing_year, registrant__name"
154
+ },
155
+ "issue_code": {
156
+ "desc": "general issue code kept after download, e.g. TAX, HCR, TRD (filter applied by the pack)"
157
+ },
158
+ "client_ppb_state": {
159
+ "desc": "client principal place of business state"
160
+ },
161
+ "lobbyist_conviction_disclosure_indicator": {
162
+ "desc": "true = a listed lobbyist disclosed a conviction"
163
+ },
164
+ "foreign_entity_listed_indicator": {
165
+ "desc": "true = the filing lists a foreign entity"
166
+ }
167
+ },
168
+ "defaults": {
169
+ "page_size": 25
170
+ },
171
+ "records": "results",
172
+ "total": "count",
173
+ "paging": {
174
+ "type": "link",
175
+ "next": "next"
176
+ },
177
+ "max_rows": 20000
178
+ },
179
+ "filing": {
180
+ "path": "/filings/{filing_uuid}/",
181
+ "method": "GET",
182
+ "description": "One filing with every field.",
183
+ "params": {
184
+ "filing_uuid": {
185
+ "in": "path",
186
+ "required": true,
187
+ "desc": "filing uuid"
188
+ }
189
+ },
190
+ "records": "",
191
+ "paging": {
192
+ "type": "none"
193
+ }
194
+ },
195
+ "contributions": {
196
+ "path": "/contributions/",
197
+ "method": "GET",
198
+ "description": "LD-203 contribution reports (semiannual): one row per contribution item (contributor, payee, honoree, amount, date); reports with no contributions give one row with no_contributions=True.",
199
+ "params": {
200
+ "filing_year": {
201
+ "desc": "year"
202
+ },
203
+ "filing_period": {
204
+ "desc": "mid_year | year_end"
205
+ },
206
+ "filing_type": {
207
+ "desc": "MM (mid-year) | YE (year-end) and amendments"
208
+ },
209
+ "registrant_name": {
210
+ "desc": "registrant (substring)"
211
+ },
212
+ "registrant_id": {
213
+ "desc": "registrant id"
214
+ },
215
+ "lobbyist_name": {
216
+ "desc": "lobbyist (substring)"
217
+ },
218
+ "lobbyist_id": {
219
+ "desc": "lobbyist id"
220
+ },
221
+ "contribution_contributor": {
222
+ "desc": "contributor name"
223
+ },
224
+ "contribution_payee": {
225
+ "desc": "payee name, e.g. a campaign committee"
226
+ },
227
+ "contribution_honoree": {
228
+ "desc": "honoree name, e.g. a member of Congress"
229
+ },
230
+ "contribution_type": {
231
+ "desc": "feca | he (honorary expense) | me (meeting expense) | ple (presidential library) | pic (inaugural committee)"
232
+ },
233
+ "contribution_amount_min": {
234
+ "desc": "item amount at least"
235
+ },
236
+ "contribution_amount_max": {
237
+ "desc": "item amount at most"
238
+ },
239
+ "contribution_date_after": {
240
+ "desc": "YYYY-MM-DD"
241
+ },
242
+ "contribution_date_before": {
243
+ "desc": "YYYY-MM-DD"
244
+ },
245
+ "filing_dt_posted_after": {
246
+ "desc": "YYYY-MM-DD"
247
+ },
248
+ "filing_dt_posted_before": {
249
+ "desc": "YYYY-MM-DD"
250
+ }
251
+ },
252
+ "defaults": {
253
+ "page_size": 25
254
+ },
255
+ "records": "results",
256
+ "total": "count",
257
+ "paging": {
258
+ "type": "link",
259
+ "next": "next"
260
+ },
261
+ "max_rows": 20000
262
+ },
263
+ "registrants": {
264
+ "path": "/registrants/",
265
+ "method": "GET",
266
+ "description": "Registrants (lobbying firms and self-filers).",
267
+ "params": {
268
+ "registrant_name": {
269
+ "desc": "name (substring)"
270
+ },
271
+ "id": {
272
+ "desc": "registrant id (registrant_id is accepted and sent as id)"
273
+ },
274
+ "state": {
275
+ "desc": "two-letter"
276
+ }
277
+ },
278
+ "defaults": {
279
+ "page_size": 25
280
+ },
281
+ "records": "results",
282
+ "total": "count",
283
+ "paging": {
284
+ "type": "link",
285
+ "next": "next"
286
+ },
287
+ "max_rows": 20000
288
+ },
289
+ "clients": {
290
+ "path": "/clients/",
291
+ "method": "GET",
292
+ "description": "Clients (organizations on whose behalf lobbying is done).",
293
+ "params": {
294
+ "client_name": {
295
+ "desc": "name (substring)"
296
+ },
297
+ "id": {
298
+ "desc": "client id (client_id is accepted and sent as id)"
299
+ },
300
+ "client_state": {
301
+ "desc": "two-letter (state is accepted and sent as client_state)"
302
+ },
303
+ "registrant_name": {
304
+ "desc": "registrant"
305
+ }
306
+ },
307
+ "defaults": {
308
+ "page_size": 25
309
+ },
310
+ "records": "results",
311
+ "total": "count",
312
+ "paging": {
313
+ "type": "link",
314
+ "next": "next"
315
+ },
316
+ "max_rows": 20000
317
+ },
318
+ "lobbyists": {
319
+ "path": "/lobbyists/",
320
+ "method": "GET",
321
+ "description": "Individual lobbyists and their registrants.",
322
+ "params": {
323
+ "lobbyist_name": {
324
+ "desc": "name (substring)"
325
+ },
326
+ "registrant_name": {
327
+ "desc": "registrant"
328
+ }
329
+ },
330
+ "defaults": {
331
+ "page_size": 25
332
+ },
333
+ "records": "results",
334
+ "total": "count",
335
+ "paging": {
336
+ "type": "link",
337
+ "next": "next"
338
+ },
339
+ "max_rows": 20000
340
+ },
341
+ "issue_codes": {
342
+ "path": "/constants/filing/lobbyingactivityissues/",
343
+ "method": "GET",
344
+ "description": "General issue codes (value, name).",
345
+ "params": {},
346
+ "records": "",
347
+ "paging": {
348
+ "type": "none"
349
+ }
350
+ },
351
+ "filing_types": {
352
+ "path": "/constants/filing/filingtypes/",
353
+ "method": "GET",
354
+ "description": "Filing type codes (value, name), amendments and terminations included.",
355
+ "params": {},
356
+ "records": "",
357
+ "paging": {
358
+ "type": "none"
359
+ }
360
+ },
361
+ "government_entities": {
362
+ "path": "/constants/filing/governmententities/",
363
+ "method": "GET",
364
+ "description": "Government entities that can be listed as contacted.",
365
+ "params": {},
366
+ "records": "",
367
+ "paging": {
368
+ "type": "none"
369
+ }
370
+ }
371
+ },
372
+ "catalog": {
373
+ "hcr": {
374
+ "id": "HCR",
375
+ "name": "Health Issues",
376
+ "description": "general issue code HCR: Health Issues (use issue_code with filing_activities)",
377
+ "endpoint": "filing_activities"
378
+ },
379
+ "mmm": {
380
+ "id": "MMM",
381
+ "name": "Medicare/Medicaid",
382
+ "description": "general issue code MMM: Medicare/Medicaid (use issue_code with filing_activities)",
383
+ "endpoint": "filing_activities"
384
+ },
385
+ "pha": {
386
+ "id": "PHA",
387
+ "name": "Pharmacy",
388
+ "description": "general issue code PHA: Pharmacy (use issue_code with filing_activities)",
389
+ "endpoint": "filing_activities"
390
+ },
391
+ "tax": {
392
+ "id": "TAX",
393
+ "name": "Taxation/Internal Revenue Code",
394
+ "description": "general issue code TAX: Taxation/Internal Revenue Code (use issue_code with filing_activities)",
395
+ "endpoint": "filing_activities"
396
+ },
397
+ "bud": {
398
+ "id": "BUD",
399
+ "name": "Budget/Appropriations",
400
+ "description": "general issue code BUD: Budget/Appropriations (use issue_code with filing_activities)",
401
+ "endpoint": "filing_activities"
402
+ },
403
+ "def": {
404
+ "id": "DEF",
405
+ "name": "Defense",
406
+ "description": "general issue code DEF: Defense (use issue_code with filing_activities)",
407
+ "endpoint": "filing_activities"
408
+ },
409
+ "env": {
410
+ "id": "ENV",
411
+ "name": "Environment/Superfund",
412
+ "description": "general issue code ENV: Environment/Superfund (use issue_code with filing_activities)",
413
+ "endpoint": "filing_activities"
414
+ },
415
+ "eng": {
416
+ "id": "ENG",
417
+ "name": "Energy/Nuclear",
418
+ "description": "general issue code ENG: Energy/Nuclear (use issue_code with filing_activities)",
419
+ "endpoint": "filing_activities"
420
+ },
421
+ "fue": {
422
+ "id": "FUE",
423
+ "name": "Fuel/Gas/Oil",
424
+ "description": "general issue code FUE: Fuel/Gas/Oil (use issue_code with filing_activities)",
425
+ "endpoint": "filing_activities"
426
+ },
427
+ "trd": {
428
+ "id": "TRD",
429
+ "name": "Trade (domestic/foreign)",
430
+ "description": "general issue code TRD: Trade (domestic/foreign) (use issue_code with filing_activities)",
431
+ "endpoint": "filing_activities"
432
+ },
433
+ "fin": {
434
+ "id": "FIN",
435
+ "name": "Financial Institutions/Investments/Securities",
436
+ "description": "general issue code FIN: Financial Institutions/Investments/Securities (use issue_code with filing_activities)",
437
+ "endpoint": "filing_activities"
438
+ },
439
+ "ban": {
440
+ "id": "BAN",
441
+ "name": "Banking",
442
+ "description": "general issue code BAN: Banking (use issue_code with filing_activities)",
443
+ "endpoint": "filing_activities"
444
+ },
445
+ "sci": {
446
+ "id": "SCI",
447
+ "name": "Science/Technology",
448
+ "description": "general issue code SCI: Science/Technology (use issue_code with filing_activities)",
449
+ "endpoint": "filing_activities"
450
+ },
451
+ "tec": {
452
+ "id": "TEC",
453
+ "name": "Telecommunications",
454
+ "description": "general issue code TEC: Telecommunications (use issue_code with filing_activities)",
455
+ "endpoint": "filing_activities"
456
+ },
457
+ "cpi": {
458
+ "id": "CPI",
459
+ "name": "Computer Industry",
460
+ "description": "general issue code CPI: Computer Industry (use issue_code with filing_activities)",
461
+ "endpoint": "filing_activities"
462
+ },
463
+ "edu": {
464
+ "id": "EDU",
465
+ "name": "Education",
466
+ "description": "general issue code EDU: Education (use issue_code with filing_activities)",
467
+ "endpoint": "filing_activities"
468
+ },
469
+ "imm": {
470
+ "id": "IMM",
471
+ "name": "Immigration",
472
+ "description": "general issue code IMM: Immigration (use issue_code with filing_activities)",
473
+ "endpoint": "filing_activities"
474
+ },
475
+ "lbr": {
476
+ "id": "LBR",
477
+ "name": "Labor Issues/Antitrust/Workplace",
478
+ "description": "general issue code LBR: Labor Issues/Antitrust/Workplace (use issue_code with filing_activities)",
479
+ "endpoint": "filing_activities"
480
+ },
481
+ "tra": {
482
+ "id": "TRA",
483
+ "name": "Transportation",
484
+ "description": "general issue code TRA: Transportation (use issue_code with filing_activities)",
485
+ "endpoint": "filing_activities"
486
+ },
487
+ "agr": {
488
+ "id": "AGR",
489
+ "name": "Agriculture",
490
+ "description": "general issue code AGR: Agriculture (use issue_code with filing_activities)",
491
+ "endpoint": "filing_activities"
492
+ },
493
+ "hou": {
494
+ "id": "HOU",
495
+ "name": "Housing",
496
+ "description": "general issue code HOU: Housing (use issue_code with filing_activities)",
497
+ "endpoint": "filing_activities"
498
+ },
499
+ "csp": {
500
+ "id": "CSP",
501
+ "name": "Consumer Issues/Safety/Products",
502
+ "description": "general issue code CSP: Consumer Issues/Safety/Products (use issue_code with filing_activities)",
503
+ "endpoint": "filing_activities"
504
+ },
505
+ "gov": {
506
+ "id": "GOV",
507
+ "name": "Government Issues",
508
+ "description": "general issue code GOV: Government Issues (use issue_code with filing_activities)",
509
+ "endpoint": "filing_activities"
510
+ },
511
+ "law": {
512
+ "id": "LAW",
513
+ "name": "Law Enforcement/Crime/Criminal Justice",
514
+ "description": "general issue code LAW: Law Enforcement/Crime/Criminal Justice (use issue_code with filing_activities)",
515
+ "endpoint": "filing_activities"
516
+ },
517
+ "hom": {
518
+ "id": "HOM",
519
+ "name": "Homeland Security",
520
+ "description": "general issue code HOM: Homeland Security (use issue_code with filing_activities)",
521
+ "endpoint": "filing_activities"
522
+ },
523
+ "ins": {
524
+ "id": "INS",
525
+ "name": "Insurance",
526
+ "description": "general issue code INS: Insurance (use issue_code with filing_activities)",
527
+ "endpoint": "filing_activities"
528
+ },
529
+ "cpt": {
530
+ "id": "CPT",
531
+ "name": "Copyright/Patent/Trademark",
532
+ "description": "general issue code CPT: Copyright/Patent/Trademark (use issue_code with filing_activities)",
533
+ "endpoint": "filing_activities"
534
+ },
535
+ "ret": {
536
+ "id": "RET",
537
+ "name": "Retirement",
538
+ "description": "general issue code RET: Retirement (use issue_code with filing_activities)",
539
+ "endpoint": "filing_activities"
540
+ },
541
+ "vet": {
542
+ "id": "VET",
543
+ "name": "Veterans",
544
+ "description": "general issue code VET: Veterans (use issue_code with filing_activities)",
545
+ "endpoint": "filing_activities"
546
+ },
547
+ "filing_type_codes": {
548
+ "id": "Q1 Q2 Q3 Q4; 1A-4A amendments; 1T-4T terminations; RR registration; RA registration amendment; MM / YE contribution periods",
549
+ "name": "Filing types",
550
+ "description": "filing_type values; endpoint filing_types lists every code with its name",
551
+ "endpoint": "filing_types"
552
+ }
553
+ }
554
554
  }