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.
- package/README.md +286 -262
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +10 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +38 -18
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +46 -13
- package/dist/server.js.map +1 -1
- package/dist/tools.js +27 -6
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +164 -162
- package/guide/assets/download_data.sh +8 -2
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +198 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/college-scorecard/source.md +1 -1
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/doj-news/source.md +1 -1
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fbi/source.md +3 -3
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/fsa/source.md +1 -1
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nhtsa/source.md +1 -1
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/port.json +65 -0
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/uspto/source.md +1 -1
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
|
@@ -1,253 +1,253 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://api.data.gov/ed/collegescorecard/v1",
|
|
3
|
-
"endpoints": {
|
|
4
|
-
"schools": {
|
|
5
|
-
"path": "/schools.json",
|
|
6
|
-
"description": "Institution-level College Scorecard records: filter on any field (school.state=CA, school.ownership=1, <field>__range=lo..hi), choose columns with fields=, sort=<field>:asc|desc.",
|
|
7
|
-
"params": {
|
|
8
|
-
"fields": {
|
|
9
|
-
"desc": "comma-separated field names or catalog aliases (default: the popular set); without it every school has about 3,000 fields"
|
|
10
|
-
},
|
|
11
|
-
"sort": {
|
|
12
|
-
"desc": "<field>:asc or <field>:desc, e.g. latest.earnings.10_yrs_after_entry.median:desc"
|
|
13
|
-
},
|
|
14
|
-
"id": {
|
|
15
|
-
"desc": "UNITID (IPEDS id), e.g. 166683; comma-separated for several"
|
|
16
|
-
},
|
|
17
|
-
"school.name": {
|
|
18
|
-
"desc": "name search (partial words match), e.g. 'University of Delaware'"
|
|
19
|
-
},
|
|
20
|
-
"school.state": {
|
|
21
|
-
"desc": "two-letter state code; comma-separated for several (DE,MD)"
|
|
22
|
-
},
|
|
23
|
-
"school.ownership": {
|
|
24
|
-
"desc": "1 public, 2 private nonprofit, 3 private for-profit"
|
|
25
|
-
},
|
|
26
|
-
"school.degrees_awarded.predominant": {
|
|
27
|
-
"desc": "0 not classified, 1 certificate, 2 associate, 3 bachelor's, 4 graduate"
|
|
28
|
-
},
|
|
29
|
-
"name": {
|
|
30
|
-
"desc": "alias of school.name"
|
|
31
|
-
},
|
|
32
|
-
"state": {
|
|
33
|
-
"desc": "alias of school.state"
|
|
34
|
-
},
|
|
35
|
-
"ownership": {
|
|
36
|
-
"desc": "alias of school.ownership"
|
|
37
|
-
},
|
|
38
|
-
"predominant_degree": {
|
|
39
|
-
"desc": "alias of school.degrees_awarded.predominant"
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
"defaults": {},
|
|
43
|
-
"records": "results",
|
|
44
|
-
"total": "metadata.total",
|
|
45
|
-
"paging": {
|
|
46
|
-
"type": "page",
|
|
47
|
-
"page_param": "page",
|
|
48
|
-
"size_param": "per_page",
|
|
49
|
-
"size": 100,
|
|
50
|
-
"start": 0
|
|
51
|
-
},
|
|
52
|
-
"max_rows": 10000,
|
|
53
|
-
"missing": [
|
|
54
|
-
""
|
|
55
|
-
],
|
|
56
|
-
"flatten": true
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
|
-
"catalog": {
|
|
60
|
-
"name": {
|
|
61
|
-
"id": "school.name",
|
|
62
|
-
"name": "Institution name",
|
|
63
|
-
"description": "school name",
|
|
64
|
-
"endpoint": "schools"
|
|
65
|
-
},
|
|
66
|
-
"state": {
|
|
67
|
-
"id": "school.state",
|
|
68
|
-
"name": "State",
|
|
69
|
-
"description": "two-letter state postal code",
|
|
70
|
-
"endpoint": "schools"
|
|
71
|
-
},
|
|
72
|
-
"city": {
|
|
73
|
-
"id": "school.city",
|
|
74
|
-
"name": "City",
|
|
75
|
-
"description": "city",
|
|
76
|
-
"endpoint": "schools"
|
|
77
|
-
},
|
|
78
|
-
"url": {
|
|
79
|
-
"id": "school.school_url",
|
|
80
|
-
"name": "Website",
|
|
81
|
-
"description": "institution website",
|
|
82
|
-
"endpoint": "schools"
|
|
83
|
-
},
|
|
84
|
-
"ownership": {
|
|
85
|
-
"id": "school.ownership",
|
|
86
|
-
"name": "Control",
|
|
87
|
-
"description": "ownership control: 1 public, 2 private nonprofit, 3 private for-profit",
|
|
88
|
-
"endpoint": "schools"
|
|
89
|
-
},
|
|
90
|
-
"predominant_degree": {
|
|
91
|
-
"id": "school.degrees_awarded.predominant",
|
|
92
|
-
"name": "Predominant degree",
|
|
93
|
-
"description": "predominant degree awarded: 0-4 (certificate, associate, bachelor's, graduate)",
|
|
94
|
-
"endpoint": "schools"
|
|
95
|
-
},
|
|
96
|
-
"highest_degree": {
|
|
97
|
-
"id": "school.degrees_awarded.highest",
|
|
98
|
-
"name": "Highest degree",
|
|
99
|
-
"description": "highest degree awarded 0-4",
|
|
100
|
-
"endpoint": "schools"
|
|
101
|
-
},
|
|
102
|
-
"admission_rate": {
|
|
103
|
-
"id": "latest.admissions.admission_rate.overall",
|
|
104
|
-
"name": "Admission rate",
|
|
105
|
-
"description": "admission rate, share 0-1 (admissions selectivity)",
|
|
106
|
-
"endpoint": "schools"
|
|
107
|
-
},
|
|
108
|
-
"sat_avg": {
|
|
109
|
-
"id": "latest.admissions.sat_scores.average.overall",
|
|
110
|
-
"name": "SAT average",
|
|
111
|
-
"description": "average SAT equivalent score of admitted students",
|
|
112
|
-
"endpoint": "schools"
|
|
113
|
-
},
|
|
114
|
-
"size": {
|
|
115
|
-
"id": "latest.student.size",
|
|
116
|
-
"name": "Undergraduate enrollment",
|
|
117
|
-
"description": "number of degree-seeking undergraduate students (enrollment size)",
|
|
118
|
-
"endpoint": "schools"
|
|
119
|
-
},
|
|
120
|
-
"tuition_in_state": {
|
|
121
|
-
"id": "latest.cost.tuition.in_state",
|
|
122
|
-
"name": "In-state tuition and fees",
|
|
123
|
-
"description": "in-state tuition and fees, dollars per year (cost)",
|
|
124
|
-
"endpoint": "schools"
|
|
125
|
-
},
|
|
126
|
-
"tuition_out_of_state": {
|
|
127
|
-
"id": "latest.cost.tuition.out_of_state",
|
|
128
|
-
"name": "Out-of-state tuition and fees",
|
|
129
|
-
"description": "out-of-state tuition and fees, dollars per year (cost)",
|
|
130
|
-
"endpoint": "schools"
|
|
131
|
-
},
|
|
132
|
-
"net_price": {
|
|
133
|
-
"id": "latest.cost.avg_net_price.overall",
|
|
134
|
-
"name": "Average net price",
|
|
135
|
-
"description": "average annual net price after grant aid, Title IV students (cost)",
|
|
136
|
-
"endpoint": "schools"
|
|
137
|
-
},
|
|
138
|
-
"attendance_cost": {
|
|
139
|
-
"id": "latest.cost.attendance.academic_year",
|
|
140
|
-
"name": "Cost of attendance",
|
|
141
|
-
"description": "average cost of attendance, academic-year institutions (cost)",
|
|
142
|
-
"endpoint": "schools"
|
|
143
|
-
},
|
|
144
|
-
"median_debt": {
|
|
145
|
-
"id": "latest.aid.median_debt.completers.overall",
|
|
146
|
-
"name": "Median debt of completers",
|
|
147
|
-
"description": "median federal loan debt of students who completed (student debt, loans)",
|
|
148
|
-
"endpoint": "schools"
|
|
149
|
-
},
|
|
150
|
-
"pell_rate": {
|
|
151
|
-
"id": "latest.aid.pell_grant_rate",
|
|
152
|
-
"name": "Pell grant rate",
|
|
153
|
-
"description": "share of undergraduates receiving Pell grants (low income)",
|
|
154
|
-
"endpoint": "schools"
|
|
155
|
-
},
|
|
156
|
-
"loan_rate": {
|
|
157
|
-
"id": "latest.aid.federal_loan_rate",
|
|
158
|
-
"name": "Federal loan rate",
|
|
159
|
-
"description": "share of undergraduates with federal loans",
|
|
160
|
-
"endpoint": "schools"
|
|
161
|
-
},
|
|
162
|
-
"completion_rate": {
|
|
163
|
-
"id": "latest.completion.rate_suppressed.overall",
|
|
164
|
-
"name": "Completion rate",
|
|
165
|
-
"description": "completion (graduation) rate within 150% of normal time, share 0-1, small cohorts suppressed",
|
|
166
|
-
"endpoint": "schools"
|
|
167
|
-
},
|
|
168
|
-
"retention_rate": {
|
|
169
|
-
"id": "latest.student.retention_rate.four_year.full_time",
|
|
170
|
-
"name": "Retention rate",
|
|
171
|
-
"description": "first-time full-time retention rate, four-year institutions",
|
|
172
|
-
"endpoint": "schools"
|
|
173
|
-
},
|
|
174
|
-
"earnings_10yr": {
|
|
175
|
-
"id": "latest.earnings.10_yrs_after_entry.median",
|
|
176
|
-
"name": "Median earnings 10 years after entry",
|
|
177
|
-
"description": "median earnings of federally aided students working, 10 years after entry (salary, income)",
|
|
178
|
-
"endpoint": "schools"
|
|
179
|
-
},
|
|
180
|
-
"earnings_6yr": {
|
|
181
|
-
"id": "latest.earnings.6_yrs_after_entry.median",
|
|
182
|
-
"name": "Median earnings 6 years after entry",
|
|
183
|
-
"description": "median earnings 6 years after entry (salary, income)",
|
|
184
|
-
"endpoint": "schools"
|
|
185
|
-
},
|
|
186
|
-
"earnings_7yr": {
|
|
187
|
-
"id": "latest.earnings.7_yrs_after_entry.median",
|
|
188
|
-
"name": "Median earnings 7 years after entry",
|
|
189
|
-
"description": "median earnings 7 years after entry (salary, income); live in the API from October 2026",
|
|
190
|
-
"endpoint": "schools"
|
|
191
|
-
},
|
|
192
|
-
"default_rate_3yr": {
|
|
193
|
-
"id": "latest.repayment.3_yr_default_rate",
|
|
194
|
-
"name": "3-year cohort default rate",
|
|
195
|
-
"description": "official three-year cohort default rate (loan default); near zero for recent cohorts because federal loan repayment was paused 2020-2023",
|
|
196
|
-
"endpoint": "schools"
|
|
197
|
-
},
|
|
198
|
-
"share_white": {
|
|
199
|
-
"id": "latest.student.demographics.race_ethnicity.white",
|
|
200
|
-
"name": "Share White",
|
|
201
|
-
"description": "share of undergraduates who are White (race ethnicity demographics)",
|
|
202
|
-
"endpoint": "schools"
|
|
203
|
-
},
|
|
204
|
-
"share_black": {
|
|
205
|
-
"id": "latest.student.demographics.race_ethnicity.black",
|
|
206
|
-
"name": "Share Black",
|
|
207
|
-
"description": "share of undergraduates who are Black (race ethnicity demographics)",
|
|
208
|
-
"endpoint": "schools"
|
|
209
|
-
},
|
|
210
|
-
"share_hispanic": {
|
|
211
|
-
"id": "latest.student.demographics.race_ethnicity.hispanic",
|
|
212
|
-
"name": "Share Hispanic",
|
|
213
|
-
"description": "share of undergraduates who are Hispanic (race ethnicity demographics)",
|
|
214
|
-
"endpoint": "schools"
|
|
215
|
-
},
|
|
216
|
-
"share_first_generation": {
|
|
217
|
-
"id": "latest.student.share_firstgeneration",
|
|
218
|
-
"name": "First-generation share",
|
|
219
|
-
"description": "share of students who are first-generation college students",
|
|
220
|
-
"endpoint": "schools"
|
|
221
|
-
},
|
|
222
|
-
"locale": {
|
|
223
|
-
"id": "school.locale",
|
|
224
|
-
"name": "Locale",
|
|
225
|
-
"description": "urban-centric locale code (city, suburb, town, rural)",
|
|
226
|
-
"endpoint": "schools"
|
|
227
|
-
},
|
|
228
|
-
"carnegie_basic": {
|
|
229
|
-
"id": "school.carnegie_basic",
|
|
230
|
-
"name": "Carnegie classification",
|
|
231
|
-
"description": "Carnegie basic classification code",
|
|
232
|
-
"endpoint": "schools"
|
|
233
|
-
},
|
|
234
|
-
"hbcu": {
|
|
235
|
-
"id": "school.minority_serving.historically_black",
|
|
236
|
-
"name": "HBCU flag",
|
|
237
|
-
"description": "historically Black college or university (minority serving)",
|
|
238
|
-
"endpoint": "schools"
|
|
239
|
-
},
|
|
240
|
-
"operating": {
|
|
241
|
-
"id": "school.operating",
|
|
242
|
-
"name": "Operating flag",
|
|
243
|
-
"description": "1 if currently operating (closed schools have 0)",
|
|
244
|
-
"endpoint": "schools"
|
|
245
|
-
},
|
|
246
|
-
"programs_cip4": {
|
|
247
|
-
"id": "latest.programs.cip_4_digit",
|
|
248
|
-
"name": "Field-of-study records",
|
|
249
|
-
"description": "field of study (program, major) records with earnings and debt by credential; very large: request one school at a time",
|
|
250
|
-
"endpoint": "schools"
|
|
251
|
-
}
|
|
252
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://api.data.gov/ed/collegescorecard/v1",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"schools": {
|
|
5
|
+
"path": "/schools.json",
|
|
6
|
+
"description": "Institution-level College Scorecard records: filter on any field (school.state=CA, school.ownership=1, <field>__range=lo..hi), choose columns with fields=, sort=<field>:asc|desc.",
|
|
7
|
+
"params": {
|
|
8
|
+
"fields": {
|
|
9
|
+
"desc": "comma-separated field names or catalog aliases (default: the popular set); without it every school has about 3,000 fields"
|
|
10
|
+
},
|
|
11
|
+
"sort": {
|
|
12
|
+
"desc": "<field>:asc or <field>:desc, e.g. latest.earnings.10_yrs_after_entry.median:desc"
|
|
13
|
+
},
|
|
14
|
+
"id": {
|
|
15
|
+
"desc": "UNITID (IPEDS id), e.g. 166683; comma-separated for several"
|
|
16
|
+
},
|
|
17
|
+
"school.name": {
|
|
18
|
+
"desc": "name search (partial words match), e.g. 'University of Delaware'"
|
|
19
|
+
},
|
|
20
|
+
"school.state": {
|
|
21
|
+
"desc": "two-letter state code; comma-separated for several (DE,MD)"
|
|
22
|
+
},
|
|
23
|
+
"school.ownership": {
|
|
24
|
+
"desc": "1 public, 2 private nonprofit, 3 private for-profit"
|
|
25
|
+
},
|
|
26
|
+
"school.degrees_awarded.predominant": {
|
|
27
|
+
"desc": "0 not classified, 1 certificate, 2 associate, 3 bachelor's, 4 graduate"
|
|
28
|
+
},
|
|
29
|
+
"name": {
|
|
30
|
+
"desc": "alias of school.name"
|
|
31
|
+
},
|
|
32
|
+
"state": {
|
|
33
|
+
"desc": "alias of school.state"
|
|
34
|
+
},
|
|
35
|
+
"ownership": {
|
|
36
|
+
"desc": "alias of school.ownership"
|
|
37
|
+
},
|
|
38
|
+
"predominant_degree": {
|
|
39
|
+
"desc": "alias of school.degrees_awarded.predominant"
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"defaults": {},
|
|
43
|
+
"records": "results",
|
|
44
|
+
"total": "metadata.total",
|
|
45
|
+
"paging": {
|
|
46
|
+
"type": "page",
|
|
47
|
+
"page_param": "page",
|
|
48
|
+
"size_param": "per_page",
|
|
49
|
+
"size": 100,
|
|
50
|
+
"start": 0
|
|
51
|
+
},
|
|
52
|
+
"max_rows": 10000,
|
|
53
|
+
"missing": [
|
|
54
|
+
""
|
|
55
|
+
],
|
|
56
|
+
"flatten": true
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"catalog": {
|
|
60
|
+
"name": {
|
|
61
|
+
"id": "school.name",
|
|
62
|
+
"name": "Institution name",
|
|
63
|
+
"description": "school name",
|
|
64
|
+
"endpoint": "schools"
|
|
65
|
+
},
|
|
66
|
+
"state": {
|
|
67
|
+
"id": "school.state",
|
|
68
|
+
"name": "State",
|
|
69
|
+
"description": "two-letter state postal code",
|
|
70
|
+
"endpoint": "schools"
|
|
71
|
+
},
|
|
72
|
+
"city": {
|
|
73
|
+
"id": "school.city",
|
|
74
|
+
"name": "City",
|
|
75
|
+
"description": "city",
|
|
76
|
+
"endpoint": "schools"
|
|
77
|
+
},
|
|
78
|
+
"url": {
|
|
79
|
+
"id": "school.school_url",
|
|
80
|
+
"name": "Website",
|
|
81
|
+
"description": "institution website",
|
|
82
|
+
"endpoint": "schools"
|
|
83
|
+
},
|
|
84
|
+
"ownership": {
|
|
85
|
+
"id": "school.ownership",
|
|
86
|
+
"name": "Control",
|
|
87
|
+
"description": "ownership control: 1 public, 2 private nonprofit, 3 private for-profit",
|
|
88
|
+
"endpoint": "schools"
|
|
89
|
+
},
|
|
90
|
+
"predominant_degree": {
|
|
91
|
+
"id": "school.degrees_awarded.predominant",
|
|
92
|
+
"name": "Predominant degree",
|
|
93
|
+
"description": "predominant degree awarded: 0-4 (certificate, associate, bachelor's, graduate)",
|
|
94
|
+
"endpoint": "schools"
|
|
95
|
+
},
|
|
96
|
+
"highest_degree": {
|
|
97
|
+
"id": "school.degrees_awarded.highest",
|
|
98
|
+
"name": "Highest degree",
|
|
99
|
+
"description": "highest degree awarded 0-4",
|
|
100
|
+
"endpoint": "schools"
|
|
101
|
+
},
|
|
102
|
+
"admission_rate": {
|
|
103
|
+
"id": "latest.admissions.admission_rate.overall",
|
|
104
|
+
"name": "Admission rate",
|
|
105
|
+
"description": "admission rate, share 0-1 (admissions selectivity)",
|
|
106
|
+
"endpoint": "schools"
|
|
107
|
+
},
|
|
108
|
+
"sat_avg": {
|
|
109
|
+
"id": "latest.admissions.sat_scores.average.overall",
|
|
110
|
+
"name": "SAT average",
|
|
111
|
+
"description": "average SAT equivalent score of admitted students",
|
|
112
|
+
"endpoint": "schools"
|
|
113
|
+
},
|
|
114
|
+
"size": {
|
|
115
|
+
"id": "latest.student.size",
|
|
116
|
+
"name": "Undergraduate enrollment",
|
|
117
|
+
"description": "number of degree-seeking undergraduate students (enrollment size)",
|
|
118
|
+
"endpoint": "schools"
|
|
119
|
+
},
|
|
120
|
+
"tuition_in_state": {
|
|
121
|
+
"id": "latest.cost.tuition.in_state",
|
|
122
|
+
"name": "In-state tuition and fees",
|
|
123
|
+
"description": "in-state tuition and fees, dollars per year (cost)",
|
|
124
|
+
"endpoint": "schools"
|
|
125
|
+
},
|
|
126
|
+
"tuition_out_of_state": {
|
|
127
|
+
"id": "latest.cost.tuition.out_of_state",
|
|
128
|
+
"name": "Out-of-state tuition and fees",
|
|
129
|
+
"description": "out-of-state tuition and fees, dollars per year (cost)",
|
|
130
|
+
"endpoint": "schools"
|
|
131
|
+
},
|
|
132
|
+
"net_price": {
|
|
133
|
+
"id": "latest.cost.avg_net_price.overall",
|
|
134
|
+
"name": "Average net price",
|
|
135
|
+
"description": "average annual net price after grant aid, Title IV students (cost)",
|
|
136
|
+
"endpoint": "schools"
|
|
137
|
+
},
|
|
138
|
+
"attendance_cost": {
|
|
139
|
+
"id": "latest.cost.attendance.academic_year",
|
|
140
|
+
"name": "Cost of attendance",
|
|
141
|
+
"description": "average cost of attendance, academic-year institutions (cost)",
|
|
142
|
+
"endpoint": "schools"
|
|
143
|
+
},
|
|
144
|
+
"median_debt": {
|
|
145
|
+
"id": "latest.aid.median_debt.completers.overall",
|
|
146
|
+
"name": "Median debt of completers",
|
|
147
|
+
"description": "median federal loan debt of students who completed (student debt, loans)",
|
|
148
|
+
"endpoint": "schools"
|
|
149
|
+
},
|
|
150
|
+
"pell_rate": {
|
|
151
|
+
"id": "latest.aid.pell_grant_rate",
|
|
152
|
+
"name": "Pell grant rate",
|
|
153
|
+
"description": "share of undergraduates receiving Pell grants (low income)",
|
|
154
|
+
"endpoint": "schools"
|
|
155
|
+
},
|
|
156
|
+
"loan_rate": {
|
|
157
|
+
"id": "latest.aid.federal_loan_rate",
|
|
158
|
+
"name": "Federal loan rate",
|
|
159
|
+
"description": "share of undergraduates with federal loans",
|
|
160
|
+
"endpoint": "schools"
|
|
161
|
+
},
|
|
162
|
+
"completion_rate": {
|
|
163
|
+
"id": "latest.completion.rate_suppressed.overall",
|
|
164
|
+
"name": "Completion rate",
|
|
165
|
+
"description": "completion (graduation) rate within 150% of normal time, share 0-1, small cohorts suppressed",
|
|
166
|
+
"endpoint": "schools"
|
|
167
|
+
},
|
|
168
|
+
"retention_rate": {
|
|
169
|
+
"id": "latest.student.retention_rate.four_year.full_time",
|
|
170
|
+
"name": "Retention rate",
|
|
171
|
+
"description": "first-time full-time retention rate, four-year institutions",
|
|
172
|
+
"endpoint": "schools"
|
|
173
|
+
},
|
|
174
|
+
"earnings_10yr": {
|
|
175
|
+
"id": "latest.earnings.10_yrs_after_entry.median",
|
|
176
|
+
"name": "Median earnings 10 years after entry",
|
|
177
|
+
"description": "median earnings of federally aided students working, 10 years after entry (salary, income)",
|
|
178
|
+
"endpoint": "schools"
|
|
179
|
+
},
|
|
180
|
+
"earnings_6yr": {
|
|
181
|
+
"id": "latest.earnings.6_yrs_after_entry.median",
|
|
182
|
+
"name": "Median earnings 6 years after entry",
|
|
183
|
+
"description": "median earnings 6 years after entry (salary, income)",
|
|
184
|
+
"endpoint": "schools"
|
|
185
|
+
},
|
|
186
|
+
"earnings_7yr": {
|
|
187
|
+
"id": "latest.earnings.7_yrs_after_entry.median",
|
|
188
|
+
"name": "Median earnings 7 years after entry",
|
|
189
|
+
"description": "median earnings 7 years after entry (salary, income); live in the API from October 2026",
|
|
190
|
+
"endpoint": "schools"
|
|
191
|
+
},
|
|
192
|
+
"default_rate_3yr": {
|
|
193
|
+
"id": "latest.repayment.3_yr_default_rate",
|
|
194
|
+
"name": "3-year cohort default rate",
|
|
195
|
+
"description": "official three-year cohort default rate (loan default); near zero for recent cohorts because federal loan repayment was paused 2020-2023",
|
|
196
|
+
"endpoint": "schools"
|
|
197
|
+
},
|
|
198
|
+
"share_white": {
|
|
199
|
+
"id": "latest.student.demographics.race_ethnicity.white",
|
|
200
|
+
"name": "Share White",
|
|
201
|
+
"description": "share of undergraduates who are White (race ethnicity demographics)",
|
|
202
|
+
"endpoint": "schools"
|
|
203
|
+
},
|
|
204
|
+
"share_black": {
|
|
205
|
+
"id": "latest.student.demographics.race_ethnicity.black",
|
|
206
|
+
"name": "Share Black",
|
|
207
|
+
"description": "share of undergraduates who are Black (race ethnicity demographics)",
|
|
208
|
+
"endpoint": "schools"
|
|
209
|
+
},
|
|
210
|
+
"share_hispanic": {
|
|
211
|
+
"id": "latest.student.demographics.race_ethnicity.hispanic",
|
|
212
|
+
"name": "Share Hispanic",
|
|
213
|
+
"description": "share of undergraduates who are Hispanic (race ethnicity demographics)",
|
|
214
|
+
"endpoint": "schools"
|
|
215
|
+
},
|
|
216
|
+
"share_first_generation": {
|
|
217
|
+
"id": "latest.student.share_firstgeneration",
|
|
218
|
+
"name": "First-generation share",
|
|
219
|
+
"description": "share of students who are first-generation college students",
|
|
220
|
+
"endpoint": "schools"
|
|
221
|
+
},
|
|
222
|
+
"locale": {
|
|
223
|
+
"id": "school.locale",
|
|
224
|
+
"name": "Locale",
|
|
225
|
+
"description": "urban-centric locale code (city, suburb, town, rural)",
|
|
226
|
+
"endpoint": "schools"
|
|
227
|
+
},
|
|
228
|
+
"carnegie_basic": {
|
|
229
|
+
"id": "school.carnegie_basic",
|
|
230
|
+
"name": "Carnegie classification",
|
|
231
|
+
"description": "Carnegie basic classification code",
|
|
232
|
+
"endpoint": "schools"
|
|
233
|
+
},
|
|
234
|
+
"hbcu": {
|
|
235
|
+
"id": "school.minority_serving.historically_black",
|
|
236
|
+
"name": "HBCU flag",
|
|
237
|
+
"description": "historically Black college or university (minority serving)",
|
|
238
|
+
"endpoint": "schools"
|
|
239
|
+
},
|
|
240
|
+
"operating": {
|
|
241
|
+
"id": "school.operating",
|
|
242
|
+
"name": "Operating flag",
|
|
243
|
+
"description": "1 if currently operating (closed schools have 0)",
|
|
244
|
+
"endpoint": "schools"
|
|
245
|
+
},
|
|
246
|
+
"programs_cip4": {
|
|
247
|
+
"id": "latest.programs.cip_4_digit",
|
|
248
|
+
"name": "Field-of-study records",
|
|
249
|
+
"description": "field of study (program, major) records with earnings and debt by credential; very large: request one school at a time",
|
|
250
|
+
"endpoint": "schools"
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
253
|
}
|