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,327 +1,327 @@
1
- {
2
- "base_url": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1",
3
- "endpoints": {
4
- "complaints": {
5
- "path": "/",
6
- "method": "GET",
7
- "description": "Individual complaints matching the filters, newest first, one row per complaint (paged with search_after; max_rows default 10,000).",
8
- "params": {
9
- "search_term": {
10
- "desc": "full-text search (all fields unless 'field' is set)"
11
- },
12
- "field": {
13
- "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
14
- "enum": [
15
- "all",
16
- "company"
17
- ]
18
- },
19
- "product": {
20
- "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
21
- },
22
- "sub_product": {
23
- "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
24
- },
25
- "issue": {
26
- "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
27
- },
28
- "sub_issue": {
29
- "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
30
- },
31
- "company": {
32
- "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
33
- },
34
- "state": {
35
- "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
36
- },
37
- "zip_code": {
38
- "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
39
- },
40
- "date_received_min": {
41
- "desc": "YYYY-MM-DD, inclusive"
42
- },
43
- "date_received_max": {
44
- "desc": "YYYY-MM-DD, inclusive"
45
- },
46
- "company_received_min": {
47
- "desc": "YYYY-MM-DD (date sent to company)"
48
- },
49
- "company_received_max": {
50
- "desc": "YYYY-MM-DD"
51
- },
52
- "company_response": {
53
- "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
54
- },
55
- "company_public_response": {
56
- "desc": "company's optional public response text category"
57
- },
58
- "submitted_via": {
59
- "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
60
- },
61
- "timely": {
62
- "desc": "Yes or No",
63
- "enum": [
64
- "Yes",
65
- "No"
66
- ]
67
- },
68
- "tags": {
69
- "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
70
- },
71
- "sort": {
72
- "desc": "created_date_desc (default), created_date_asc, relevance_desc, relevance_asc",
73
- "enum": [
74
- "created_date_desc",
75
- "created_date_asc",
76
- "relevance_desc",
77
- "relevance_asc"
78
- ]
79
- },
80
- "page_size": {
81
- "desc": "rows per page (default 1000, at most 10000)"
82
- }
83
- },
84
- "defaults": {
85
- "sort": "created_date_desc"
86
- },
87
- "records": "hits.hits",
88
- "paging": {
89
- "type": "none"
90
- },
91
- "max_rows": 100000
92
- },
93
- "aggregations": {
94
- "path": "/",
95
- "method": "GET",
96
- "description": "Complaint counts by one field (product, issue, company, state, timely, company_response, submitted_via, company_public_response, tags) for the filters; sub=true gives sub_product / sub_issue rows.",
97
- "params": {
98
- "search_term": {
99
- "desc": "full-text search (all fields unless 'field' is set)"
100
- },
101
- "field": {
102
- "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
103
- "enum": [
104
- "all",
105
- "company"
106
- ]
107
- },
108
- "product": {
109
- "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
110
- },
111
- "sub_product": {
112
- "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
113
- },
114
- "issue": {
115
- "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
116
- },
117
- "sub_issue": {
118
- "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
119
- },
120
- "company": {
121
- "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
122
- },
123
- "state": {
124
- "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
125
- },
126
- "zip_code": {
127
- "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
128
- },
129
- "date_received_min": {
130
- "desc": "YYYY-MM-DD, inclusive"
131
- },
132
- "date_received_max": {
133
- "desc": "YYYY-MM-DD, inclusive"
134
- },
135
- "company_received_min": {
136
- "desc": "YYYY-MM-DD (date sent to company)"
137
- },
138
- "company_received_max": {
139
- "desc": "YYYY-MM-DD"
140
- },
141
- "company_response": {
142
- "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
143
- },
144
- "company_public_response": {
145
- "desc": "company's optional public response text category"
146
- },
147
- "submitted_via": {
148
- "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
149
- },
150
- "timely": {
151
- "desc": "Yes or No",
152
- "enum": [
153
- "Yes",
154
- "No"
155
- ]
156
- },
157
- "tags": {
158
- "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
159
- },
160
- "agg": {
161
- "required": true,
162
- "desc": "field to count by",
163
- "enum": [
164
- "product",
165
- "issue",
166
- "company",
167
- "state",
168
- "timely",
169
- "company_response",
170
- "submitted_via",
171
- "company_public_response",
172
- "tags"
173
- ]
174
- },
175
- "sub": {
176
- "desc": "true = one row per sub-bucket (product -> sub_product, issue -> sub_issue)"
177
- }
178
- },
179
- "defaults": {
180
- "size": 0
181
- },
182
- "records": "aggregations",
183
- "paging": {
184
- "type": "none"
185
- }
186
- },
187
- "trends": {
188
- "path": "/",
189
- "method": "GET",
190
- "description": "Complaint counts per year, quarter or month between date_received_min and date_received_max (one count query per period; at most 120 periods); by=<field> splits each period.",
191
- "params": {
192
- "search_term": {
193
- "desc": "full-text search (all fields unless 'field' is set)"
194
- },
195
- "field": {
196
- "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
197
- "enum": [
198
- "all",
199
- "company"
200
- ]
201
- },
202
- "product": {
203
- "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
204
- },
205
- "sub_product": {
206
- "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
207
- },
208
- "issue": {
209
- "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
210
- },
211
- "sub_issue": {
212
- "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
213
- },
214
- "company": {
215
- "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
216
- },
217
- "state": {
218
- "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
219
- },
220
- "zip_code": {
221
- "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
222
- },
223
- "date_received_min": {
224
- "desc": "YYYY-MM-DD, inclusive"
225
- },
226
- "date_received_max": {
227
- "desc": "YYYY-MM-DD, inclusive"
228
- },
229
- "company_received_min": {
230
- "desc": "YYYY-MM-DD (date sent to company)"
231
- },
232
- "company_received_max": {
233
- "desc": "YYYY-MM-DD"
234
- },
235
- "company_response": {
236
- "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
237
- },
238
- "company_public_response": {
239
- "desc": "company's optional public response text category"
240
- },
241
- "submitted_via": {
242
- "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
243
- },
244
- "timely": {
245
- "desc": "Yes or No",
246
- "enum": [
247
- "Yes",
248
- "No"
249
- ]
250
- },
251
- "tags": {
252
- "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
253
- },
254
- "interval": {
255
- "required": true,
256
- "desc": "year, quarter or month",
257
- "enum": [
258
- "year",
259
- "quarter",
260
- "month"
261
- ]
262
- },
263
- "by": {
264
- "desc": "optional field to split by (same choices as aggregations agg)",
265
- "enum": [
266
- "product",
267
- "issue",
268
- "company",
269
- "state",
270
- "timely",
271
- "company_response",
272
- "submitted_via",
273
- "company_public_response",
274
- "tags"
275
- ]
276
- }
277
- },
278
- "defaults": {
279
- "size": 0
280
- },
281
- "records": "hits.total",
282
- "paging": {
283
- "type": "none"
284
- }
285
- },
286
- "complaint": {
287
- "path": "/{complaint_id}",
288
- "method": "GET",
289
- "description": "One complaint by its id.",
290
- "params": {
291
- "complaint_id": {
292
- "in": "path",
293
- "required": true,
294
- "desc": "complaint id, e.g. 17993241"
295
- }
296
- },
297
- "records": "hits.hits",
298
- "paging": {
299
- "type": "none"
300
- }
301
- }
302
- },
303
- "catalog": {},
304
- "products": {
305
- "Credit reporting or other personal consumer reports": "12,910,622 complaints in the database (2026-10-20)",
306
- "Credit reporting, credit repair services, or other personal consumer reports": "2,163,769 complaints in the database (2026-10-20)",
307
- "Debt collection": "1,217,848 complaints in the database (2026-10-20)",
308
- "Mortgage": "463,905 complaints in the database (2026-10-20)",
309
- "Checking or savings account": "404,615 complaints in the database (2026-10-20)",
310
- "Credit card": "353,050 complaints in the database (2026-10-20)",
311
- "Credit card or prepaid card": "206,356 complaints in the database (2026-10-20)",
312
- "Money transfer, virtual currency, or money service": "195,446 complaints in the database (2026-10-20)",
313
- "Credit reporting": "140,426 complaints in the database (2026-10-20)",
314
- "Student loan": "135,133 complaints in the database (2026-10-20)",
315
- "Vehicle loan or lease": "105,514 complaints in the database (2026-10-20)",
316
- "Bank account or service": "86,198 complaints in the database (2026-10-20)",
317
- "Payday loan, title loan, personal loan, or advance loan": "39,960 complaints in the database (2026-10-20)",
318
- "Consumer Loan": "31,559 complaints in the database (2026-10-20)",
319
- "Payday loan, title loan, or personal loan": "30,614 complaints in the database (2026-10-20)",
320
- "Prepaid card": "23,812 complaints in the database (2026-10-20)",
321
- "Debt or credit management": "10,660 complaints in the database (2026-10-20)",
322
- "Payday loan": "5,528 complaints in the database (2026-10-20)",
323
- "Money transfers": "5,354 complaints in the database (2026-10-20)",
324
- "Other financial service": "1,056 complaints in the database (2026-10-20)",
325
- "Virtual currency": "18 complaints in the database (2026-10-20)"
326
- }
1
+ {
2
+ "base_url": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1",
3
+ "endpoints": {
4
+ "complaints": {
5
+ "path": "/",
6
+ "method": "GET",
7
+ "description": "Individual complaints matching the filters, newest first, one row per complaint (paged with search_after; max_rows default 10,000).",
8
+ "params": {
9
+ "search_term": {
10
+ "desc": "full-text search (all fields unless 'field' is set)"
11
+ },
12
+ "field": {
13
+ "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
14
+ "enum": [
15
+ "all",
16
+ "company"
17
+ ]
18
+ },
19
+ "product": {
20
+ "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
21
+ },
22
+ "sub_product": {
23
+ "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
24
+ },
25
+ "issue": {
26
+ "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
27
+ },
28
+ "sub_issue": {
29
+ "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
30
+ },
31
+ "company": {
32
+ "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
33
+ },
34
+ "state": {
35
+ "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
36
+ },
37
+ "zip_code": {
38
+ "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
39
+ },
40
+ "date_received_min": {
41
+ "desc": "YYYY-MM-DD, inclusive"
42
+ },
43
+ "date_received_max": {
44
+ "desc": "YYYY-MM-DD, inclusive"
45
+ },
46
+ "company_received_min": {
47
+ "desc": "YYYY-MM-DD (date sent to company)"
48
+ },
49
+ "company_received_max": {
50
+ "desc": "YYYY-MM-DD"
51
+ },
52
+ "company_response": {
53
+ "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
54
+ },
55
+ "company_public_response": {
56
+ "desc": "company's optional public response text category"
57
+ },
58
+ "submitted_via": {
59
+ "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
60
+ },
61
+ "timely": {
62
+ "desc": "Yes or No",
63
+ "enum": [
64
+ "Yes",
65
+ "No"
66
+ ]
67
+ },
68
+ "tags": {
69
+ "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
70
+ },
71
+ "sort": {
72
+ "desc": "created_date_desc (default), created_date_asc, relevance_desc, relevance_asc",
73
+ "enum": [
74
+ "created_date_desc",
75
+ "created_date_asc",
76
+ "relevance_desc",
77
+ "relevance_asc"
78
+ ]
79
+ },
80
+ "page_size": {
81
+ "desc": "rows per page (default 1000, at most 10000)"
82
+ }
83
+ },
84
+ "defaults": {
85
+ "sort": "created_date_desc"
86
+ },
87
+ "records": "hits.hits",
88
+ "paging": {
89
+ "type": "none"
90
+ },
91
+ "max_rows": 100000
92
+ },
93
+ "aggregations": {
94
+ "path": "/",
95
+ "method": "GET",
96
+ "description": "Complaint counts by one field (product, issue, company, state, timely, company_response, submitted_via, company_public_response, tags) for the filters; sub=true gives sub_product / sub_issue rows.",
97
+ "params": {
98
+ "search_term": {
99
+ "desc": "full-text search (all fields unless 'field' is set)"
100
+ },
101
+ "field": {
102
+ "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
103
+ "enum": [
104
+ "all",
105
+ "company"
106
+ ]
107
+ },
108
+ "product": {
109
+ "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
110
+ },
111
+ "sub_product": {
112
+ "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
113
+ },
114
+ "issue": {
115
+ "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
116
+ },
117
+ "sub_issue": {
118
+ "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
119
+ },
120
+ "company": {
121
+ "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
122
+ },
123
+ "state": {
124
+ "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
125
+ },
126
+ "zip_code": {
127
+ "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
128
+ },
129
+ "date_received_min": {
130
+ "desc": "YYYY-MM-DD, inclusive"
131
+ },
132
+ "date_received_max": {
133
+ "desc": "YYYY-MM-DD, inclusive"
134
+ },
135
+ "company_received_min": {
136
+ "desc": "YYYY-MM-DD (date sent to company)"
137
+ },
138
+ "company_received_max": {
139
+ "desc": "YYYY-MM-DD"
140
+ },
141
+ "company_response": {
142
+ "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
143
+ },
144
+ "company_public_response": {
145
+ "desc": "company's optional public response text category"
146
+ },
147
+ "submitted_via": {
148
+ "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
149
+ },
150
+ "timely": {
151
+ "desc": "Yes or No",
152
+ "enum": [
153
+ "Yes",
154
+ "No"
155
+ ]
156
+ },
157
+ "tags": {
158
+ "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
159
+ },
160
+ "agg": {
161
+ "required": true,
162
+ "desc": "field to count by",
163
+ "enum": [
164
+ "product",
165
+ "issue",
166
+ "company",
167
+ "state",
168
+ "timely",
169
+ "company_response",
170
+ "submitted_via",
171
+ "company_public_response",
172
+ "tags"
173
+ ]
174
+ },
175
+ "sub": {
176
+ "desc": "true = one row per sub-bucket (product -> sub_product, issue -> sub_issue)"
177
+ }
178
+ },
179
+ "defaults": {
180
+ "size": 0
181
+ },
182
+ "records": "aggregations",
183
+ "paging": {
184
+ "type": "none"
185
+ }
186
+ },
187
+ "trends": {
188
+ "path": "/",
189
+ "method": "GET",
190
+ "description": "Complaint counts per year, quarter or month between date_received_min and date_received_max (one count query per period; at most 120 periods); by=<field> splits each period.",
191
+ "params": {
192
+ "search_term": {
193
+ "desc": "full-text search (all fields unless 'field' is set)"
194
+ },
195
+ "field": {
196
+ "desc": "where search_term looks: all (default) or company (the API answers HTTP 400 to any other value; narratives are no longer published)",
197
+ "enum": [
198
+ "all",
199
+ "company"
200
+ ]
201
+ },
202
+ "product": {
203
+ "desc": "exact product name, e.g. 'Mortgage', 'Debt collection', 'Credit reporting or other personal consumer reports'; a list = OR"
204
+ },
205
+ "sub_product": {
206
+ "desc": "exact sub-product name; needs exactly one product (sent as product='<product>' + U+2022 bullet + '<sub_product>', the only form the API applies); a list = OR"
207
+ },
208
+ "issue": {
209
+ "desc": "exact issue name, e.g. 'Struggling to repay your loan'"
210
+ },
211
+ "sub_issue": {
212
+ "desc": "exact sub-issue name; needs exactly one issue (sent as issue='<issue>' + U+2022 bullet + '<sub_issue>'); a list = OR"
213
+ },
214
+ "company": {
215
+ "desc": "exact company name as CFPB writes it, e.g. 'WELLS FARGO & COMPANY' (find it with aggregations agg=company)"
216
+ },
217
+ "state": {
218
+ "desc": "two-letter state or territory code, e.g. 'TX'; a list = OR"
219
+ },
220
+ "zip_code": {
221
+ "desc": "5-digit ZIP (consumer-reported; 3 digits plus XX for small areas)"
222
+ },
223
+ "date_received_min": {
224
+ "desc": "YYYY-MM-DD, inclusive"
225
+ },
226
+ "date_received_max": {
227
+ "desc": "YYYY-MM-DD, inclusive"
228
+ },
229
+ "company_received_min": {
230
+ "desc": "YYYY-MM-DD (date sent to company)"
231
+ },
232
+ "company_received_max": {
233
+ "desc": "YYYY-MM-DD"
234
+ },
235
+ "company_response": {
236
+ "desc": "'Closed with explanation', 'Closed with monetary relief', 'Closed with non-monetary relief', 'In progress', 'Untimely response' (older: 'Closed', 'Closed with relief', 'Closed without relief')"
237
+ },
238
+ "company_public_response": {
239
+ "desc": "company's optional public response text category"
240
+ },
241
+ "submitted_via": {
242
+ "desc": "Web, Referral, Phone, Postal mail, Fax, Email"
243
+ },
244
+ "timely": {
245
+ "desc": "Yes or No",
246
+ "enum": [
247
+ "Yes",
248
+ "No"
249
+ ]
250
+ },
251
+ "tags": {
252
+ "desc": "'Older American', 'Servicemember', 'Older American, Servicemember'"
253
+ },
254
+ "interval": {
255
+ "required": true,
256
+ "desc": "year, quarter or month",
257
+ "enum": [
258
+ "year",
259
+ "quarter",
260
+ "month"
261
+ ]
262
+ },
263
+ "by": {
264
+ "desc": "optional field to split by (same choices as aggregations agg)",
265
+ "enum": [
266
+ "product",
267
+ "issue",
268
+ "company",
269
+ "state",
270
+ "timely",
271
+ "company_response",
272
+ "submitted_via",
273
+ "company_public_response",
274
+ "tags"
275
+ ]
276
+ }
277
+ },
278
+ "defaults": {
279
+ "size": 0
280
+ },
281
+ "records": "hits.total",
282
+ "paging": {
283
+ "type": "none"
284
+ }
285
+ },
286
+ "complaint": {
287
+ "path": "/{complaint_id}",
288
+ "method": "GET",
289
+ "description": "One complaint by its id.",
290
+ "params": {
291
+ "complaint_id": {
292
+ "in": "path",
293
+ "required": true,
294
+ "desc": "complaint id, e.g. 17993241"
295
+ }
296
+ },
297
+ "records": "hits.hits",
298
+ "paging": {
299
+ "type": "none"
300
+ }
301
+ }
302
+ },
303
+ "catalog": {},
304
+ "products": {
305
+ "Credit reporting or other personal consumer reports": "12,910,622 complaints in the database (2026-10-20)",
306
+ "Credit reporting, credit repair services, or other personal consumer reports": "2,163,769 complaints in the database (2026-10-20)",
307
+ "Debt collection": "1,217,848 complaints in the database (2026-10-20)",
308
+ "Mortgage": "463,905 complaints in the database (2026-10-20)",
309
+ "Checking or savings account": "404,615 complaints in the database (2026-10-20)",
310
+ "Credit card": "353,050 complaints in the database (2026-10-20)",
311
+ "Credit card or prepaid card": "206,356 complaints in the database (2026-10-20)",
312
+ "Money transfer, virtual currency, or money service": "195,446 complaints in the database (2026-10-20)",
313
+ "Credit reporting": "140,426 complaints in the database (2026-10-20)",
314
+ "Student loan": "135,133 complaints in the database (2026-10-20)",
315
+ "Vehicle loan or lease": "105,514 complaints in the database (2026-10-20)",
316
+ "Bank account or service": "86,198 complaints in the database (2026-10-20)",
317
+ "Payday loan, title loan, personal loan, or advance loan": "39,960 complaints in the database (2026-10-20)",
318
+ "Consumer Loan": "31,559 complaints in the database (2026-10-20)",
319
+ "Payday loan, title loan, or personal loan": "30,614 complaints in the database (2026-10-20)",
320
+ "Prepaid card": "23,812 complaints in the database (2026-10-20)",
321
+ "Debt or credit management": "10,660 complaints in the database (2026-10-20)",
322
+ "Payday loan": "5,528 complaints in the database (2026-10-20)",
323
+ "Money transfers": "5,354 complaints in the database (2026-10-20)",
324
+ "Other financial service": "1,056 complaints in the database (2026-10-20)",
325
+ "Virtual currency": "18 complaints in the database (2026-10-20)"
326
+ }
327
327
  }