data-analyst-mcp 0.3.0 → 0.4.0

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 (292) hide show
  1. package/README.md +286 -262
  2. package/dist/adapters/bjs.d.ts +13 -0
  3. package/dist/adapters/bjs.js +28 -0
  4. package/dist/adapters/bjs.js.map +1 -0
  5. package/dist/adapters/cbp.d.ts +5 -0
  6. package/dist/adapters/cbp.js +64 -0
  7. package/dist/adapters/cbp.js.map +1 -0
  8. package/dist/adapters/cdc-wonder.d.ts +5 -0
  9. package/dist/adapters/cdc-wonder.js +68 -0
  10. package/dist/adapters/cdc-wonder.js.map +1 -0
  11. package/dist/adapters/cpsc.d.ts +4 -0
  12. package/dist/adapters/cpsc.js +125 -0
  13. package/dist/adapters/cpsc.js.map +1 -0
  14. package/dist/adapters/fhwa.d.ts +9 -0
  15. package/dist/adapters/fhwa.js +16 -0
  16. package/dist/adapters/fhwa.js.map +1 -0
  17. package/dist/adapters/foreign-assistance.d.ts +9 -0
  18. package/dist/adapters/foreign-assistance.js +42 -0
  19. package/dist/adapters/foreign-assistance.js.map +1 -0
  20. package/dist/adapters/hud-ahar.d.ts +3 -0
  21. package/dist/adapters/hud-ahar.js +80 -0
  22. package/dist/adapters/hud-ahar.js.map +1 -0
  23. package/dist/adapters/nces.d.ts +10 -0
  24. package/dist/adapters/nces.js +32 -0
  25. package/dist/adapters/nces.js.map +1 -0
  26. package/dist/adapters/nsf.d.ts +11 -0
  27. package/dist/adapters/nsf.js +25 -0
  28. package/dist/adapters/nsf.js.map +1 -0
  29. package/dist/adapters/onrr.d.ts +9 -0
  30. package/dist/adapters/onrr.js +35 -0
  31. package/dist/adapters/onrr.js.map +1 -0
  32. package/dist/adapters/sba.d.ts +10 -0
  33. package/dist/adapters/sba.js +134 -0
  34. package/dist/adapters/sba.js.map +1 -0
  35. package/dist/adapters/treasury-tic.d.ts +30 -0
  36. package/dist/adapters/treasury-tic.js +149 -0
  37. package/dist/adapters/treasury-tic.js.map +1 -0
  38. package/dist/adapters/uscourts.d.ts +8 -0
  39. package/dist/adapters/uscourts.js +8 -0
  40. package/dist/adapters/uscourts.js.map +1 -0
  41. package/dist/analysis/cite.d.ts +9 -1
  42. package/dist/analysis/cite.js +9 -2
  43. package/dist/analysis/cite.js.map +1 -1
  44. package/dist/bin/cli.d.ts +2 -0
  45. package/dist/bin/cli.js +17 -0
  46. package/dist/bin/cli.js.map +1 -1
  47. package/dist/core/generic-rest.js +42 -17
  48. package/dist/core/generic-rest.js.map +1 -1
  49. package/dist/core/guard.d.ts +32 -0
  50. package/dist/core/guard.js +176 -0
  51. package/dist/core/guard.js.map +1 -0
  52. package/dist/core/http.d.ts +10 -0
  53. package/dist/core/http.js +36 -7
  54. package/dist/core/http.js.map +1 -1
  55. package/dist/core/keys.d.ts +13 -3
  56. package/dist/core/keys.js +67 -7
  57. package/dist/core/keys.js.map +1 -1
  58. package/dist/core/package.d.ts +12 -3
  59. package/dist/core/package.js +56 -12
  60. package/dist/core/package.js.map +1 -1
  61. package/dist/core/secret_patterns.d.ts +6 -0
  62. package/dist/core/secret_patterns.js +20 -0
  63. package/dist/core/secret_patterns.js.map +1 -0
  64. package/dist/core/tabular.d.ts +43 -1
  65. package/dist/core/tabular.js +149 -6
  66. package/dist/core/tabular.js.map +1 -1
  67. package/dist/envelope.js +3 -1
  68. package/dist/envelope.js.map +1 -1
  69. package/dist/index.d.ts +29 -22
  70. package/dist/index.js +45 -46
  71. package/dist/index.js.map +1 -1
  72. package/dist/remote/app.js +87 -31
  73. package/dist/remote/app.js.map +1 -1
  74. package/dist/remote/oauth.js +8 -1
  75. package/dist/remote/oauth.js.map +1 -1
  76. package/dist/remote/pages.d.ts +3 -7
  77. package/dist/remote/pages.js +49 -19
  78. package/dist/remote/pages.js.map +1 -1
  79. package/dist/remote/sign.d.ts +7 -1
  80. package/dist/remote/sign.js +33 -7
  81. package/dist/remote/sign.js.map +1 -1
  82. package/dist/remote/store.js +14 -5
  83. package/dist/remote/store.js.map +1 -1
  84. package/dist/report/audit_report.js +29 -7
  85. package/dist/report/audit_report.js.map +1 -1
  86. package/dist/report/build_report.js +34 -4
  87. package/dist/report/build_report.js.map +1 -1
  88. package/dist/report/method_audit.js +10 -1
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.d.ts +4 -1
  91. package/dist/report/scan_secrets.js +38 -18
  92. package/dist/report/scan_secrets.js.map +1 -1
  93. package/dist/server.d.ts +3 -1
  94. package/dist/server.js +46 -13
  95. package/dist/server.js.map +1 -1
  96. package/dist/tools.js +27 -6
  97. package/dist/tools.js.map +1 -1
  98. package/guide/WORKFLOW.md +134 -134
  99. package/guide/assets/disclaimer.txt +1 -1
  100. package/guide/assets/download_data.ps1 +164 -162
  101. package/guide/assets/download_data.sh +8 -2
  102. package/guide/assets/report_template.html +597 -597
  103. package/guide/references/routing.md +198 -171
  104. package/guide/references/style_guide.md +398 -398
  105. package/package.json +56 -56
  106. package/packs/acf/endpoints.json +114 -114
  107. package/packs/acf/policy.json +104 -104
  108. package/packs/actuaries/endpoints.json +82 -82
  109. package/packs/actuaries/policy.json +109 -109
  110. package/packs/bea/assets/download_bea.ps1 +182 -182
  111. package/packs/bea/docs/bea_api.md +461 -461
  112. package/packs/bea/docs/datasets.md +157 -157
  113. package/packs/bea/docs/report_patterns.md +112 -112
  114. package/packs/bea/policy.json +170 -170
  115. package/packs/bea/source.md +152 -152
  116. package/packs/bjs/endpoints.json +150 -0
  117. package/packs/bjs/policy.json +114 -0
  118. package/packs/bjs/source.md +98 -0
  119. package/packs/bls/assets/download_bls.ps1 +152 -152
  120. package/packs/bls/docs/analysis_patterns.md +108 -108
  121. package/packs/bls/docs/bls_api.md +73 -73
  122. package/packs/bls/docs/series_ids.md +149 -149
  123. package/packs/bls/policy.json +238 -238
  124. package/packs/bts/endpoints.json +346 -346
  125. package/packs/bts/policy.json +94 -94
  126. package/packs/cbp/endpoints.json +31 -0
  127. package/packs/cbp/policy.json +85 -0
  128. package/packs/cbp/source.md +57 -0
  129. package/packs/cdc/endpoints.json +197 -197
  130. package/packs/cdc/policy.json +83 -83
  131. package/packs/cdc/source.md +1 -1
  132. package/packs/cdc-wonder/endpoints.json +26 -0
  133. package/packs/cdc-wonder/policy.json +84 -0
  134. package/packs/cdc-wonder/source.md +53 -0
  135. package/packs/census/endpoints.json +99 -99
  136. package/packs/cfpb/endpoints.json +326 -326
  137. package/packs/cfpb/policy.json +119 -119
  138. package/packs/clinical-trials/endpoints.json +166 -166
  139. package/packs/clinical-trials/policy.json +84 -84
  140. package/packs/cms/endpoints.json +69 -69
  141. package/packs/cms/policy.json +96 -96
  142. package/packs/college-scorecard/endpoints.json +252 -252
  143. package/packs/college-scorecard/policy.json +106 -106
  144. package/packs/college-scorecard/source.md +1 -1
  145. package/packs/congress/endpoints.json +1701 -1701
  146. package/packs/congress/policy.json +117 -117
  147. package/packs/cpsc/endpoints.json +91 -0
  148. package/packs/cpsc/policy.json +91 -0
  149. package/packs/cpsc/source.md +76 -0
  150. package/packs/dhs-ohss/endpoints.json +66 -66
  151. package/packs/dhs-ohss/policy.json +107 -107
  152. package/packs/dhs-ohss/source.md +1 -1
  153. package/packs/doj-news/endpoints.json +59 -59
  154. package/packs/doj-news/policy.json +96 -96
  155. package/packs/doj-news/source.md +1 -1
  156. package/packs/dol/endpoints.json +817 -817
  157. package/packs/dol/policy.json +135 -135
  158. package/packs/eia/endpoints.json +717 -717
  159. package/packs/eia/policy.json +112 -112
  160. package/packs/epa/endpoints.json +291 -291
  161. package/packs/epa/policy.json +99 -99
  162. package/packs/epa-aqs/endpoints.json +173 -173
  163. package/packs/epa-aqs/policy.json +96 -96
  164. package/packs/fbi/endpoints.json +1841 -1841
  165. package/packs/fbi/policy.json +118 -118
  166. package/packs/fbi/source.md +3 -3
  167. package/packs/fda/endpoints.json +237 -237
  168. package/packs/fda/policy.json +121 -121
  169. package/packs/fdic/endpoints.json +416 -416
  170. package/packs/fdic/policy.json +83 -83
  171. package/packs/fec/endpoints.json +707 -707
  172. package/packs/fec/policy.json +93 -93
  173. package/packs/fed-board/endpoints.json +89 -89
  174. package/packs/fed-board/policy.json +136 -136
  175. package/packs/federal-register/endpoints.json +143 -143
  176. package/packs/federal-register/policy.json +86 -86
  177. package/packs/fema/endpoints.json +645 -645
  178. package/packs/fema/policy.json +103 -103
  179. package/packs/fhfa/endpoints.json +105 -105
  180. package/packs/fhfa/policy.json +109 -109
  181. package/packs/fhwa/endpoints.json +48 -0
  182. package/packs/fhwa/policy.json +91 -0
  183. package/packs/fhwa/source.md +59 -0
  184. package/packs/foreign-assistance/endpoints.json +166 -0
  185. package/packs/foreign-assistance/policy.json +80 -0
  186. package/packs/foreign-assistance/source.md +76 -0
  187. package/packs/fred/assets/download_fred.ps1 +122 -122
  188. package/packs/fred/docs/analysis_patterns.md +124 -124
  189. package/packs/fred/docs/fred_api.md +94 -94
  190. package/packs/fred/docs/series.md +188 -188
  191. package/packs/fred/policy.json +253 -253
  192. package/packs/fsa/endpoints.json +150 -150
  193. package/packs/fsa/policy.json +99 -99
  194. package/packs/fsa/source.md +1 -1
  195. package/packs/govinfo/endpoints.json +519 -519
  196. package/packs/gsa-calc/endpoints.json +93 -93
  197. package/packs/gsa-calc/policy.json +97 -97
  198. package/packs/hud/endpoints.json +146 -146
  199. package/packs/hud/policy.json +84 -84
  200. package/packs/hud/source.md +1 -1
  201. package/packs/hud-ahar/endpoints.json +92 -0
  202. package/packs/hud-ahar/policy.json +88 -0
  203. package/packs/hud-ahar/source.md +72 -0
  204. package/packs/ipums/docs/report_patterns.md +117 -117
  205. package/packs/irs-soi/endpoints.json +114 -114
  206. package/packs/irs-soi/policy.json +107 -107
  207. package/packs/medicaid/endpoints.json +412 -412
  208. package/packs/medicaid/policy.json +108 -108
  209. package/packs/naep/endpoints.json +217 -217
  210. package/packs/naep/policy.json +100 -100
  211. package/packs/naep/source.md +1 -1
  212. package/packs/nces/endpoints.json +101 -0
  213. package/packs/nces/policy.json +99 -0
  214. package/packs/nces/source.md +75 -0
  215. package/packs/nhtsa/endpoints.json +132 -132
  216. package/packs/nhtsa/policy.json +93 -93
  217. package/packs/nhtsa/source.md +1 -1
  218. package/packs/nih/endpoints.json +452 -452
  219. package/packs/nih/policy.json +86 -86
  220. package/packs/noaa/endpoints.json +431 -431
  221. package/packs/noaa/policy.json +95 -95
  222. package/packs/nrel/endpoints.json +327 -327
  223. package/packs/nrel/policy.json +96 -96
  224. package/packs/nsf/endpoints.json +33 -0
  225. package/packs/nsf/policy.json +83 -0
  226. package/packs/nsf/source.md +59 -0
  227. package/packs/nws/endpoints.json +271 -271
  228. package/packs/nws/policy.json +82 -82
  229. package/packs/nyfed/endpoints.json +80 -80
  230. package/packs/nyfed/policy.json +92 -92
  231. package/packs/omb/endpoints.json +460 -460
  232. package/packs/omb/policy.json +106 -106
  233. package/packs/onrr/endpoints.json +198 -0
  234. package/packs/onrr/policy.json +91 -0
  235. package/packs/onrr/source.md +55 -0
  236. package/packs/open-payments/endpoints.json +297 -297
  237. package/packs/open-payments/policy.json +101 -101
  238. package/packs/opm/assets/download_opm.ps1 +125 -125
  239. package/packs/opm/docs/fields.md +184 -184
  240. package/packs/opm/docs/opm_api.md +71 -71
  241. package/packs/opm/docs/report_patterns.md +83 -83
  242. package/packs/opm/lib/data_dictionary.csv +73 -73
  243. package/packs/pbgc/endpoints.json +483 -483
  244. package/packs/pbgc/policy.json +94 -94
  245. package/packs/philfed/endpoints.json +85 -85
  246. package/packs/philfed/policy.json +94 -94
  247. package/packs/port.json +65 -0
  248. package/packs/regulations/endpoints.json +287 -287
  249. package/packs/regulations/policy.json +86 -86
  250. package/packs/sba/endpoints.json +34 -0
  251. package/packs/sba/policy.json +86 -0
  252. package/packs/sba/source.md +60 -0
  253. package/packs/sec/endpoints.json +236 -236
  254. package/packs/sec/policy.json +86 -86
  255. package/packs/senate-lobbying/endpoints.json +553 -553
  256. package/packs/senate-lobbying/policy.json +99 -99
  257. package/packs/snapqc/endpoints.json +1426 -1426
  258. package/packs/snapqc/policy.json +92 -92
  259. package/packs/treasury/catalog.json +2267 -2267
  260. package/packs/treasury/docs/api_guide.md +245 -245
  261. package/packs/treasury/docs/datasets.md +56 -56
  262. package/packs/treasury/docs/report_patterns.md +126 -126
  263. package/packs/treasury/policy.json +159 -159
  264. package/packs/treasury/source.md +170 -165
  265. package/packs/treasury-tic/endpoints.json +77 -0
  266. package/packs/treasury-tic/policy.json +89 -0
  267. package/packs/treasury-tic/source.md +80 -0
  268. package/packs/treasury-yields/endpoints.json +226 -226
  269. package/packs/treasury-yields/policy.json +86 -86
  270. package/packs/usaspending/endpoints.json +1315 -1315
  271. package/packs/usaspending/policy.json +109 -109
  272. package/packs/uscourts/endpoints.json +22 -0
  273. package/packs/uscourts/policy.json +87 -0
  274. package/packs/uscourts/source.md +56 -0
  275. package/packs/usda-fna/policy.json +133 -133
  276. package/packs/usda-fooddata/endpoints.json +180 -180
  277. package/packs/usda-fooddata/policy.json +94 -94
  278. package/packs/usda-nass/endpoints.json +323 -323
  279. package/packs/usda-nass/policy.json +95 -95
  280. package/packs/usda-outlook/endpoints.json +86 -86
  281. package/packs/usda-outlook/policy.json +109 -109
  282. package/packs/usgs/endpoints.json +313 -313
  283. package/packs/usgs/policy.json +95 -95
  284. package/packs/usitc/endpoints.json +74 -74
  285. package/packs/usitc/policy.json +111 -111
  286. package/packs/uspto/endpoints.json +141 -141
  287. package/packs/uspto/policy.json +95 -95
  288. package/packs/uspto/source.md +1 -1
  289. package/packs/va/endpoints.json +414 -414
  290. package/packs/va/policy.json +101 -101
  291. package/packs/world-bank/endpoints.json +122 -122
  292. package/packs/world-bank/policy.json +101 -101
@@ -1,150 +1,150 @@
1
- {
2
- "base_url": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library",
3
- "timeout": 90,
4
- "endpoints": {
5
- "portfolio_summary": {
6
- "path": "/PortfolioSummary.xls",
7
- "method": "GET",
8
- "description": "Federal student loan portfolio outstanding (principal + interest, $ billions) and recipients (millions) by program: Direct Loans, FFEL, Perkins and Total (unduplicated recipients); one row per federal fiscal year (FY2007-2012) or fiscal-year quarter (FY2013 Q1 on) and program. Quarterly.",
9
- "params": {},
10
- "records": "$xls",
11
- "sheet": 1,
12
- "header_row": 1,
13
- "layout": "portfolio",
14
- "paging": {"type": "none"},
15
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
16
- },
17
- "portfolio_by_loan_status": {
18
- "path": "/PortfoliobyLoanStatus.xls",
19
- "method": "GET",
20
- "description": "Portfolio by loan status (in-school, grace, repayment, deferment, forbearance, cumulative in default, other): $ billions outstanding and recipients (millions) by fiscal-year quarter. Sheet: Direct Loan (default, FY2013 Q3 on), FFEL (all FFEL, FY2013 Q3 on), ED-Held FFEL (FY2016 on), Federally Managed (Direct Loans + ED-held FFEL, FY2016 Q4 on). Quarterly.",
21
- "params": {
22
- "sheet": {"in": "records", "desc": "Direct Loan (default), FFEL, ED-Held FFEL or Federally Managed",
23
- "enum": ["Direct Loan", "FFEL", "ED-Held FFEL", "Federally Managed"]}
24
- },
25
- "records": "$xls",
26
- "sheet": "Direct Loan",
27
- "header_row": 1,
28
- "layout": "portfolio",
29
- "paging": {"type": "none"},
30
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
31
- },
32
- "portfolio_by_loan_type": {
33
- "path": "/PortfoliobyLoanType.xls",
34
- "method": "GET",
35
- "description": "Portfolio by loan type, all programs (Stafford subsidized, unsubsidized, combined with unique recipients; Grad PLUS; Parent PLUS; Perkins; Consolidation): $ billions and recipients (millions) by fiscal-year quarter, FY2014 Q2 on. Quarterly.",
36
- "params": {},
37
- "records": "$xls",
38
- "sheet": 1,
39
- "header_row": 1,
40
- "layout": "portfolio",
41
- "paging": {"type": "none"},
42
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
43
- },
44
- "portfolio_by_delinquency": {
45
- "path": "/DLPortfoliobyDelinquencyStatus.xls",
46
- "method": "GET",
47
- "description": "Loans in repayment status by days delinquent (current, 31-90, 91-180, 181-270, 271-360, transferring to DMCS): $ billions and recipients (millions) by fiscal-year quarter. Sheet: DLPortfoliobyDelinquencyStatus (Direct Loans, default, FY2013 Q3 on), ED-HeldFFELbyDelinquencyStatus, FedManagedPortbyDelinquencyStat. Quarterly.",
48
- "params": {
49
- "sheet": {"in": "records", "desc": "DLPortfoliobyDelinquencyStatus (default), ED-HeldFFELbyDelinquencyStatus or FedManagedPortbyDelinquencyStat",
50
- "enum": ["DLPortfoliobyDelinquencyStatus", "ED-HeldFFELbyDelinquencyStatus", "FedManagedPortbyDelinquencyStat"]}
51
- },
52
- "records": "$xls",
53
- "sheet": "DLPortfoliobyDelinquencyStatus",
54
- "header_row": 1,
55
- "layout": "portfolio",
56
- "paging": {"type": "none"},
57
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
58
- },
59
- "portfolio_by_repayment_plan": {
60
- "path": "/DLPortfoliobyRepaymentPlan.xls",
61
- "method": "GET",
62
- "description": "Loans in repayment, deferment and forbearance by repayment plan (level, graduated, income-contingent, income-based, PAYE, SAVE, alternative, other; ED-held FFEL: income-sensitive): $ billions and recipients (millions) by fiscal-year quarter. Sheet: DLPortfoliobyRepaymentPlan (default), DL-IDRbyPFH, ED-HeldFFELbyRepaymentPlan, ED-HeldFFEL-IDRbyPFH, FedManagedPortbyRepaymentPlan, FedManaged-IDRbyPFH (IDR plans by partial financial hardship). Quarterly.",
63
- "params": {
64
- "sheet": {"in": "records", "desc": "DLPortfoliobyRepaymentPlan (default), DL-IDRbyPFH, ED-HeldFFELbyRepaymentPlan, ED-HeldFFEL-IDRbyPFH, FedManagedPortbyRepaymentPlan or FedManaged-IDRbyPFH",
65
- "enum": ["DLPortfoliobyRepaymentPlan", "DL-IDRbyPFH", "ED-HeldFFELbyRepaymentPlan", "ED-HeldFFEL-IDRbyPFH",
66
- "FedManagedPortbyRepaymentPlan", "FedManaged-IDRbyPFH"]}
67
- },
68
- "records": "$xls",
69
- "sheet": "DLPortfoliobyRepaymentPlan",
70
- "header_row": 1,
71
- "layout": "portfolio",
72
- "paging": {"type": "none"},
73
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
74
- },
75
- "portfolio_by_location": {
76
- "path": "/Portfolio-by-Location.xls",
77
- "method": "GET",
78
- "description": "Outstanding balance ($ billions) and borrowers (thousands) by borrower state of residence (plus Other, Not Reported), all programs, latest quarter only (as_of column; FFEL/Perkins borrowers of commercial lenders mostly Not Reported). Updated quarterly with a lag.",
79
- "params": {},
80
- "records": "$xls",
81
- "sheet": 1,
82
- "header_row": 1,
83
- "layout": "snapshot",
84
- "paging": {"type": "none"},
85
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
86
- },
87
- "portfolio_by_age": {
88
- "path": "/Portfolio-by-Age.xls",
89
- "method": "GET",
90
- "description": "Outstanding balance ($ billions) and borrowers (millions) by borrower age band (24 and younger, 25-34, 35-49, 50-61, 62 and older, not reported), all programs, by fiscal-year quarter from FY2017 Q2. Updated quarterly with a lag.",
91
- "params": {},
92
- "records": "$xls",
93
- "sheet": 1,
94
- "header_row": 1,
95
- "layout": "portfolio",
96
- "paging": {"type": "none"},
97
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
98
- },
99
- "portfolio_by_debt_size": {
100
- "path": "/Portfolio-by-Debt-Size.xls",
101
- "method": "GET",
102
- "description": "Outstanding balance ($ billions) and borrowers (millions) by the borrower's total federal loan balance (less than $5K ... $200K+), all programs, by fiscal-year quarter from FY2017 Q2. Updated quarterly with a lag.",
103
- "params": {},
104
- "records": "$xls",
105
- "sheet": 1,
106
- "header_row": 1,
107
- "layout": "portfolio",
108
- "paging": {"type": "none"},
109
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
110
- },
111
- "dl_volume_by_school": {
112
- "path": "/dl-dashboard-ay{ay_long}-q{q}.xls",
113
- "method": "GET",
114
- "description": "Direct Loan volume by school for one award year (July 1-June 30) and award-year quarter: recipients, loans originated (count, $) and disbursements (count, $) by school (OPE ID, name, state, ZIP, type) and loan program (subsidized, unsubsidized undergraduate and graduate, Parent PLUS, Grad PLUS). Sheet Award Year Summary (default: cumulative through the quarter) or Quarterly Activity. Award years 2018-19 on (file names verified 2026-10).",
115
- "params": {
116
- "award_year": {"in": "spec", "required": true, "desc": "award year, e.g. 2025-26 (July 1, 2025 - June 30, 2026); 2018-19 or later"},
117
- "quarter": {"in": "spec", "required": true, "desc": "award-year quarter 1-4 (1 = Jul-Sep, 4 = Apr-Jun); 4 holds the whole year"},
118
- "sheet": {"in": "records", "desc": "Award Year Summary (default, cumulative) or Quarterly Activity",
119
- "enum": ["Award Year Summary", "Quarterly Activity"]},
120
- "state": {"in": "spec", "desc": "two-letter state code(s) to keep (school location); foreign schools have none"},
121
- "school": {"in": "spec", "desc": "keep schools whose name contains this text (case-insensitive)"}
122
- },
123
- "records": "$xls",
124
- "sheet": "Award Year Summary",
125
- "header_row": 1,
126
- "layout": "school",
127
- "paging": {"type": "none"},
128
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
129
- },
130
- "grant_volume_by_school": {
131
- "path": "/grants-ay{ay_short}-q{q}.xls",
132
- "method": "GET",
133
- "description": "Grant volume by school for one award year and award-year quarter: recipients and disbursements ($) by school and program (Federal Pell Grant, TEACH; Iraq Afghanistan Service Grant in older years). Sheet Award Year Summary (default, cumulative) or Quarterly Activity. Award years 2018-19 on.",
134
- "params": {
135
- "award_year": {"in": "spec", "required": true, "desc": "award year, e.g. 2024-25; 2018-19 or later (the file name uses the short form ay24-25)"},
136
- "quarter": {"in": "spec", "required": true, "desc": "award-year quarter 1-4 (1 = Jul-Sep, 4 = Apr-Jun); 4 holds the whole year"},
137
- "sheet": {"in": "records", "desc": "Award Year Summary (default, cumulative) or Quarterly Activity",
138
- "enum": ["Award Year Summary", "Quarterly Activity"]},
139
- "state": {"in": "spec", "desc": "two-letter state code(s) to keep (school location)"},
140
- "school": {"in": "spec", "desc": "keep schools whose name contains this text (case-insensitive)"}
141
- },
142
- "records": "$xls",
143
- "sheet": "Award Year Summary",
144
- "header_row": 1,
145
- "layout": "school",
146
- "paging": {"type": "none"},
147
- "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
148
- }
149
- }
150
- }
1
+ {
2
+ "base_url": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library",
3
+ "timeout": 90,
4
+ "endpoints": {
5
+ "portfolio_summary": {
6
+ "path": "/PortfolioSummary.xls",
7
+ "method": "GET",
8
+ "description": "Federal student loan portfolio outstanding (principal + interest, $ billions) and recipients (millions) by program: Direct Loans, FFEL, Perkins and Total (unduplicated recipients); one row per federal fiscal year (FY2007-2012) or fiscal-year quarter (FY2013 Q1 on) and program. Quarterly.",
9
+ "params": {},
10
+ "records": "$xls",
11
+ "sheet": 1,
12
+ "header_row": 1,
13
+ "layout": "portfolio",
14
+ "paging": {"type": "none"},
15
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
16
+ },
17
+ "portfolio_by_loan_status": {
18
+ "path": "/PortfoliobyLoanStatus.xls",
19
+ "method": "GET",
20
+ "description": "Portfolio by loan status (in-school, grace, repayment, deferment, forbearance, cumulative in default, other): $ billions outstanding and recipients (millions) by fiscal-year quarter. Sheet: Direct Loan (default, FY2013 Q3 on), FFEL (all FFEL, FY2013 Q3 on), ED-Held FFEL (FY2016 on), Federally Managed (Direct Loans + ED-held FFEL, FY2016 Q4 on). Quarterly.",
21
+ "params": {
22
+ "sheet": {"in": "records", "desc": "Direct Loan (default), FFEL, ED-Held FFEL or Federally Managed",
23
+ "enum": ["Direct Loan", "FFEL", "ED-Held FFEL", "Federally Managed"]}
24
+ },
25
+ "records": "$xls",
26
+ "sheet": "Direct Loan",
27
+ "header_row": 1,
28
+ "layout": "portfolio",
29
+ "paging": {"type": "none"},
30
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
31
+ },
32
+ "portfolio_by_loan_type": {
33
+ "path": "/PortfoliobyLoanType.xls",
34
+ "method": "GET",
35
+ "description": "Portfolio by loan type, all programs (Stafford subsidized, unsubsidized, combined with unique recipients; Grad PLUS; Parent PLUS; Perkins; Consolidation): $ billions and recipients (millions) by fiscal-year quarter, FY2014 Q2 on. Quarterly.",
36
+ "params": {},
37
+ "records": "$xls",
38
+ "sheet": 1,
39
+ "header_row": 1,
40
+ "layout": "portfolio",
41
+ "paging": {"type": "none"},
42
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
43
+ },
44
+ "portfolio_by_delinquency": {
45
+ "path": "/DLPortfoliobyDelinquencyStatus.xls",
46
+ "method": "GET",
47
+ "description": "Loans in repayment status by days delinquent (current, 31-90, 91-180, 181-270, 271-360, transferring to DMCS): $ billions and recipients (millions) by fiscal-year quarter. Sheet: DLPortfoliobyDelinquencyStatus (Direct Loans, default, FY2013 Q3 on), ED-HeldFFELbyDelinquencyStatus, FedManagedPortbyDelinquencyStat. Quarterly.",
48
+ "params": {
49
+ "sheet": {"in": "records", "desc": "DLPortfoliobyDelinquencyStatus (default), ED-HeldFFELbyDelinquencyStatus or FedManagedPortbyDelinquencyStat",
50
+ "enum": ["DLPortfoliobyDelinquencyStatus", "ED-HeldFFELbyDelinquencyStatus", "FedManagedPortbyDelinquencyStat"]}
51
+ },
52
+ "records": "$xls",
53
+ "sheet": "DLPortfoliobyDelinquencyStatus",
54
+ "header_row": 1,
55
+ "layout": "portfolio",
56
+ "paging": {"type": "none"},
57
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
58
+ },
59
+ "portfolio_by_repayment_plan": {
60
+ "path": "/DLPortfoliobyRepaymentPlan.xls",
61
+ "method": "GET",
62
+ "description": "Loans in repayment, deferment and forbearance by repayment plan (level, graduated, income-contingent, income-based, PAYE, SAVE, alternative, other; ED-held FFEL: income-sensitive): $ billions and recipients (millions) by fiscal-year quarter. Sheet: DLPortfoliobyRepaymentPlan (default), DL-IDRbyPFH, ED-HeldFFELbyRepaymentPlan, ED-HeldFFEL-IDRbyPFH, FedManagedPortbyRepaymentPlan, FedManaged-IDRbyPFH (IDR plans by partial financial hardship). Quarterly.",
63
+ "params": {
64
+ "sheet": {"in": "records", "desc": "DLPortfoliobyRepaymentPlan (default), DL-IDRbyPFH, ED-HeldFFELbyRepaymentPlan, ED-HeldFFEL-IDRbyPFH, FedManagedPortbyRepaymentPlan or FedManaged-IDRbyPFH",
65
+ "enum": ["DLPortfoliobyRepaymentPlan", "DL-IDRbyPFH", "ED-HeldFFELbyRepaymentPlan", "ED-HeldFFEL-IDRbyPFH",
66
+ "FedManagedPortbyRepaymentPlan", "FedManaged-IDRbyPFH"]}
67
+ },
68
+ "records": "$xls",
69
+ "sheet": "DLPortfoliobyRepaymentPlan",
70
+ "header_row": 1,
71
+ "layout": "portfolio",
72
+ "paging": {"type": "none"},
73
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
74
+ },
75
+ "portfolio_by_location": {
76
+ "path": "/Portfolio-by-Location.xls",
77
+ "method": "GET",
78
+ "description": "Outstanding balance ($ billions) and borrowers (thousands) by borrower state of residence (plus Other, Not Reported), all programs, latest quarter only (as_of column; FFEL/Perkins borrowers of commercial lenders mostly Not Reported). Updated quarterly with a lag.",
79
+ "params": {},
80
+ "records": "$xls",
81
+ "sheet": 1,
82
+ "header_row": 1,
83
+ "layout": "snapshot",
84
+ "paging": {"type": "none"},
85
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
86
+ },
87
+ "portfolio_by_age": {
88
+ "path": "/Portfolio-by-Age.xls",
89
+ "method": "GET",
90
+ "description": "Outstanding balance ($ billions) and borrowers (millions) by borrower age band (24 and younger, 25-34, 35-49, 50-61, 62 and older, not reported), all programs, by fiscal-year quarter from FY2017 Q2. Updated quarterly with a lag.",
91
+ "params": {},
92
+ "records": "$xls",
93
+ "sheet": 1,
94
+ "header_row": 1,
95
+ "layout": "portfolio",
96
+ "paging": {"type": "none"},
97
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
98
+ },
99
+ "portfolio_by_debt_size": {
100
+ "path": "/Portfolio-by-Debt-Size.xls",
101
+ "method": "GET",
102
+ "description": "Outstanding balance ($ billions) and borrowers (millions) by the borrower's total federal loan balance (less than $5K ... $200K+), all programs, by fiscal-year quarter from FY2017 Q2. Updated quarterly with a lag.",
103
+ "params": {},
104
+ "records": "$xls",
105
+ "sheet": 1,
106
+ "header_row": 1,
107
+ "layout": "portfolio",
108
+ "paging": {"type": "none"},
109
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
110
+ },
111
+ "dl_volume_by_school": {
112
+ "path": "/dl-dashboard-ay{ay_long}-q{q}.xls",
113
+ "method": "GET",
114
+ "description": "Direct Loan volume by school for one award year (July 1-June 30) and award-year quarter: recipients, loans originated (count, $) and disbursements (count, $) by school (OPE ID, name, state, ZIP, type) and loan program (subsidized, unsubsidized undergraduate and graduate, Parent PLUS, Grad PLUS). Sheet Award Year Summary (default: cumulative through the quarter) or Quarterly Activity. Award years 2018-19 on (file names verified 2026-10).",
115
+ "params": {
116
+ "award_year": {"in": "spec", "required": true, "desc": "award year, e.g. 2025-26 (July 1, 2025 - June 30, 2026); 2018-19 or later"},
117
+ "quarter": {"in": "spec", "required": true, "desc": "award-year quarter 1-4 (1 = Jul-Sep, 4 = Apr-Jun); 4 holds the whole year"},
118
+ "sheet": {"in": "records", "desc": "Award Year Summary (default, cumulative) or Quarterly Activity",
119
+ "enum": ["Award Year Summary", "Quarterly Activity"]},
120
+ "state": {"in": "spec", "desc": "two-letter state code(s) to keep (school location); foreign schools have none"},
121
+ "school": {"in": "spec", "desc": "keep schools whose name contains this text (case-insensitive)"}
122
+ },
123
+ "records": "$xls",
124
+ "sheet": "Award Year Summary",
125
+ "header_row": 1,
126
+ "layout": "school",
127
+ "paging": {"type": "none"},
128
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
129
+ },
130
+ "grant_volume_by_school": {
131
+ "path": "/grants-ay{ay_short}-q{q}.xls",
132
+ "method": "GET",
133
+ "description": "Grant volume by school for one award year and award-year quarter: recipients and disbursements ($) by school and program (Federal Pell Grant, TEACH; Iraq Afghanistan Service Grant in older years). Sheet Award Year Summary (default, cumulative) or Quarterly Activity. Award years 2018-19 on.",
134
+ "params": {
135
+ "award_year": {"in": "spec", "required": true, "desc": "award year, e.g. 2024-25; 2018-19 or later (the file name uses the short form ay24-25)"},
136
+ "quarter": {"in": "spec", "required": true, "desc": "award-year quarter 1-4 (1 = Jul-Sep, 4 = Apr-Jun); 4 holds the whole year"},
137
+ "sheet": {"in": "records", "desc": "Award Year Summary (default, cumulative) or Quarterly Activity",
138
+ "enum": ["Award Year Summary", "Quarterly Activity"]},
139
+ "state": {"in": "spec", "desc": "two-letter state code(s) to keep (school location)"},
140
+ "school": {"in": "spec", "desc": "keep schools whose name contains this text (case-insensitive)"}
141
+ },
142
+ "records": "$xls",
143
+ "sheet": "Award Year Summary",
144
+ "header_row": 1,
145
+ "layout": "school",
146
+ "paging": {"type": "none"},
147
+ "missing": ["", "-", "NA", "NA*", "NA**", "NA***"]
148
+ }
149
+ }
150
+ }
@@ -1,99 +1,99 @@
1
- {
2
- "id": "fsa",
3
- "title": "Federal Student Aid Data Center (student loan portfolio, Title IV volume by school)",
4
- "agency": "U.S. Department of Education, Office of Federal Student Aid",
5
- "depth": "standard",
6
- "domains": [
7
- "education",
8
- "student loans",
9
- "federal credit",
10
- "higher education finance"
11
- ],
12
- "keywords": [
13
- "student loans",
14
- "student debt",
15
- "federal student loan portfolio",
16
- "outstanding student loans",
17
- "direct loans",
18
- "ffel",
19
- "perkins",
20
- "parent plus",
21
- "grad plus",
22
- "consolidation loans",
23
- "student loan default",
24
- "delinquency",
25
- "forbearance",
26
- "deferment",
27
- "repayment plan",
28
- "income-driven repayment",
29
- "idr",
30
- "save plan",
31
- "paye",
32
- "ibr",
33
- "borrowers by state",
34
- "borrowers by age",
35
- "pell grant",
36
- "pell recipients",
37
- "teach grant",
38
- "loan volume by school",
39
- "title iv",
40
- "federal student aid",
41
- "nslds"
42
- ],
43
- "questions": [
44
- "total federal student loan debt outstanding, latest quarter",
45
- "how many borrowers are in default or forbearance on Direct Loans",
46
- "outstanding student loans by repayment plan (SAVE, IBR, PAYE)",
47
- "student loan balance and borrowers by state",
48
- "Pell Grant disbursements at a college in the latest award year",
49
- "Direct Loan volume by school and loan type",
50
- "student debt held by borrowers aged 62 and older"
51
- ],
52
- "homepage": "https://studentaid.gov/data-center",
53
- "terms_url": "https://studentaid.gov/notices/website-privacy-policy",
54
- "auth": {
55
- "env": null,
56
- "required": "none",
57
- "placement": "none",
58
- "signup_url": null,
59
- "echoes_key": false
60
- },
61
- "limits": {
62
- "rps": 1,
63
- "burst": 3,
64
- "max_rows": 200000
65
- },
66
- "routes": {
67
- "api": {
68
- "base": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library",
69
- "probe": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library/PortfolioSummary.xls",
70
- "hosts": [
71
- "studentaid.gov"
72
- ]
73
- },
74
- "manual": {
75
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each is an .xls workbook on studentaid.gov), save it under the name shown and upload it. Without the links: open the FSA Data Center (https://studentaid.gov/data-center), Student Aid Data > Federal Student Loan Portfolio (https://studentaid.gov/data-center/student/portfolio) or Title IV Program Volume (https://studentaid.gov/data-center/student/title-iv), download the report's .xls and upload it, saying which report it is."
76
- }
77
- },
78
- "cache": {
79
- "mode": "run_only",
80
- "ttl_hours": null,
81
- "why": "Portfolio reports are refreshed quarterly in place and volume files are revised for seven quarters; data/ is reused only within a run."
82
- },
83
- "redistribution": {
84
- "mode": "allowed",
85
- "why": "Federal Student Aid Data Center reports are U.S. government works in the public domain (17 U.S.C. 105); they are aggregates with no personal data."
86
- },
87
- "notices": [],
88
- "retention": null,
89
- "citation": "U.S. Department of Education, Federal Student Aid, {dataset}, FSA Data Center (studentaid.gov/data-center), retrieved {retrieved_long}.",
90
- "audit_hooks": [],
91
- "clarify": [
92
- "Which loans: all federal student loans (Direct Loans + FFEL + Perkins, the Portfolio Summary total), Direct Loans only, or the federally managed portfolio (Direct Loans + ED-held FFEL)? Default: the total, with Direct Loans shown separately.",
93
- "Dollars or borrowers? Recipient counts cannot be added across programs or statuses (a recipient can hold several loan types); use the Total's unduplicated recipients for the count of people.",
94
- "Award year (July-June, for loan and grant volume by school) or federal fiscal year (October-September, for the portfolio)? Default: the latest complete one of whichever the report uses."
95
- ],
96
- "formats": [
97
- "xls"
98
- ]
99
- }
1
+ {
2
+ "id": "fsa",
3
+ "title": "Federal Student Aid Data Center (student loan portfolio, Title IV volume by school)",
4
+ "agency": "U.S. Department of Education, Office of Federal Student Aid",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "education",
8
+ "student loans",
9
+ "federal credit",
10
+ "higher education finance"
11
+ ],
12
+ "keywords": [
13
+ "student loans",
14
+ "student debt",
15
+ "federal student loan portfolio",
16
+ "outstanding student loans",
17
+ "direct loans",
18
+ "ffel",
19
+ "perkins",
20
+ "parent plus",
21
+ "grad plus",
22
+ "consolidation loans",
23
+ "student loan default",
24
+ "delinquency",
25
+ "forbearance",
26
+ "deferment",
27
+ "repayment plan",
28
+ "income-driven repayment",
29
+ "idr",
30
+ "save plan",
31
+ "paye",
32
+ "ibr",
33
+ "borrowers by state",
34
+ "borrowers by age",
35
+ "pell grant",
36
+ "pell recipients",
37
+ "teach grant",
38
+ "loan volume by school",
39
+ "title iv",
40
+ "federal student aid",
41
+ "nslds"
42
+ ],
43
+ "questions": [
44
+ "total federal student loan debt outstanding, latest quarter",
45
+ "how many borrowers are in default or forbearance on Direct Loans",
46
+ "outstanding student loans by repayment plan (SAVE, IBR, PAYE)",
47
+ "student loan balance and borrowers by state",
48
+ "Pell Grant disbursements at a college in the latest award year",
49
+ "Direct Loan volume by school and loan type",
50
+ "student debt held by borrowers aged 62 and older"
51
+ ],
52
+ "homepage": "https://studentaid.gov/data-center",
53
+ "terms_url": "https://studentaid.gov/notices/website-privacy-policy",
54
+ "auth": {
55
+ "env": null,
56
+ "required": "none",
57
+ "placement": "none",
58
+ "signup_url": null,
59
+ "echoes_key": false
60
+ },
61
+ "limits": {
62
+ "rps": 1,
63
+ "burst": 3,
64
+ "max_rows": 200000
65
+ },
66
+ "routes": {
67
+ "api": {
68
+ "base": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library",
69
+ "probe": "https://studentaid.gov/sites/default/files/fsawg/datacenter/library/PortfolioSummary.xls",
70
+ "hosts": [
71
+ "studentaid.gov"
72
+ ]
73
+ },
74
+ "manual": {
75
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each is an .xls workbook on studentaid.gov), save it under the name shown and upload it. Without the links: open the FSA Data Center (https://studentaid.gov/data-center), Student Aid Data > Federal Student Loan Portfolio (https://studentaid.gov/data-center/student/portfolio) or Title IV Program Volume (https://studentaid.gov/data-center/student/title-iv), download the report's .xls and upload it, saying which report it is."
76
+ }
77
+ },
78
+ "cache": {
79
+ "mode": "run_only",
80
+ "ttl_hours": null,
81
+ "why": "Portfolio reports are refreshed quarterly in place and volume files are revised for seven quarters; data/ is reused only within a run."
82
+ },
83
+ "redistribution": {
84
+ "mode": "allowed",
85
+ "why": "Federal Student Aid Data Center reports are U.S. government works in the public domain (17 U.S.C. 105); they are aggregates with no personal data."
86
+ },
87
+ "notices": [],
88
+ "retention": null,
89
+ "citation": "U.S. Department of Education, Federal Student Aid, {dataset}, FSA Data Center (studentaid.gov/data-center), retrieved {retrieved_long}.",
90
+ "audit_hooks": [],
91
+ "clarify": [
92
+ "Which loans: all federal student loans (Direct Loans + FFEL + Perkins, the Portfolio Summary total), Direct Loans only, or the federally managed portfolio (Direct Loans + ED-held FFEL)? Default: the total, with Direct Loans shown separately.",
93
+ "Dollars or borrowers? Recipient counts cannot be added across programs or statuses (a recipient can hold several loan types); use the Total's unduplicated recipients for the count of people.",
94
+ "Award year (July-June, for loan and grant volume by school) or federal fiscal year (October-September, for the portfolio)? Default: the latest complete one of whichever the report uses."
95
+ ],
96
+ "formats": [
97
+ "xls"
98
+ ]
99
+ }
@@ -11,7 +11,7 @@ school and award-year quarter (from COD). Published .xls workbooks, read into ti
11
11
  - Loans originated and disbursed, and Pell/TEACH grants disbursed, by school, state and program, per award year.
12
12
  - Not here: college costs, completion, earnings and debt at graduation by institution (college-scorecard);
13
13
  federal outlays and awards for student aid (treasury, usaspending); household debt from
14
- surveys (fred for the Fed's G.19 consumer credit series); enrollment counts (IPEDS, not a pack).
14
+ surveys (fred for the Fed's G.19 consumer credit series); enrollment counts (IPEDS: nces).
15
15
 
16
16
  ## Endpoints and datasets
17
17
  | Endpoint | Returns (one row per ...) | Params | Units | Coverage |