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,417 +1,417 @@
1
- {
2
- "base_url": "https://api.fdic.gov/banks",
3
- "endpoints": {
4
- "institutions": {
5
- "path": "/institutions",
6
- "method": "GET",
7
- "description": "Institutions (open and closed): name, location, charter, regulator, latest assets/deposits. One row per institution (CERT).",
8
- "params": {
9
- "filters": {
10
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
11
- },
12
- "fields": {
13
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
14
- },
15
- "sort_by": {
16
- "desc": "field to sort on"
17
- },
18
- "sort_order": {
19
- "desc": "ASC or DESC",
20
- "enum": [
21
- "ASC",
22
- "DESC"
23
- ]
24
- },
25
- "search": {
26
- "desc": "flexible text search, e.g. NAME:Wells"
27
- }
28
- },
29
- "defaults": {
30
- "sort_by": "ASSET",
31
- "sort_order": "DESC"
32
- },
33
- "records": "data",
34
- "total": "meta.total",
35
- "paging": {
36
- "type": "offset",
37
- "limit_param": "limit",
38
- "offset_param": "offset",
39
- "size": 1000
40
- },
41
- "max_rows": 100000,
42
- "missing": [
43
- ""
44
- ],
45
- "flatten": true
46
- },
47
- "failures": {
48
- "path": "/failures",
49
- "method": "GET",
50
- "description": "Every FDIC-insured institution failure since 1934: NAME, CERT, FAILDATE, FAILYR, COST (estimated loss to the Deposit Insurance Fund), QBFASSET, QBFDEP, RESTYPE, RESTYPE1, SAVR, PSTALP.",
51
- "params": {
52
- "filters": {
53
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
54
- },
55
- "fields": {
56
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
57
- },
58
- "sort_by": {
59
- "desc": "field to sort on"
60
- },
61
- "sort_order": {
62
- "desc": "ASC or DESC",
63
- "enum": [
64
- "ASC",
65
- "DESC"
66
- ]
67
- },
68
- "agg_by": {
69
- "desc": "field to aggregate by, e.g. FAILYR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
70
- },
71
- "agg_sum_fields": {
72
- "desc": "fields to sum per bucket, e.g. QBFASSET,QBFDEP,COST"
73
- },
74
- "agg_term_fields": {
75
- "desc": "fields whose values are counted per bucket, e.g. RESTYPE"
76
- },
77
- "agg_limit": {
78
- "desc": "number of aggregation buckets"
79
- }
80
- },
81
- "defaults": {
82
- "sort_by": "FAILDATE",
83
- "sort_order": "DESC"
84
- },
85
- "records": "data",
86
- "total": "meta.total",
87
- "paging": {
88
- "type": "offset",
89
- "limit_param": "limit",
90
- "offset_param": "offset",
91
- "size": 1000
92
- },
93
- "max_rows": 100000,
94
- "missing": [
95
- ""
96
- ],
97
- "flatten": true
98
- },
99
- "financials": {
100
- "path": "/financials",
101
- "method": "GET",
102
- "description": "Quarterly Call Report financials per institution (CERT, REPDTE YYYYMMDD) from 1984: ASSET, DEP, NETINC, ROA, ROE, LNLSNET, INTINC, EINTEXP, NONII, ... (over 1,000 fields).",
103
- "params": {
104
- "filters": {
105
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
106
- },
107
- "fields": {
108
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
109
- },
110
- "sort_by": {
111
- "desc": "field to sort on"
112
- },
113
- "sort_order": {
114
- "desc": "ASC or DESC",
115
- "enum": [
116
- "ASC",
117
- "DESC"
118
- ]
119
- },
120
- "agg_by": {
121
- "desc": "field to aggregate by, e.g. STALP: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
122
- },
123
- "agg_sum_fields": {
124
- "desc": "fields to sum per bucket, e.g. ASSET,DEP"
125
- },
126
- "agg_term_fields": {
127
- "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
128
- },
129
- "agg_limit": {
130
- "desc": "number of aggregation buckets"
131
- }
132
- },
133
- "defaults": {
134
- "sort_by": "REPDTE",
135
- "sort_order": "DESC"
136
- },
137
- "records": "data",
138
- "total": "meta.total",
139
- "paging": {
140
- "type": "offset",
141
- "limit_param": "limit",
142
- "offset_param": "offset",
143
- "size": 1000
144
- },
145
- "max_rows": 100000,
146
- "missing": [
147
- ""
148
- ],
149
- "flatten": true
150
- },
151
- "summary": {
152
- "path": "/summary",
153
- "method": "GET",
154
- "description": "Annual aggregates by state (STNAME) and charter group (CB_SI: CB commercial banks, SI savings institutions) since 1934: BANKS, ASSET, DEP, NETINC, ... Includes aggregate rows 'All States and Territories', 'U.S. States and DC', 'U.S. Territories'.",
155
- "params": {
156
- "filters": {
157
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
158
- },
159
- "fields": {
160
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
161
- },
162
- "sort_by": {
163
- "desc": "field to sort on"
164
- },
165
- "sort_order": {
166
- "desc": "ASC or DESC",
167
- "enum": [
168
- "ASC",
169
- "DESC"
170
- ]
171
- },
172
- "agg_by": {
173
- "desc": "field to aggregate by, e.g. YEAR"
174
- },
175
- "agg_sum_fields": {
176
- "desc": "fields to sum, e.g. ASSET,DEP"
177
- },
178
- "agg_term_fields": {
179
- "desc": "fields to count terms of"
180
- },
181
- "agg_limit": {
182
- "desc": "number of aggregation buckets"
183
- }
184
- },
185
- "defaults": {
186
- "sort_by": "YEAR",
187
- "sort_order": "DESC"
188
- },
189
- "records": "data",
190
- "total": "meta.total",
191
- "paging": {
192
- "type": "offset",
193
- "limit_param": "limit",
194
- "offset_param": "offset",
195
- "size": 1000
196
- },
197
- "max_rows": 100000,
198
- "missing": [
199
- ""
200
- ],
201
- "flatten": true
202
- },
203
- "sod": {
204
- "path": "/sod",
205
- "method": "GET",
206
- "description": "Summary of Deposits: one row per branch per year (as of June 30, 1994-): CERT, NAMEFULL, BRNUM, CITYBR, STALPBR, CNTYNAMB, DEPSUMBR (branch deposits), YEAR.",
207
- "params": {
208
- "filters": {
209
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
210
- },
211
- "fields": {
212
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
213
- },
214
- "sort_by": {
215
- "desc": "field to sort on"
216
- },
217
- "sort_order": {
218
- "desc": "ASC or DESC",
219
- "enum": [
220
- "ASC",
221
- "DESC"
222
- ]
223
- },
224
- "agg_by": {
225
- "desc": "field to aggregate by, e.g. STALPBR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
226
- },
227
- "agg_sum_fields": {
228
- "desc": "fields to sum per bucket, e.g. DEPSUMBR"
229
- },
230
- "agg_term_fields": {
231
- "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
232
- },
233
- "agg_limit": {
234
- "desc": "number of aggregation buckets"
235
- }
236
- },
237
- "defaults": {
238
- "sort_by": "DEPSUMBR",
239
- "sort_order": "DESC"
240
- },
241
- "records": "data",
242
- "total": "meta.total",
243
- "paging": {
244
- "type": "offset",
245
- "limit_param": "limit",
246
- "offset_param": "offset",
247
- "size": 1000
248
- },
249
- "max_rows": 100000,
250
- "missing": [
251
- ""
252
- ],
253
- "flatten": true
254
- },
255
- "history": {
256
- "path": "/history",
257
- "method": "GET",
258
- "description": "Structure change events: mergers, failures, name and charter changes, branch openings and closings (CERT, EFFDATE, CHANGECODE, CHANGECODE_DESC, INSTNAME).",
259
- "params": {
260
- "filters": {
261
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
262
- },
263
- "fields": {
264
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
265
- },
266
- "sort_by": {
267
- "desc": "field to sort on"
268
- },
269
- "sort_order": {
270
- "desc": "ASC or DESC",
271
- "enum": [
272
- "ASC",
273
- "DESC"
274
- ]
275
- },
276
- "search": {
277
- "desc": "flexible text search"
278
- },
279
- "agg_by": {
280
- "desc": "field to aggregate by, e.g. CHANGECODE: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
281
- },
282
- "agg_sum_fields": {
283
- "desc": "fields to sum per bucket (numeric fields)"
284
- },
285
- "agg_term_fields": {
286
- "desc": "fields whose values are counted per bucket, e.g. CLASS"
287
- },
288
- "agg_limit": {
289
- "desc": "number of aggregation buckets"
290
- }
291
- },
292
- "defaults": {
293
- "sort_by": "EFFDATE",
294
- "sort_order": "DESC"
295
- },
296
- "records": "data",
297
- "total": "meta.total",
298
- "paging": {
299
- "type": "offset",
300
- "limit_param": "limit",
301
- "offset_param": "offset",
302
- "size": 1000
303
- },
304
- "max_rows": 100000,
305
- "missing": [
306
- ""
307
- ],
308
- "flatten": true
309
- },
310
- "locations": {
311
- "path": "/locations",
312
- "method": "GET",
313
- "description": "Branch and office locations of institutions (CERT, NAME, OFFNAME, ADDRESS, CITY, STALP, ZIP, COUNTY, LATITUDE, LONGITUDE, SERVTYPE).",
314
- "params": {
315
- "filters": {
316
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
317
- },
318
- "fields": {
319
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
320
- },
321
- "sort_by": {
322
- "desc": "field to sort on"
323
- },
324
- "sort_order": {
325
- "desc": "ASC or DESC",
326
- "enum": [
327
- "ASC",
328
- "DESC"
329
- ]
330
- }
331
- },
332
- "defaults": {},
333
- "records": "data",
334
- "total": "meta.total",
335
- "paging": {
336
- "type": "offset",
337
- "limit_param": "limit",
338
- "offset_param": "offset",
339
- "size": 1000
340
- },
341
- "max_rows": 100000,
342
- "missing": [
343
- ""
344
- ],
345
- "flatten": true
346
- },
347
- "demographics": {
348
- "path": "/demographics",
349
- "method": "GET",
350
- "description": "Quarterly demographic and geographic attributes of institutions (office counts, CBSA, metro flags) keyed by CERT and REPDTE.",
351
- "params": {
352
- "filters": {
353
- "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
354
- },
355
- "fields": {
356
- "desc": "comma-separated field names (default: every field, often hundreds); always set this"
357
- },
358
- "sort_by": {
359
- "desc": "field to sort on"
360
- },
361
- "sort_order": {
362
- "desc": "ASC or DESC",
363
- "enum": [
364
- "ASC",
365
- "DESC"
366
- ]
367
- }
368
- },
369
- "defaults": {},
370
- "records": "data",
371
- "total": "meta.total",
372
- "paging": {
373
- "type": "offset",
374
- "limit_param": "limit",
375
- "offset_param": "offset",
376
- "size": 1000
377
- },
378
- "max_rows": 100000,
379
- "missing": [
380
- ""
381
- ],
382
- "flatten": true
383
- }
384
- },
385
- "catalog": {},
386
- "fields": {
387
- "CERT": "FDIC certificate number: the institution id used by every endpoint",
388
- "NAME": "institution name (institutions, failures, locations)",
389
- "INSTNAME": "institution name (history, financials)",
390
- "STALP": "state postal code (institutions, financials, locations); PSTALP in failures and history",
391
- "STNAME": "state name (summary, institutions)",
392
- "ACTIVE": "1 = open institution (institutions)",
393
- "ASSET": "total assets, thousands of dollars",
394
- "DEP": "total deposits, thousands of dollars",
395
- "DEPDOM": "domestic deposits, thousands of dollars",
396
- "NETINC": "net income, thousands of dollars; year-to-date in financials",
397
- "ROA": "return on assets, percent (annualized)",
398
- "ROE": "return on equity, percent (annualized)",
399
- "LNLSNET": "net loans and leases, thousands of dollars",
400
- "REPDTE": "report date: YYYYMMDD in financials, MM/DD/YYYY in institutions",
401
- "FAILDATE": "failure date, M/D/YYYY text (failures)",
402
- "FAILYR": "failure year (failures)",
403
- "COST": "estimated loss to the Deposit Insurance Fund, thousands of dollars (failures)",
404
- "QBFASSET": "total assets at failure, thousands of dollars",
405
- "QBFDEP": "total deposits at failure, thousands of dollars",
406
- "RESTYPE1": "transaction type code (failures): PA, P&A, PI, PO (payout), A/A, IDT, MGR, DINB, OBAM, ABT, REP",
407
- "CB_SI": "summary charter group: CB commercial banks, SI savings institutions",
408
- "BANKS": "number of institutions (summary)",
409
- "DEPSUMBR": "branch deposits as of June 30, thousands of dollars (sod)",
410
- "YEAR": "year (summary, sod)",
411
- "EFFDATE": "event effective date (history)",
412
- "CHANGECODE_DESC": "event type (history)",
413
- "BKCLASS": "charter class (institutions): N national, SM state member, NM state nonmember, SB savings bank, SI state savings institution, SL savings and loan, NC, OI",
414
- "RESTYPE": "FAILURE or ASSISTANCE (open-bank assistance); filter RESTYPE:\"FAILURE\" to count failures (failures)",
415
- "REGAGNT": "primary federal regulator: OCC, FED, FDIC, ... (institutions)"
416
- }
1
+ {
2
+ "base_url": "https://api.fdic.gov/banks",
3
+ "endpoints": {
4
+ "institutions": {
5
+ "path": "/institutions",
6
+ "method": "GET",
7
+ "description": "Institutions (open and closed): name, location, charter, regulator, latest assets/deposits. One row per institution (CERT).",
8
+ "params": {
9
+ "filters": {
10
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
11
+ },
12
+ "fields": {
13
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
14
+ },
15
+ "sort_by": {
16
+ "desc": "field to sort on"
17
+ },
18
+ "sort_order": {
19
+ "desc": "ASC or DESC",
20
+ "enum": [
21
+ "ASC",
22
+ "DESC"
23
+ ]
24
+ },
25
+ "search": {
26
+ "desc": "flexible text search, e.g. NAME:Wells"
27
+ }
28
+ },
29
+ "defaults": {
30
+ "sort_by": "ASSET",
31
+ "sort_order": "DESC"
32
+ },
33
+ "records": "data",
34
+ "total": "meta.total",
35
+ "paging": {
36
+ "type": "offset",
37
+ "limit_param": "limit",
38
+ "offset_param": "offset",
39
+ "size": 1000
40
+ },
41
+ "max_rows": 100000,
42
+ "missing": [
43
+ ""
44
+ ],
45
+ "flatten": true
46
+ },
47
+ "failures": {
48
+ "path": "/failures",
49
+ "method": "GET",
50
+ "description": "Every FDIC-insured institution failure since 1934: NAME, CERT, FAILDATE, FAILYR, COST (estimated loss to the Deposit Insurance Fund), QBFASSET, QBFDEP, RESTYPE, RESTYPE1, SAVR, PSTALP.",
51
+ "params": {
52
+ "filters": {
53
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
54
+ },
55
+ "fields": {
56
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
57
+ },
58
+ "sort_by": {
59
+ "desc": "field to sort on"
60
+ },
61
+ "sort_order": {
62
+ "desc": "ASC or DESC",
63
+ "enum": [
64
+ "ASC",
65
+ "DESC"
66
+ ]
67
+ },
68
+ "agg_by": {
69
+ "desc": "field to aggregate by, e.g. FAILYR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
70
+ },
71
+ "agg_sum_fields": {
72
+ "desc": "fields to sum per bucket, e.g. QBFASSET,QBFDEP,COST"
73
+ },
74
+ "agg_term_fields": {
75
+ "desc": "fields whose values are counted per bucket, e.g. RESTYPE"
76
+ },
77
+ "agg_limit": {
78
+ "desc": "number of aggregation buckets"
79
+ }
80
+ },
81
+ "defaults": {
82
+ "sort_by": "FAILDATE",
83
+ "sort_order": "DESC"
84
+ },
85
+ "records": "data",
86
+ "total": "meta.total",
87
+ "paging": {
88
+ "type": "offset",
89
+ "limit_param": "limit",
90
+ "offset_param": "offset",
91
+ "size": 1000
92
+ },
93
+ "max_rows": 100000,
94
+ "missing": [
95
+ ""
96
+ ],
97
+ "flatten": true
98
+ },
99
+ "financials": {
100
+ "path": "/financials",
101
+ "method": "GET",
102
+ "description": "Quarterly Call Report financials per institution (CERT, REPDTE YYYYMMDD) from 1984: ASSET, DEP, NETINC, ROA, ROE, LNLSNET, INTINC, EINTEXP, NONII, ... (over 1,000 fields).",
103
+ "params": {
104
+ "filters": {
105
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
106
+ },
107
+ "fields": {
108
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
109
+ },
110
+ "sort_by": {
111
+ "desc": "field to sort on"
112
+ },
113
+ "sort_order": {
114
+ "desc": "ASC or DESC",
115
+ "enum": [
116
+ "ASC",
117
+ "DESC"
118
+ ]
119
+ },
120
+ "agg_by": {
121
+ "desc": "field to aggregate by, e.g. STALP: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
122
+ },
123
+ "agg_sum_fields": {
124
+ "desc": "fields to sum per bucket, e.g. ASSET,DEP"
125
+ },
126
+ "agg_term_fields": {
127
+ "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
128
+ },
129
+ "agg_limit": {
130
+ "desc": "number of aggregation buckets"
131
+ }
132
+ },
133
+ "defaults": {
134
+ "sort_by": "REPDTE",
135
+ "sort_order": "DESC"
136
+ },
137
+ "records": "data",
138
+ "total": "meta.total",
139
+ "paging": {
140
+ "type": "offset",
141
+ "limit_param": "limit",
142
+ "offset_param": "offset",
143
+ "size": 1000
144
+ },
145
+ "max_rows": 100000,
146
+ "missing": [
147
+ ""
148
+ ],
149
+ "flatten": true
150
+ },
151
+ "summary": {
152
+ "path": "/summary",
153
+ "method": "GET",
154
+ "description": "Annual aggregates by state (STNAME) and charter group (CB_SI: CB commercial banks, SI savings institutions) since 1934: BANKS, ASSET, DEP, NETINC, ... Includes aggregate rows 'All States and Territories', 'U.S. States and DC', 'U.S. Territories'.",
155
+ "params": {
156
+ "filters": {
157
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
158
+ },
159
+ "fields": {
160
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
161
+ },
162
+ "sort_by": {
163
+ "desc": "field to sort on"
164
+ },
165
+ "sort_order": {
166
+ "desc": "ASC or DESC",
167
+ "enum": [
168
+ "ASC",
169
+ "DESC"
170
+ ]
171
+ },
172
+ "agg_by": {
173
+ "desc": "field to aggregate by, e.g. YEAR"
174
+ },
175
+ "agg_sum_fields": {
176
+ "desc": "fields to sum, e.g. ASSET,DEP"
177
+ },
178
+ "agg_term_fields": {
179
+ "desc": "fields to count terms of"
180
+ },
181
+ "agg_limit": {
182
+ "desc": "number of aggregation buckets"
183
+ }
184
+ },
185
+ "defaults": {
186
+ "sort_by": "YEAR",
187
+ "sort_order": "DESC"
188
+ },
189
+ "records": "data",
190
+ "total": "meta.total",
191
+ "paging": {
192
+ "type": "offset",
193
+ "limit_param": "limit",
194
+ "offset_param": "offset",
195
+ "size": 1000
196
+ },
197
+ "max_rows": 100000,
198
+ "missing": [
199
+ ""
200
+ ],
201
+ "flatten": true
202
+ },
203
+ "sod": {
204
+ "path": "/sod",
205
+ "method": "GET",
206
+ "description": "Summary of Deposits: one row per branch per year (as of June 30, 1994-): CERT, NAMEFULL, BRNUM, CITYBR, STALPBR, CNTYNAMB, DEPSUMBR (branch deposits), YEAR.",
207
+ "params": {
208
+ "filters": {
209
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
210
+ },
211
+ "fields": {
212
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
213
+ },
214
+ "sort_by": {
215
+ "desc": "field to sort on"
216
+ },
217
+ "sort_order": {
218
+ "desc": "ASC or DESC",
219
+ "enum": [
220
+ "ASC",
221
+ "DESC"
222
+ ]
223
+ },
224
+ "agg_by": {
225
+ "desc": "field to aggregate by, e.g. STALPBR: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
226
+ },
227
+ "agg_sum_fields": {
228
+ "desc": "fields to sum per bucket, e.g. DEPSUMBR"
229
+ },
230
+ "agg_term_fields": {
231
+ "desc": "fields whose values are counted per bucket, e.g. BKCLASS"
232
+ },
233
+ "agg_limit": {
234
+ "desc": "number of aggregation buckets"
235
+ }
236
+ },
237
+ "defaults": {
238
+ "sort_by": "DEPSUMBR",
239
+ "sort_order": "DESC"
240
+ },
241
+ "records": "data",
242
+ "total": "meta.total",
243
+ "paging": {
244
+ "type": "offset",
245
+ "limit_param": "limit",
246
+ "offset_param": "offset",
247
+ "size": 1000
248
+ },
249
+ "max_rows": 100000,
250
+ "missing": [
251
+ ""
252
+ ],
253
+ "flatten": true
254
+ },
255
+ "history": {
256
+ "path": "/history",
257
+ "method": "GET",
258
+ "description": "Structure change events: mergers, failures, name and charter changes, branch openings and closings (CERT, EFFDATE, CHANGECODE, CHANGECODE_DESC, INSTNAME).",
259
+ "params": {
260
+ "filters": {
261
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
262
+ },
263
+ "fields": {
264
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
265
+ },
266
+ "sort_by": {
267
+ "desc": "field to sort on"
268
+ },
269
+ "sort_order": {
270
+ "desc": "ASC or DESC",
271
+ "enum": [
272
+ "ASC",
273
+ "DESC"
274
+ ]
275
+ },
276
+ "search": {
277
+ "desc": "flexible text search"
278
+ },
279
+ "agg_by": {
280
+ "desc": "field to aggregate by, e.g. CHANGECODE: one row per value with count (and sum_<field>, count_<field>_<value>) instead of records"
281
+ },
282
+ "agg_sum_fields": {
283
+ "desc": "fields to sum per bucket (numeric fields)"
284
+ },
285
+ "agg_term_fields": {
286
+ "desc": "fields whose values are counted per bucket, e.g. CLASS"
287
+ },
288
+ "agg_limit": {
289
+ "desc": "number of aggregation buckets"
290
+ }
291
+ },
292
+ "defaults": {
293
+ "sort_by": "EFFDATE",
294
+ "sort_order": "DESC"
295
+ },
296
+ "records": "data",
297
+ "total": "meta.total",
298
+ "paging": {
299
+ "type": "offset",
300
+ "limit_param": "limit",
301
+ "offset_param": "offset",
302
+ "size": 1000
303
+ },
304
+ "max_rows": 100000,
305
+ "missing": [
306
+ ""
307
+ ],
308
+ "flatten": true
309
+ },
310
+ "locations": {
311
+ "path": "/locations",
312
+ "method": "GET",
313
+ "description": "Branch and office locations of institutions (CERT, NAME, OFFNAME, ADDRESS, CITY, STALP, ZIP, COUNTY, LATITUDE, LONGITUDE, SERVTYPE).",
314
+ "params": {
315
+ "filters": {
316
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
317
+ },
318
+ "fields": {
319
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
320
+ },
321
+ "sort_by": {
322
+ "desc": "field to sort on"
323
+ },
324
+ "sort_order": {
325
+ "desc": "ASC or DESC",
326
+ "enum": [
327
+ "ASC",
328
+ "DESC"
329
+ ]
330
+ }
331
+ },
332
+ "defaults": {},
333
+ "records": "data",
334
+ "total": "meta.total",
335
+ "paging": {
336
+ "type": "offset",
337
+ "limit_param": "limit",
338
+ "offset_param": "offset",
339
+ "size": 1000
340
+ },
341
+ "max_rows": 100000,
342
+ "missing": [
343
+ ""
344
+ ],
345
+ "flatten": true
346
+ },
347
+ "demographics": {
348
+ "path": "/demographics",
349
+ "method": "GET",
350
+ "description": "Quarterly demographic and geographic attributes of institutions (office counts, CBSA, metro flags) keyed by CERT and REPDTE.",
351
+ "params": {
352
+ "filters": {
353
+ "desc": "Elasticsearch filter: STALP:\"WY\" AND ACTIVE:1, ASSET:[1000000 TO *], FAILDATE:[2008-01-01 TO 2010-12-31]"
354
+ },
355
+ "fields": {
356
+ "desc": "comma-separated field names (default: every field, often hundreds); always set this"
357
+ },
358
+ "sort_by": {
359
+ "desc": "field to sort on"
360
+ },
361
+ "sort_order": {
362
+ "desc": "ASC or DESC",
363
+ "enum": [
364
+ "ASC",
365
+ "DESC"
366
+ ]
367
+ }
368
+ },
369
+ "defaults": {},
370
+ "records": "data",
371
+ "total": "meta.total",
372
+ "paging": {
373
+ "type": "offset",
374
+ "limit_param": "limit",
375
+ "offset_param": "offset",
376
+ "size": 1000
377
+ },
378
+ "max_rows": 100000,
379
+ "missing": [
380
+ ""
381
+ ],
382
+ "flatten": true
383
+ }
384
+ },
385
+ "catalog": {},
386
+ "fields": {
387
+ "CERT": "FDIC certificate number: the institution id used by every endpoint",
388
+ "NAME": "institution name (institutions, failures, locations)",
389
+ "INSTNAME": "institution name (history, financials)",
390
+ "STALP": "state postal code (institutions, financials, locations); PSTALP in failures and history",
391
+ "STNAME": "state name (summary, institutions)",
392
+ "ACTIVE": "1 = open institution (institutions)",
393
+ "ASSET": "total assets, thousands of dollars",
394
+ "DEP": "total deposits, thousands of dollars",
395
+ "DEPDOM": "domestic deposits, thousands of dollars",
396
+ "NETINC": "net income, thousands of dollars; year-to-date in financials",
397
+ "ROA": "return on assets, percent (annualized)",
398
+ "ROE": "return on equity, percent (annualized)",
399
+ "LNLSNET": "net loans and leases, thousands of dollars",
400
+ "REPDTE": "report date: YYYYMMDD in financials, MM/DD/YYYY in institutions",
401
+ "FAILDATE": "failure date, M/D/YYYY text (failures)",
402
+ "FAILYR": "failure year (failures)",
403
+ "COST": "estimated loss to the Deposit Insurance Fund, thousands of dollars (failures)",
404
+ "QBFASSET": "total assets at failure, thousands of dollars",
405
+ "QBFDEP": "total deposits at failure, thousands of dollars",
406
+ "RESTYPE1": "transaction type code (failures): PA, P&A, PI, PO (payout), A/A, IDT, MGR, DINB, OBAM, ABT, REP",
407
+ "CB_SI": "summary charter group: CB commercial banks, SI savings institutions",
408
+ "BANKS": "number of institutions (summary)",
409
+ "DEPSUMBR": "branch deposits as of June 30, thousands of dollars (sod)",
410
+ "YEAR": "year (summary, sod)",
411
+ "EFFDATE": "event effective date (history)",
412
+ "CHANGECODE_DESC": "event type (history)",
413
+ "BKCLASS": "charter class (institutions): N national, SM state member, NM state nonmember, SB savings bank, SI state savings institution, SL savings and loan, NC, OI",
414
+ "RESTYPE": "FAILURE or ASSISTANCE (open-bank assistance); filter RESTYPE:\"FAILURE\" to count failures (failures)",
415
+ "REGAGNT": "primary federal regulator: OCC, FED, FDIC, ... (institutions)"
416
+ }
417
417
  }