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,708 +1,708 @@
1
- {
2
- "base_url": "https://api.open.fec.gov/v1",
3
- "endpoints": {
4
- "candidates_search": {
5
- "path": "/candidates/search/",
6
- "method": "GET",
7
- "description": "Find candidates by name, state, office, party or election year.",
8
- "params": {
9
- "q": {
10
- "desc": "name words, e.g. casey"
11
- },
12
- "state": {
13
- "desc": "two-letter"
14
- },
15
- "office": {
16
- "desc": "H | S | P",
17
- "enum": [
18
- "H",
19
- "S",
20
- "P"
21
- ]
22
- },
23
- "party": {
24
- "desc": "DEM | REP | LIB | GRE | IND ..."
25
- },
26
- "election_year": {
27
- "desc": "e.g. 2024"
28
- },
29
- "cycle": {
30
- "desc": "two-year period ending in an even year, e.g. 2024"
31
- },
32
- "district": {
33
- "desc": "two digits, e.g. 07"
34
- },
35
- "incumbent_challenge": {
36
- "desc": "I | C | O (open seat)"
37
- },
38
- "candidate_status": {
39
- "desc": "C current | F future | N not yet | P prior"
40
- },
41
- "has_raised_funds": {
42
- "desc": "true"
43
- }
44
- },
45
- "records": "results",
46
- "total": "pagination.count",
47
- "paging": {
48
- "type": "page",
49
- "page_param": "page",
50
- "size_param": "per_page",
51
- "size": 100,
52
- "start": 1
53
- },
54
- "max_rows": 50000,
55
- "defaults": {
56
- "sort": "name"
57
- }
58
- },
59
- "candidate": {
60
- "path": "/candidate/{candidate_id}/",
61
- "method": "GET",
62
- "description": "One candidate's record (party, office, cycles, principal committees).",
63
- "params": {
64
- "candidate_id": {
65
- "in": "path",
66
- "required": true,
67
- "desc": "e.g. S6PA00217 (H, S or P + state + digits)"
68
- }
69
- },
70
- "records": "results",
71
- "total": "pagination.count",
72
- "paging": {
73
- "type": "page",
74
- "page_param": "page",
75
- "size_param": "per_page",
76
- "size": 100,
77
- "start": 1
78
- },
79
- "max_rows": 50000
80
- },
81
- "candidate_totals": {
82
- "path": "/candidate/{candidate_id}/totals/",
83
- "method": "GET",
84
- "description": "A candidate's financial totals per cycle (receipts, disbursements, cash, debts, contributions by source).",
85
- "params": {
86
- "candidate_id": {
87
- "in": "path",
88
- "required": true,
89
- "desc": "candidate id"
90
- },
91
- "cycle": {
92
- "desc": "two-year period ending in an even year, e.g. 2024"
93
- },
94
- "election_full": {
95
- "desc": "true (default) = whole election period (6 years for Senate, 4 for President); false = the two-year cycle"
96
- }
97
- },
98
- "records": "results",
99
- "total": "pagination.count",
100
- "paging": {
101
- "type": "page",
102
- "page_param": "page",
103
- "size_param": "per_page",
104
- "size": 100,
105
- "start": 1
106
- },
107
- "max_rows": 50000,
108
- "defaults": {
109
- "election_full": "true"
110
- }
111
- },
112
- "candidates_totals": {
113
- "path": "/candidates/totals/",
114
- "method": "GET",
115
- "description": "Financial totals for every candidate in a race or office (rank by receipts).",
116
- "params": {
117
- "office": {
118
- "desc": "H | S | P",
119
- "enum": [
120
- "H",
121
- "S",
122
- "P"
123
- ]
124
- },
125
- "election_year": {
126
- "desc": "e.g. 2024"
127
- },
128
- "cycle": {
129
- "desc": "two-year period ending in an even year, e.g. 2024"
130
- },
131
- "state": {
132
- "desc": "two-letter"
133
- },
134
- "district": {
135
- "desc": "two digits"
136
- },
137
- "party": {
138
- "desc": "DEM | REP ..."
139
- },
140
- "is_active_candidate": {
141
- "desc": "true = only candidates active in that election"
142
- },
143
- "election_full": {
144
- "desc": "true = whole election period"
145
- },
146
- "sort": {
147
- "desc": "-receipts (default), -disbursements, -cash_on_hand_end_period"
148
- }
149
- },
150
- "records": "results",
151
- "total": "pagination.count",
152
- "paging": {
153
- "type": "page",
154
- "page_param": "page",
155
- "size_param": "per_page",
156
- "size": 100,
157
- "start": 1
158
- },
159
- "max_rows": 50000,
160
- "defaults": {
161
- "sort": "-receipts",
162
- "sort_null_only": "false"
163
- }
164
- },
165
- "elections": {
166
- "path": "/elections/",
167
- "method": "GET",
168
- "description": "Race summary: each candidate's receipts, disbursements and cash for one office, state and district.",
169
- "params": {
170
- "office": {
171
- "required": true,
172
- "desc": "house | senate | president",
173
- "enum": [
174
- "house",
175
- "senate",
176
- "president"
177
- ]
178
- },
179
- "cycle": {
180
- "required": true,
181
- "desc": "election year, e.g. 2024"
182
- },
183
- "state": {
184
- "desc": "two-letter (house, senate)"
185
- },
186
- "district": {
187
- "desc": "two digits (house)"
188
- },
189
- "election_full": {
190
- "desc": "true (default) = whole election period"
191
- }
192
- },
193
- "records": "results",
194
- "total": "pagination.count",
195
- "paging": {
196
- "type": "page",
197
- "page_param": "page",
198
- "size_param": "per_page",
199
- "size": 100,
200
- "start": 1
201
- },
202
- "max_rows": 50000,
203
- "defaults": {
204
- "election_full": "true",
205
- "sort": "-total_receipts"
206
- }
207
- },
208
- "committees": {
209
- "path": "/committees/",
210
- "method": "GET",
211
- "description": "Find committees (campaigns, PACs, super PACs, party committees).",
212
- "params": {
213
- "q": {
214
- "desc": "name words, e.g. pfizer"
215
- },
216
- "committee_type": {
217
- "desc": "P H S (candidate), Q N (PAC), O (super PAC), U (single-candidate IE), V W (hybrid PAC), X Y (party), I (independent expenditure filer)"
218
- },
219
- "designation": {
220
- "desc": "P principal campaign | A authorized | J joint fundraiser | U unauthorized | B lobbyist PAC | D leadership PAC"
221
- },
222
- "organization_type": {
223
- "desc": "C corporation | L labor | M membership | T trade | V cooperative | W corporation without capital stock"
224
- },
225
- "state": {
226
- "desc": "two-letter"
227
- },
228
- "party": {
229
- "desc": "DEM | REP ..."
230
- },
231
- "cycle": {
232
- "desc": "two-year period ending in an even year, e.g. 2024"
233
- }
234
- },
235
- "records": "results",
236
- "total": "pagination.count",
237
- "paging": {
238
- "type": "page",
239
- "page_param": "page",
240
- "size_param": "per_page",
241
- "size": 100,
242
- "start": 1
243
- },
244
- "max_rows": 50000
245
- },
246
- "committee": {
247
- "path": "/committee/{committee_id}/",
248
- "method": "GET",
249
- "description": "One committee's registration details.",
250
- "params": {
251
- "committee_id": {
252
- "in": "path",
253
- "required": true,
254
- "desc": "e.g. C00431056"
255
- }
256
- },
257
- "records": "results",
258
- "total": "pagination.count",
259
- "paging": {
260
- "type": "page",
261
- "page_param": "page",
262
- "size_param": "per_page",
263
- "size": 100,
264
- "start": 1
265
- },
266
- "max_rows": 50000
267
- },
268
- "committee_totals": {
269
- "path": "/committee/{committee_id}/totals/",
270
- "method": "GET",
271
- "description": "A committee's financial totals per two-year cycle.",
272
- "params": {
273
- "committee_id": {
274
- "in": "path",
275
- "required": true,
276
- "desc": "committee id"
277
- },
278
- "cycle": {
279
- "desc": "two-year period ending in an even year, e.g. 2024"
280
- }
281
- },
282
- "records": "results",
283
- "total": "pagination.count",
284
- "paging": {
285
- "type": "page",
286
- "page_param": "page",
287
- "size_param": "per_page",
288
- "size": 100,
289
- "start": 1
290
- },
291
- "max_rows": 50000
292
- },
293
- "schedule_a": {
294
- "path": "/schedules/schedule_a/",
295
- "method": "GET",
296
- "description": "Itemized receipts (Schedule A): contributions with contributor name, employer, occupation, city, state, ZIP, amount, date. Keyset paging; give at least one filter.",
297
- "params": {
298
- "committee_id": {
299
- "desc": "recipient committee id(s)"
300
- },
301
- "contributor_name": {
302
- "desc": "name words"
303
- },
304
- "contributor_employer": {
305
- "desc": "employer words"
306
- },
307
- "contributor_occupation": {
308
- "desc": "occupation words"
309
- },
310
- "contributor_state": {
311
- "desc": "two-letter"
312
- },
313
- "contributor_city": {
314
- "desc": "city"
315
- },
316
- "contributor_zip": {
317
- "desc": "ZIP (5 digits)"
318
- },
319
- "contributor_type": {
320
- "desc": "individual | committee"
321
- },
322
- "is_individual": {
323
- "desc": "true = individuals only (no transfers)"
324
- },
325
- "two_year_transaction_period": {
326
- "desc": "two-year period, e.g. 2024 (recommended; FEC searches the current period without it)"
327
- },
328
- "min_date": {
329
- "desc": "YYYY-MM-DD"
330
- },
331
- "max_date": {
332
- "desc": "YYYY-MM-DD"
333
- },
334
- "min_amount": {
335
- "desc": "dollars"
336
- },
337
- "max_amount": {
338
- "desc": "dollars"
339
- },
340
- "sort": {
341
- "desc": "-contribution_receipt_date (default) | contribution_receipt_amount | -contribution_receipt_amount"
342
- },
343
- "per_page": {
344
- "desc": "rows per request, at most 100 (default 100)"
345
- }
346
- },
347
- "records": "results",
348
- "total": "pagination.count",
349
- "paging": {
350
- "type": "seek",
351
- "size": 100
352
- },
353
- "max_rows": 50000,
354
- "defaults": {
355
- "sort": "-contribution_receipt_date",
356
- "sort_null_only": "false"
357
- }
358
- },
359
- "schedule_b": {
360
- "path": "/schedules/schedule_b/",
361
- "method": "GET",
362
- "description": "Itemized disbursements (Schedule B): recipient, purpose, amount, date. Keyset paging.",
363
- "params": {
364
- "committee_id": {
365
- "desc": "spending committee id(s)"
366
- },
367
- "recipient_name": {
368
- "desc": "recipient words"
369
- },
370
- "recipient_committee_id": {
371
- "desc": "recipient committee id"
372
- },
373
- "recipient_state": {
374
- "desc": "two-letter"
375
- },
376
- "disbursement_description": {
377
- "desc": "purpose words, e.g. media"
378
- },
379
- "two_year_transaction_period": {
380
- "desc": "two-year period, e.g. 2024 (recommended; FEC searches the current period without it)"
381
- },
382
- "min_date": {
383
- "desc": "YYYY-MM-DD"
384
- },
385
- "max_date": {
386
- "desc": "YYYY-MM-DD"
387
- },
388
- "min_amount": {
389
- "desc": "dollars"
390
- },
391
- "max_amount": {
392
- "desc": "dollars"
393
- },
394
- "sort": {
395
- "desc": "-disbursement_date (default) | -disbursement_amount"
396
- },
397
- "per_page": {
398
- "desc": "rows per request, at most 100 (default 100)"
399
- }
400
- },
401
- "records": "results",
402
- "total": "pagination.count",
403
- "paging": {
404
- "type": "seek",
405
- "size": 100
406
- },
407
- "max_rows": 50000,
408
- "defaults": {
409
- "sort": "-disbursement_date",
410
- "sort_null_only": "false"
411
- }
412
- },
413
- "schedule_e": {
414
- "path": "/schedules/schedule_e/",
415
- "method": "GET",
416
- "description": "Independent expenditures (Schedule E): spender, candidate supported or opposed, payee, purpose, amount, date. Keyset paging.",
417
- "params": {
418
- "candidate_id": {
419
- "desc": "candidate id(s)"
420
- },
421
- "committee_id": {
422
- "desc": "spender committee id(s)"
423
- },
424
- "support_oppose_indicator": {
425
- "desc": "S support | O oppose",
426
- "enum": [
427
- "S",
428
- "O"
429
- ]
430
- },
431
- "cycle": {
432
- "desc": "two-year period"
433
- },
434
- "min_date": {
435
- "desc": "YYYY-MM-DD"
436
- },
437
- "max_date": {
438
- "desc": "YYYY-MM-DD"
439
- },
440
- "min_amount": {
441
- "desc": "dollars"
442
- },
443
- "is_notice": {
444
- "desc": "true = 24/48-hour notices only; false = regular reports only"
445
- },
446
- "sort": {
447
- "desc": "-expenditure_date (default) | -expenditure_amount"
448
- },
449
- "per_page": {
450
- "desc": "rows per request, at most 100 (default 100)"
451
- }
452
- },
453
- "records": "results",
454
- "total": "pagination.count",
455
- "paging": {
456
- "type": "seek",
457
- "size": 100
458
- },
459
- "max_rows": 50000,
460
- "defaults": {
461
- "sort": "-expenditure_date",
462
- "sort_null_only": "false"
463
- }
464
- },
465
- "contributions_by_size": {
466
- "path": "/schedules/schedule_a/by_size/by_candidate/",
467
- "method": "GET",
468
- "description": "A candidate's receipts from individuals by contribution size bucket (0 = $200 and under, 200, 500, 1000, 2000).",
469
- "params": {
470
- "candidate_id": {
471
- "required": true,
472
- "desc": "candidate id(s)"
473
- },
474
- "cycle": {
475
- "desc": "two-year period ending in an even year, e.g. 2024"
476
- },
477
- "election_full": {
478
- "desc": "true = whole election period"
479
- }
480
- },
481
- "records": "results",
482
- "total": "pagination.count",
483
- "paging": {
484
- "type": "page",
485
- "page_param": "page",
486
- "size_param": "per_page",
487
- "size": 100,
488
- "start": 1
489
- },
490
- "max_rows": 50000
491
- },
492
- "contributions_by_state": {
493
- "path": "/schedules/schedule_a/by_state/by_candidate/",
494
- "method": "GET",
495
- "description": "A candidate's itemized individual receipts by contributor state.",
496
- "params": {
497
- "candidate_id": {
498
- "required": true,
499
- "desc": "candidate id(s)"
500
- },
501
- "cycle": {
502
- "desc": "two-year period ending in an even year, e.g. 2024"
503
- },
504
- "election_full": {
505
- "desc": "true = whole election period"
506
- }
507
- },
508
- "records": "results",
509
- "total": "pagination.count",
510
- "paging": {
511
- "type": "page",
512
- "page_param": "page",
513
- "size_param": "per_page",
514
- "size": 100,
515
- "start": 1
516
- },
517
- "max_rows": 50000
518
- },
519
- "committee_contributions_by_state": {
520
- "path": "/schedules/schedule_a/by_state/",
521
- "method": "GET",
522
- "description": "A committee's itemized individual receipts by contributor state.",
523
- "params": {
524
- "committee_id": {
525
- "required": true,
526
- "desc": "committee id"
527
- },
528
- "cycle": {
529
- "desc": "two-year period ending in an even year, e.g. 2024"
530
- }
531
- },
532
- "records": "results",
533
- "total": "pagination.count",
534
- "paging": {
535
- "type": "page",
536
- "page_param": "page",
537
- "size_param": "per_page",
538
- "size": 100,
539
- "start": 1
540
- },
541
- "max_rows": 50000
542
- },
543
- "contributions_by_employer": {
544
- "path": "/schedules/schedule_a/by_employer/",
545
- "method": "GET",
546
- "description": "A committee's itemized individual receipts by contributor employer (as written by contributors).",
547
- "params": {
548
- "committee_id": {
549
- "required": true,
550
- "desc": "committee id"
551
- },
552
- "cycle": {
553
- "desc": "two-year period ending in an even year, e.g. 2024"
554
- },
555
- "employer": {
556
- "desc": "employer words"
557
- }
558
- },
559
- "records": "results",
560
- "total": "pagination.count",
561
- "paging": {
562
- "type": "page",
563
- "page_param": "page",
564
- "size_param": "per_page",
565
- "size": 100,
566
- "start": 1
567
- },
568
- "max_rows": 50000,
569
- "defaults": {
570
- "sort": "-total"
571
- }
572
- },
573
- "contributions_by_occupation": {
574
- "path": "/schedules/schedule_a/by_occupation/",
575
- "method": "GET",
576
- "description": "A committee's itemized individual receipts by contributor occupation.",
577
- "params": {
578
- "committee_id": {
579
- "required": true,
580
- "desc": "committee id"
581
- },
582
- "cycle": {
583
- "desc": "two-year period ending in an even year, e.g. 2024"
584
- },
585
- "occupation": {
586
- "desc": "occupation words"
587
- }
588
- },
589
- "records": "results",
590
- "total": "pagination.count",
591
- "paging": {
592
- "type": "page",
593
- "page_param": "page",
594
- "size_param": "per_page",
595
- "size": 100,
596
- "start": 1
597
- },
598
- "max_rows": 50000,
599
- "defaults": {
600
- "sort": "-total"
601
- }
602
- },
603
- "disbursements_by_recipient": {
604
- "path": "/schedules/schedule_b/by_recipient/",
605
- "method": "GET",
606
- "description": "A committee's disbursements totalled by recipient.",
607
- "params": {
608
- "committee_id": {
609
- "required": true,
610
- "desc": "committee id"
611
- },
612
- "cycle": {
613
- "desc": "two-year period ending in an even year, e.g. 2024"
614
- },
615
- "recipient_name": {
616
- "desc": "recipient words"
617
- }
618
- },
619
- "records": "results",
620
- "total": "pagination.count",
621
- "paging": {
622
- "type": "page",
623
- "page_param": "page",
624
- "size_param": "per_page",
625
- "size": 100,
626
- "start": 1
627
- },
628
- "max_rows": 50000,
629
- "defaults": {
630
- "sort": "-total"
631
- }
632
- },
633
- "independent_expenditures_by_candidate": {
634
- "path": "/schedules/schedule_e/totals/by_candidate/",
635
- "method": "GET",
636
- "description": "Independent expenditure totals for a candidate, support and oppose separately.",
637
- "params": {
638
- "candidate_id": {
639
- "required": true,
640
- "desc": "candidate id(s)"
641
- },
642
- "cycle": {
643
- "desc": "two-year period ending in an even year, e.g. 2024"
644
- },
645
- "election_full": {
646
- "desc": "true (default) = whole election period"
647
- }
648
- },
649
- "records": "results",
650
- "total": "pagination.count",
651
- "paging": {
652
- "type": "page",
653
- "page_param": "page",
654
- "size_param": "per_page",
655
- "size": 100,
656
- "start": 1
657
- },
658
- "max_rows": 50000,
659
- "defaults": {
660
- "election_full": "true"
661
- }
662
- }
663
- },
664
- "catalog": {
665
- "committee_types": {
666
- "id": "P H S Q N O U V W X Y I",
667
- "name": "Committee type codes",
668
- "description": "P presidential, H house, S senate, Q qualified PAC, N nonqualified PAC, O super PAC, U single-candidate independent expenditure, V W hybrid PAC, X Y party, I independent expenditure filer (person or group)",
669
- "endpoint": "committees"
670
- },
671
- "candidate_status": {
672
- "id": "C F N P",
673
- "name": "Candidate status",
674
- "description": "C current, F future, N not yet a candidate, P prior",
675
- "endpoint": "candidates_search"
676
- },
677
- "offices": {
678
- "id": "H S P",
679
- "name": "Offices",
680
- "description": "H House, S Senate, P President",
681
- "endpoint": "candidates_search"
682
- },
683
- "race_summary": {
684
- "id": "elections",
685
- "name": "Race summary",
686
- "description": "every candidate's money in one race (elections endpoint)",
687
- "endpoint": "elections"
688
- },
689
- "itemized_contributions": {
690
- "id": "schedule_a",
691
- "name": "Itemized contributions",
692
- "description": "individual and committee contributions over $200 (Schedule A)",
693
- "endpoint": "schedule_a"
694
- },
695
- "outside_spending": {
696
- "id": "schedule_e",
697
- "name": "Independent expenditures",
698
- "description": "outside spending for or against candidates (Schedule E) and totals by candidate",
699
- "endpoint": "schedule_e"
700
- },
701
- "small_donors": {
702
- "id": "by_size",
703
- "name": "Contributions by size",
704
- "description": "share of money from donors giving $200 or less (contributions_by_size)",
705
- "endpoint": "contributions_by_size"
706
- }
707
- }
1
+ {
2
+ "base_url": "https://api.open.fec.gov/v1",
3
+ "endpoints": {
4
+ "candidates_search": {
5
+ "path": "/candidates/search/",
6
+ "method": "GET",
7
+ "description": "Find candidates by name, state, office, party or election year.",
8
+ "params": {
9
+ "q": {
10
+ "desc": "name words, e.g. casey"
11
+ },
12
+ "state": {
13
+ "desc": "two-letter"
14
+ },
15
+ "office": {
16
+ "desc": "H | S | P",
17
+ "enum": [
18
+ "H",
19
+ "S",
20
+ "P"
21
+ ]
22
+ },
23
+ "party": {
24
+ "desc": "DEM | REP | LIB | GRE | IND ..."
25
+ },
26
+ "election_year": {
27
+ "desc": "e.g. 2024"
28
+ },
29
+ "cycle": {
30
+ "desc": "two-year period ending in an even year, e.g. 2024"
31
+ },
32
+ "district": {
33
+ "desc": "two digits, e.g. 07"
34
+ },
35
+ "incumbent_challenge": {
36
+ "desc": "I | C | O (open seat)"
37
+ },
38
+ "candidate_status": {
39
+ "desc": "C current | F future | N not yet | P prior"
40
+ },
41
+ "has_raised_funds": {
42
+ "desc": "true"
43
+ }
44
+ },
45
+ "records": "results",
46
+ "total": "pagination.count",
47
+ "paging": {
48
+ "type": "page",
49
+ "page_param": "page",
50
+ "size_param": "per_page",
51
+ "size": 100,
52
+ "start": 1
53
+ },
54
+ "max_rows": 50000,
55
+ "defaults": {
56
+ "sort": "name"
57
+ }
58
+ },
59
+ "candidate": {
60
+ "path": "/candidate/{candidate_id}/",
61
+ "method": "GET",
62
+ "description": "One candidate's record (party, office, cycles, principal committees).",
63
+ "params": {
64
+ "candidate_id": {
65
+ "in": "path",
66
+ "required": true,
67
+ "desc": "e.g. S6PA00217 (H, S or P + state + digits)"
68
+ }
69
+ },
70
+ "records": "results",
71
+ "total": "pagination.count",
72
+ "paging": {
73
+ "type": "page",
74
+ "page_param": "page",
75
+ "size_param": "per_page",
76
+ "size": 100,
77
+ "start": 1
78
+ },
79
+ "max_rows": 50000
80
+ },
81
+ "candidate_totals": {
82
+ "path": "/candidate/{candidate_id}/totals/",
83
+ "method": "GET",
84
+ "description": "A candidate's financial totals per cycle (receipts, disbursements, cash, debts, contributions by source).",
85
+ "params": {
86
+ "candidate_id": {
87
+ "in": "path",
88
+ "required": true,
89
+ "desc": "candidate id"
90
+ },
91
+ "cycle": {
92
+ "desc": "two-year period ending in an even year, e.g. 2024"
93
+ },
94
+ "election_full": {
95
+ "desc": "true (default) = whole election period (6 years for Senate, 4 for President); false = the two-year cycle"
96
+ }
97
+ },
98
+ "records": "results",
99
+ "total": "pagination.count",
100
+ "paging": {
101
+ "type": "page",
102
+ "page_param": "page",
103
+ "size_param": "per_page",
104
+ "size": 100,
105
+ "start": 1
106
+ },
107
+ "max_rows": 50000,
108
+ "defaults": {
109
+ "election_full": "true"
110
+ }
111
+ },
112
+ "candidates_totals": {
113
+ "path": "/candidates/totals/",
114
+ "method": "GET",
115
+ "description": "Financial totals for every candidate in a race or office (rank by receipts).",
116
+ "params": {
117
+ "office": {
118
+ "desc": "H | S | P",
119
+ "enum": [
120
+ "H",
121
+ "S",
122
+ "P"
123
+ ]
124
+ },
125
+ "election_year": {
126
+ "desc": "e.g. 2024"
127
+ },
128
+ "cycle": {
129
+ "desc": "two-year period ending in an even year, e.g. 2024"
130
+ },
131
+ "state": {
132
+ "desc": "two-letter"
133
+ },
134
+ "district": {
135
+ "desc": "two digits"
136
+ },
137
+ "party": {
138
+ "desc": "DEM | REP ..."
139
+ },
140
+ "is_active_candidate": {
141
+ "desc": "true = only candidates active in that election"
142
+ },
143
+ "election_full": {
144
+ "desc": "true = whole election period"
145
+ },
146
+ "sort": {
147
+ "desc": "-receipts (default), -disbursements, -cash_on_hand_end_period"
148
+ }
149
+ },
150
+ "records": "results",
151
+ "total": "pagination.count",
152
+ "paging": {
153
+ "type": "page",
154
+ "page_param": "page",
155
+ "size_param": "per_page",
156
+ "size": 100,
157
+ "start": 1
158
+ },
159
+ "max_rows": 50000,
160
+ "defaults": {
161
+ "sort": "-receipts",
162
+ "sort_null_only": "false"
163
+ }
164
+ },
165
+ "elections": {
166
+ "path": "/elections/",
167
+ "method": "GET",
168
+ "description": "Race summary: each candidate's receipts, disbursements and cash for one office, state and district.",
169
+ "params": {
170
+ "office": {
171
+ "required": true,
172
+ "desc": "house | senate | president",
173
+ "enum": [
174
+ "house",
175
+ "senate",
176
+ "president"
177
+ ]
178
+ },
179
+ "cycle": {
180
+ "required": true,
181
+ "desc": "election year, e.g. 2024"
182
+ },
183
+ "state": {
184
+ "desc": "two-letter (house, senate)"
185
+ },
186
+ "district": {
187
+ "desc": "two digits (house)"
188
+ },
189
+ "election_full": {
190
+ "desc": "true (default) = whole election period"
191
+ }
192
+ },
193
+ "records": "results",
194
+ "total": "pagination.count",
195
+ "paging": {
196
+ "type": "page",
197
+ "page_param": "page",
198
+ "size_param": "per_page",
199
+ "size": 100,
200
+ "start": 1
201
+ },
202
+ "max_rows": 50000,
203
+ "defaults": {
204
+ "election_full": "true",
205
+ "sort": "-total_receipts"
206
+ }
207
+ },
208
+ "committees": {
209
+ "path": "/committees/",
210
+ "method": "GET",
211
+ "description": "Find committees (campaigns, PACs, super PACs, party committees).",
212
+ "params": {
213
+ "q": {
214
+ "desc": "name words, e.g. pfizer"
215
+ },
216
+ "committee_type": {
217
+ "desc": "P H S (candidate), Q N (PAC), O (super PAC), U (single-candidate IE), V W (hybrid PAC), X Y (party), I (independent expenditure filer)"
218
+ },
219
+ "designation": {
220
+ "desc": "P principal campaign | A authorized | J joint fundraiser | U unauthorized | B lobbyist PAC | D leadership PAC"
221
+ },
222
+ "organization_type": {
223
+ "desc": "C corporation | L labor | M membership | T trade | V cooperative | W corporation without capital stock"
224
+ },
225
+ "state": {
226
+ "desc": "two-letter"
227
+ },
228
+ "party": {
229
+ "desc": "DEM | REP ..."
230
+ },
231
+ "cycle": {
232
+ "desc": "two-year period ending in an even year, e.g. 2024"
233
+ }
234
+ },
235
+ "records": "results",
236
+ "total": "pagination.count",
237
+ "paging": {
238
+ "type": "page",
239
+ "page_param": "page",
240
+ "size_param": "per_page",
241
+ "size": 100,
242
+ "start": 1
243
+ },
244
+ "max_rows": 50000
245
+ },
246
+ "committee": {
247
+ "path": "/committee/{committee_id}/",
248
+ "method": "GET",
249
+ "description": "One committee's registration details.",
250
+ "params": {
251
+ "committee_id": {
252
+ "in": "path",
253
+ "required": true,
254
+ "desc": "e.g. C00431056"
255
+ }
256
+ },
257
+ "records": "results",
258
+ "total": "pagination.count",
259
+ "paging": {
260
+ "type": "page",
261
+ "page_param": "page",
262
+ "size_param": "per_page",
263
+ "size": 100,
264
+ "start": 1
265
+ },
266
+ "max_rows": 50000
267
+ },
268
+ "committee_totals": {
269
+ "path": "/committee/{committee_id}/totals/",
270
+ "method": "GET",
271
+ "description": "A committee's financial totals per two-year cycle.",
272
+ "params": {
273
+ "committee_id": {
274
+ "in": "path",
275
+ "required": true,
276
+ "desc": "committee id"
277
+ },
278
+ "cycle": {
279
+ "desc": "two-year period ending in an even year, e.g. 2024"
280
+ }
281
+ },
282
+ "records": "results",
283
+ "total": "pagination.count",
284
+ "paging": {
285
+ "type": "page",
286
+ "page_param": "page",
287
+ "size_param": "per_page",
288
+ "size": 100,
289
+ "start": 1
290
+ },
291
+ "max_rows": 50000
292
+ },
293
+ "schedule_a": {
294
+ "path": "/schedules/schedule_a/",
295
+ "method": "GET",
296
+ "description": "Itemized receipts (Schedule A): contributions with contributor name, employer, occupation, city, state, ZIP, amount, date. Keyset paging; give at least one filter.",
297
+ "params": {
298
+ "committee_id": {
299
+ "desc": "recipient committee id(s)"
300
+ },
301
+ "contributor_name": {
302
+ "desc": "name words"
303
+ },
304
+ "contributor_employer": {
305
+ "desc": "employer words"
306
+ },
307
+ "contributor_occupation": {
308
+ "desc": "occupation words"
309
+ },
310
+ "contributor_state": {
311
+ "desc": "two-letter"
312
+ },
313
+ "contributor_city": {
314
+ "desc": "city"
315
+ },
316
+ "contributor_zip": {
317
+ "desc": "ZIP (5 digits)"
318
+ },
319
+ "contributor_type": {
320
+ "desc": "individual | committee"
321
+ },
322
+ "is_individual": {
323
+ "desc": "true = individuals only (no transfers)"
324
+ },
325
+ "two_year_transaction_period": {
326
+ "desc": "two-year period, e.g. 2024 (recommended; FEC searches the current period without it)"
327
+ },
328
+ "min_date": {
329
+ "desc": "YYYY-MM-DD"
330
+ },
331
+ "max_date": {
332
+ "desc": "YYYY-MM-DD"
333
+ },
334
+ "min_amount": {
335
+ "desc": "dollars"
336
+ },
337
+ "max_amount": {
338
+ "desc": "dollars"
339
+ },
340
+ "sort": {
341
+ "desc": "-contribution_receipt_date (default) | contribution_receipt_amount | -contribution_receipt_amount"
342
+ },
343
+ "per_page": {
344
+ "desc": "rows per request, at most 100 (default 100)"
345
+ }
346
+ },
347
+ "records": "results",
348
+ "total": "pagination.count",
349
+ "paging": {
350
+ "type": "seek",
351
+ "size": 100
352
+ },
353
+ "max_rows": 50000,
354
+ "defaults": {
355
+ "sort": "-contribution_receipt_date",
356
+ "sort_null_only": "false"
357
+ }
358
+ },
359
+ "schedule_b": {
360
+ "path": "/schedules/schedule_b/",
361
+ "method": "GET",
362
+ "description": "Itemized disbursements (Schedule B): recipient, purpose, amount, date. Keyset paging.",
363
+ "params": {
364
+ "committee_id": {
365
+ "desc": "spending committee id(s)"
366
+ },
367
+ "recipient_name": {
368
+ "desc": "recipient words"
369
+ },
370
+ "recipient_committee_id": {
371
+ "desc": "recipient committee id"
372
+ },
373
+ "recipient_state": {
374
+ "desc": "two-letter"
375
+ },
376
+ "disbursement_description": {
377
+ "desc": "purpose words, e.g. media"
378
+ },
379
+ "two_year_transaction_period": {
380
+ "desc": "two-year period, e.g. 2024 (recommended; FEC searches the current period without it)"
381
+ },
382
+ "min_date": {
383
+ "desc": "YYYY-MM-DD"
384
+ },
385
+ "max_date": {
386
+ "desc": "YYYY-MM-DD"
387
+ },
388
+ "min_amount": {
389
+ "desc": "dollars"
390
+ },
391
+ "max_amount": {
392
+ "desc": "dollars"
393
+ },
394
+ "sort": {
395
+ "desc": "-disbursement_date (default) | -disbursement_amount"
396
+ },
397
+ "per_page": {
398
+ "desc": "rows per request, at most 100 (default 100)"
399
+ }
400
+ },
401
+ "records": "results",
402
+ "total": "pagination.count",
403
+ "paging": {
404
+ "type": "seek",
405
+ "size": 100
406
+ },
407
+ "max_rows": 50000,
408
+ "defaults": {
409
+ "sort": "-disbursement_date",
410
+ "sort_null_only": "false"
411
+ }
412
+ },
413
+ "schedule_e": {
414
+ "path": "/schedules/schedule_e/",
415
+ "method": "GET",
416
+ "description": "Independent expenditures (Schedule E): spender, candidate supported or opposed, payee, purpose, amount, date. Keyset paging.",
417
+ "params": {
418
+ "candidate_id": {
419
+ "desc": "candidate id(s)"
420
+ },
421
+ "committee_id": {
422
+ "desc": "spender committee id(s)"
423
+ },
424
+ "support_oppose_indicator": {
425
+ "desc": "S support | O oppose",
426
+ "enum": [
427
+ "S",
428
+ "O"
429
+ ]
430
+ },
431
+ "cycle": {
432
+ "desc": "two-year period"
433
+ },
434
+ "min_date": {
435
+ "desc": "YYYY-MM-DD"
436
+ },
437
+ "max_date": {
438
+ "desc": "YYYY-MM-DD"
439
+ },
440
+ "min_amount": {
441
+ "desc": "dollars"
442
+ },
443
+ "is_notice": {
444
+ "desc": "true = 24/48-hour notices only; false = regular reports only"
445
+ },
446
+ "sort": {
447
+ "desc": "-expenditure_date (default) | -expenditure_amount"
448
+ },
449
+ "per_page": {
450
+ "desc": "rows per request, at most 100 (default 100)"
451
+ }
452
+ },
453
+ "records": "results",
454
+ "total": "pagination.count",
455
+ "paging": {
456
+ "type": "seek",
457
+ "size": 100
458
+ },
459
+ "max_rows": 50000,
460
+ "defaults": {
461
+ "sort": "-expenditure_date",
462
+ "sort_null_only": "false"
463
+ }
464
+ },
465
+ "contributions_by_size": {
466
+ "path": "/schedules/schedule_a/by_size/by_candidate/",
467
+ "method": "GET",
468
+ "description": "A candidate's receipts from individuals by contribution size bucket (0 = $200 and under, 200, 500, 1000, 2000).",
469
+ "params": {
470
+ "candidate_id": {
471
+ "required": true,
472
+ "desc": "candidate id(s)"
473
+ },
474
+ "cycle": {
475
+ "desc": "two-year period ending in an even year, e.g. 2024"
476
+ },
477
+ "election_full": {
478
+ "desc": "true = whole election period"
479
+ }
480
+ },
481
+ "records": "results",
482
+ "total": "pagination.count",
483
+ "paging": {
484
+ "type": "page",
485
+ "page_param": "page",
486
+ "size_param": "per_page",
487
+ "size": 100,
488
+ "start": 1
489
+ },
490
+ "max_rows": 50000
491
+ },
492
+ "contributions_by_state": {
493
+ "path": "/schedules/schedule_a/by_state/by_candidate/",
494
+ "method": "GET",
495
+ "description": "A candidate's itemized individual receipts by contributor state.",
496
+ "params": {
497
+ "candidate_id": {
498
+ "required": true,
499
+ "desc": "candidate id(s)"
500
+ },
501
+ "cycle": {
502
+ "desc": "two-year period ending in an even year, e.g. 2024"
503
+ },
504
+ "election_full": {
505
+ "desc": "true = whole election period"
506
+ }
507
+ },
508
+ "records": "results",
509
+ "total": "pagination.count",
510
+ "paging": {
511
+ "type": "page",
512
+ "page_param": "page",
513
+ "size_param": "per_page",
514
+ "size": 100,
515
+ "start": 1
516
+ },
517
+ "max_rows": 50000
518
+ },
519
+ "committee_contributions_by_state": {
520
+ "path": "/schedules/schedule_a/by_state/",
521
+ "method": "GET",
522
+ "description": "A committee's itemized individual receipts by contributor state.",
523
+ "params": {
524
+ "committee_id": {
525
+ "required": true,
526
+ "desc": "committee id"
527
+ },
528
+ "cycle": {
529
+ "desc": "two-year period ending in an even year, e.g. 2024"
530
+ }
531
+ },
532
+ "records": "results",
533
+ "total": "pagination.count",
534
+ "paging": {
535
+ "type": "page",
536
+ "page_param": "page",
537
+ "size_param": "per_page",
538
+ "size": 100,
539
+ "start": 1
540
+ },
541
+ "max_rows": 50000
542
+ },
543
+ "contributions_by_employer": {
544
+ "path": "/schedules/schedule_a/by_employer/",
545
+ "method": "GET",
546
+ "description": "A committee's itemized individual receipts by contributor employer (as written by contributors).",
547
+ "params": {
548
+ "committee_id": {
549
+ "required": true,
550
+ "desc": "committee id"
551
+ },
552
+ "cycle": {
553
+ "desc": "two-year period ending in an even year, e.g. 2024"
554
+ },
555
+ "employer": {
556
+ "desc": "employer words"
557
+ }
558
+ },
559
+ "records": "results",
560
+ "total": "pagination.count",
561
+ "paging": {
562
+ "type": "page",
563
+ "page_param": "page",
564
+ "size_param": "per_page",
565
+ "size": 100,
566
+ "start": 1
567
+ },
568
+ "max_rows": 50000,
569
+ "defaults": {
570
+ "sort": "-total"
571
+ }
572
+ },
573
+ "contributions_by_occupation": {
574
+ "path": "/schedules/schedule_a/by_occupation/",
575
+ "method": "GET",
576
+ "description": "A committee's itemized individual receipts by contributor occupation.",
577
+ "params": {
578
+ "committee_id": {
579
+ "required": true,
580
+ "desc": "committee id"
581
+ },
582
+ "cycle": {
583
+ "desc": "two-year period ending in an even year, e.g. 2024"
584
+ },
585
+ "occupation": {
586
+ "desc": "occupation words"
587
+ }
588
+ },
589
+ "records": "results",
590
+ "total": "pagination.count",
591
+ "paging": {
592
+ "type": "page",
593
+ "page_param": "page",
594
+ "size_param": "per_page",
595
+ "size": 100,
596
+ "start": 1
597
+ },
598
+ "max_rows": 50000,
599
+ "defaults": {
600
+ "sort": "-total"
601
+ }
602
+ },
603
+ "disbursements_by_recipient": {
604
+ "path": "/schedules/schedule_b/by_recipient/",
605
+ "method": "GET",
606
+ "description": "A committee's disbursements totalled by recipient.",
607
+ "params": {
608
+ "committee_id": {
609
+ "required": true,
610
+ "desc": "committee id"
611
+ },
612
+ "cycle": {
613
+ "desc": "two-year period ending in an even year, e.g. 2024"
614
+ },
615
+ "recipient_name": {
616
+ "desc": "recipient words"
617
+ }
618
+ },
619
+ "records": "results",
620
+ "total": "pagination.count",
621
+ "paging": {
622
+ "type": "page",
623
+ "page_param": "page",
624
+ "size_param": "per_page",
625
+ "size": 100,
626
+ "start": 1
627
+ },
628
+ "max_rows": 50000,
629
+ "defaults": {
630
+ "sort": "-total"
631
+ }
632
+ },
633
+ "independent_expenditures_by_candidate": {
634
+ "path": "/schedules/schedule_e/totals/by_candidate/",
635
+ "method": "GET",
636
+ "description": "Independent expenditure totals for a candidate, support and oppose separately.",
637
+ "params": {
638
+ "candidate_id": {
639
+ "required": true,
640
+ "desc": "candidate id(s)"
641
+ },
642
+ "cycle": {
643
+ "desc": "two-year period ending in an even year, e.g. 2024"
644
+ },
645
+ "election_full": {
646
+ "desc": "true (default) = whole election period"
647
+ }
648
+ },
649
+ "records": "results",
650
+ "total": "pagination.count",
651
+ "paging": {
652
+ "type": "page",
653
+ "page_param": "page",
654
+ "size_param": "per_page",
655
+ "size": 100,
656
+ "start": 1
657
+ },
658
+ "max_rows": 50000,
659
+ "defaults": {
660
+ "election_full": "true"
661
+ }
662
+ }
663
+ },
664
+ "catalog": {
665
+ "committee_types": {
666
+ "id": "P H S Q N O U V W X Y I",
667
+ "name": "Committee type codes",
668
+ "description": "P presidential, H house, S senate, Q qualified PAC, N nonqualified PAC, O super PAC, U single-candidate independent expenditure, V W hybrid PAC, X Y party, I independent expenditure filer (person or group)",
669
+ "endpoint": "committees"
670
+ },
671
+ "candidate_status": {
672
+ "id": "C F N P",
673
+ "name": "Candidate status",
674
+ "description": "C current, F future, N not yet a candidate, P prior",
675
+ "endpoint": "candidates_search"
676
+ },
677
+ "offices": {
678
+ "id": "H S P",
679
+ "name": "Offices",
680
+ "description": "H House, S Senate, P President",
681
+ "endpoint": "candidates_search"
682
+ },
683
+ "race_summary": {
684
+ "id": "elections",
685
+ "name": "Race summary",
686
+ "description": "every candidate's money in one race (elections endpoint)",
687
+ "endpoint": "elections"
688
+ },
689
+ "itemized_contributions": {
690
+ "id": "schedule_a",
691
+ "name": "Itemized contributions",
692
+ "description": "individual and committee contributions over $200 (Schedule A)",
693
+ "endpoint": "schedule_a"
694
+ },
695
+ "outside_spending": {
696
+ "id": "schedule_e",
697
+ "name": "Independent expenditures",
698
+ "description": "outside spending for or against candidates (Schedule E) and totals by candidate",
699
+ "endpoint": "schedule_e"
700
+ },
701
+ "small_donors": {
702
+ "id": "by_size",
703
+ "name": "Contributions by size",
704
+ "description": "share of money from donors giving $200 or less (contributions_by_size)",
705
+ "endpoint": "contributions_by_size"
706
+ }
707
+ }
708
708
  }