data-analyst-mcp 0.0.0-stage → 0.3.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 +262 -3
- package/dist/adapters/_acf_tidy.d.ts +18 -0
- package/dist/adapters/_acf_tidy.js +432 -0
- package/dist/adapters/_acf_tidy.js.map +1 -0
- package/dist/adapters/_actuaries_read.d.ts +38 -0
- package/dist/adapters/_actuaries_read.js +728 -0
- package/dist/adapters/_actuaries_read.js.map +1 -0
- package/dist/adapters/_census_micro.d.ts +70 -0
- package/dist/adapters/_census_micro.js +622 -0
- package/dist/adapters/_census_micro.js.map +1 -0
- package/dist/adapters/_census_util.d.ts +40 -0
- package/dist/adapters/_census_util.js +275 -0
- package/dist/adapters/_census_util.js.map +1 -0
- package/dist/adapters/_dol_states.d.ts +6 -0
- package/dist/adapters/_dol_states.js +58 -0
- package/dist/adapters/_dol_states.js.map +1 -0
- package/dist/adapters/_govinfo_entities.d.ts +4 -0
- package/dist/adapters/_govinfo_entities.js +6 -0
- package/dist/adapters/_govinfo_entities.js.map +1 -0
- package/dist/adapters/_govinfo_json.d.ts +13 -0
- package/dist/adapters/_govinfo_json.js +107 -0
- package/dist/adapters/_govinfo_json.js.map +1 -0
- package/dist/adapters/_govinfo_py.d.ts +22 -0
- package/dist/adapters/_govinfo_py.js +272 -0
- package/dist/adapters/_govinfo_py.js.map +1 -0
- package/dist/adapters/_govinfo_xml.d.ts +22 -0
- package/dist/adapters/_govinfo_xml.js +233 -0
- package/dist/adapters/_govinfo_xml.js.map +1 -0
- package/dist/adapters/_hud_excel.d.ts +2 -0
- package/dist/adapters/_hud_excel.js +166 -0
- package/dist/adapters/_hud_excel.js.map +1 -0
- package/dist/adapters/_omb_grid.d.ts +17 -0
- package/dist/adapters/_omb_grid.js +132 -0
- package/dist/adapters/_omb_grid.js.map +1 -0
- package/dist/adapters/_omb_util.d.ts +40 -0
- package/dist/adapters/_omb_util.js +192 -0
- package/dist/adapters/_omb_util.js.map +1 -0
- package/dist/adapters/_usaspending_state.d.ts +6 -0
- package/dist/adapters/_usaspending_state.js +54 -0
- package/dist/adapters/_usaspending_state.js.map +1 -0
- package/dist/adapters/_usda-fna_book.d.ts +59 -0
- package/dist/adapters/_usda-fna_book.js +869 -0
- package/dist/adapters/_usda-fna_book.js.map +1 -0
- package/dist/adapters/_usda-fna_pdf.d.ts +20 -0
- package/dist/adapters/_usda-fna_pdf.js +361 -0
- package/dist/adapters/_usda-fna_pdf.js.map +1 -0
- package/dist/adapters/_usda-outlook_read.d.ts +70 -0
- package/dist/adapters/_usda-outlook_read.js +362 -0
- package/dist/adapters/_usda-outlook_read.js.map +1 -0
- package/dist/adapters/acf.d.ts +3 -0
- package/dist/adapters/acf.js +187 -0
- package/dist/adapters/acf.js.map +1 -0
- package/dist/adapters/actuaries.d.ts +3 -0
- package/dist/adapters/actuaries.js +293 -0
- package/dist/adapters/actuaries.js.map +1 -0
- package/dist/adapters/bts.d.ts +3 -0
- package/dist/adapters/bts.js +26 -0
- package/dist/adapters/bts.js.map +1 -0
- package/dist/adapters/census-geocoder.d.ts +10 -0
- package/dist/adapters/census-geocoder.js +47 -0
- package/dist/adapters/census-geocoder.js.map +1 -0
- package/dist/adapters/census.d.ts +17 -0
- package/dist/adapters/census.js +983 -0
- package/dist/adapters/census.js.map +1 -0
- package/dist/adapters/cfpb.d.ts +7 -0
- package/dist/adapters/cfpb.js +348 -0
- package/dist/adapters/cfpb.js.map +1 -0
- package/dist/adapters/clinical-trials.d.ts +3 -0
- package/dist/adapters/clinical-trials.js +135 -0
- package/dist/adapters/clinical-trials.js.map +1 -0
- package/dist/adapters/cms.d.ts +3 -0
- package/dist/adapters/cms.js +292 -0
- package/dist/adapters/cms.js.map +1 -0
- package/dist/adapters/college-scorecard.d.ts +3 -0
- package/dist/adapters/college-scorecard.js +122 -0
- package/dist/adapters/college-scorecard.js.map +1 -0
- package/dist/adapters/congress.d.ts +33 -0
- package/dist/adapters/congress.js +589 -0
- package/dist/adapters/congress.js.map +1 -0
- package/dist/adapters/dhs-ohss.d.ts +13 -0
- package/dist/adapters/dhs-ohss.js +598 -0
- package/dist/adapters/dhs-ohss.js.map +1 -0
- package/dist/adapters/doj-news.d.ts +7 -0
- package/dist/adapters/doj-news.js +286 -0
- package/dist/adapters/doj-news.js.map +1 -0
- package/dist/adapters/dol.d.ts +4 -0
- package/dist/adapters/dol.js +634 -0
- package/dist/adapters/dol.js.map +1 -0
- package/dist/adapters/eia.d.ts +15 -0
- package/dist/adapters/eia.js +456 -0
- package/dist/adapters/eia.js.map +1 -0
- package/dist/adapters/epa-aqs.d.ts +3 -0
- package/dist/adapters/epa-aqs.js +357 -0
- package/dist/adapters/epa-aqs.js.map +1 -0
- package/dist/adapters/epa.d.ts +3 -0
- package/dist/adapters/epa.js +298 -0
- package/dist/adapters/epa.js.map +1 -0
- package/dist/adapters/fbi.d.ts +3 -0
- package/dist/adapters/fbi.js +192 -0
- package/dist/adapters/fbi.js.map +1 -0
- package/dist/adapters/fda.d.ts +5 -0
- package/dist/adapters/fda.js +184 -0
- package/dist/adapters/fda.js.map +1 -0
- package/dist/adapters/fdic.d.ts +4 -0
- package/dist/adapters/fdic.js +95 -0
- package/dist/adapters/fdic.js.map +1 -0
- package/dist/adapters/fec.d.ts +3 -0
- package/dist/adapters/fec.js +142 -0
- package/dist/adapters/fec.js.map +1 -0
- package/dist/adapters/fed-board.d.ts +12 -0
- package/dist/adapters/fed-board.js +581 -0
- package/dist/adapters/fed-board.js.map +1 -0
- package/dist/adapters/federal-register.d.ts +11 -0
- package/dist/adapters/federal-register.js +43 -0
- package/dist/adapters/federal-register.js.map +1 -0
- package/dist/adapters/fhfa.d.ts +3 -0
- package/dist/adapters/fhfa.js +253 -0
- package/dist/adapters/fhfa.js.map +1 -0
- package/dist/adapters/fsa.d.ts +9 -0
- package/dist/adapters/fsa.js +335 -0
- package/dist/adapters/fsa.js.map +1 -0
- package/dist/adapters/govinfo.d.ts +30 -0
- package/dist/adapters/govinfo.js +636 -0
- package/dist/adapters/govinfo.js.map +1 -0
- package/dist/adapters/gsa-calc.d.ts +10 -0
- package/dist/adapters/gsa-calc.js +318 -0
- package/dist/adapters/gsa-calc.js.map +1 -0
- package/dist/adapters/hud.d.ts +3 -0
- package/dist/adapters/hud.js +200 -0
- package/dist/adapters/hud.js.map +1 -0
- package/dist/adapters/index.d.ts +3 -0
- package/dist/adapters/index.js +25 -0
- package/dist/adapters/index.js.map +1 -0
- package/dist/adapters/irs-soi.d.ts +6 -0
- package/dist/adapters/irs-soi.js +576 -0
- package/dist/adapters/irs-soi.js.map +1 -0
- package/dist/adapters/naep.d.ts +15 -0
- package/dist/adapters/naep.js +341 -0
- package/dist/adapters/naep.js.map +1 -0
- package/dist/adapters/nhtsa.d.ts +10 -0
- package/dist/adapters/nhtsa.js +239 -0
- package/dist/adapters/nhtsa.js.map +1 -0
- package/dist/adapters/nih.d.ts +5 -0
- package/dist/adapters/nih.js +196 -0
- package/dist/adapters/nih.js.map +1 -0
- package/dist/adapters/noaa.d.ts +3 -0
- package/dist/adapters/noaa.js +148 -0
- package/dist/adapters/noaa.js.map +1 -0
- package/dist/adapters/nrel.d.ts +3 -0
- package/dist/adapters/nrel.js +186 -0
- package/dist/adapters/nrel.js.map +1 -0
- package/dist/adapters/nws.d.ts +3 -0
- package/dist/adapters/nws.js +119 -0
- package/dist/adapters/nws.js.map +1 -0
- package/dist/adapters/omb.d.ts +15 -0
- package/dist/adapters/omb.js +517 -0
- package/dist/adapters/omb.js.map +1 -0
- package/dist/adapters/open-payments.d.ts +5 -0
- package/dist/adapters/open-payments.js +149 -0
- package/dist/adapters/open-payments.js.map +1 -0
- package/dist/adapters/pbgc.d.ts +13 -0
- package/dist/adapters/pbgc.js +283 -0
- package/dist/adapters/pbgc.js.map +1 -0
- package/dist/adapters/philfed.d.ts +12 -0
- package/dist/adapters/philfed.js +59 -0
- package/dist/adapters/philfed.js.map +1 -0
- package/dist/adapters/regulations.d.ts +6 -0
- package/dist/adapters/regulations.js +58 -0
- package/dist/adapters/regulations.js.map +1 -0
- package/dist/adapters/sec.d.ts +13 -0
- package/dist/adapters/sec.js +504 -0
- package/dist/adapters/sec.js.map +1 -0
- package/dist/adapters/senate-lobbying.d.ts +3 -0
- package/dist/adapters/senate-lobbying.js +181 -0
- package/dist/adapters/senate-lobbying.js.map +1 -0
- package/dist/adapters/snapqc.d.ts +32 -0
- package/dist/adapters/snapqc.js +701 -0
- package/dist/adapters/snapqc.js.map +1 -0
- package/dist/adapters/treasury-yields.d.ts +3 -0
- package/dist/adapters/treasury-yields.js +170 -0
- package/dist/adapters/treasury-yields.js.map +1 -0
- package/dist/adapters/usaspending.d.ts +3 -0
- package/dist/adapters/usaspending.js +340 -0
- package/dist/adapters/usaspending.js.map +1 -0
- package/dist/adapters/usda-fna.d.ts +7 -0
- package/dist/adapters/usda-fna.js +707 -0
- package/dist/adapters/usda-fna.js.map +1 -0
- package/dist/adapters/usda-fooddata.d.ts +3 -0
- package/dist/adapters/usda-fooddata.js +101 -0
- package/dist/adapters/usda-fooddata.js.map +1 -0
- package/dist/adapters/usda-nass.d.ts +3 -0
- package/dist/adapters/usda-nass.js +108 -0
- package/dist/adapters/usda-nass.js.map +1 -0
- package/dist/adapters/usda-outlook.d.ts +12 -0
- package/dist/adapters/usda-outlook.js +696 -0
- package/dist/adapters/usda-outlook.js.map +1 -0
- package/dist/adapters/usgs.d.ts +9 -0
- package/dist/adapters/usgs.js +265 -0
- package/dist/adapters/usgs.js.map +1 -0
- package/dist/adapters/usitc.d.ts +18 -0
- package/dist/adapters/usitc.js +170 -0
- package/dist/adapters/usitc.js.map +1 -0
- package/dist/adapters/uspto.d.ts +3 -0
- package/dist/adapters/uspto.js +47 -0
- package/dist/adapters/uspto.js.map +1 -0
- package/dist/adapters/world-bank.d.ts +3 -0
- package/dist/adapters/world-bank.js +163 -0
- package/dist/adapters/world-bank.js.map +1 -0
- package/dist/analysis/cite.d.ts +31 -0
- package/dist/analysis/cite.js +229 -0
- package/dist/analysis/cite.js.map +1 -0
- package/dist/analysis/combine.d.ts +27 -0
- package/dist/analysis/combine.js +198 -0
- package/dist/analysis/combine.js.map +1 -0
- package/dist/analysis/compute.d.ts +62 -0
- package/dist/analysis/compute.js +583 -0
- package/dist/analysis/compute.js.map +1 -0
- package/dist/analysis/expr.d.ts +69 -0
- package/dist/analysis/expr.js +780 -0
- package/dist/analysis/expr.js.map +1 -0
- package/dist/analysis/factfmt.d.ts +16 -0
- package/dist/analysis/factfmt.js +187 -0
- package/dist/analysis/factfmt.js.map +1 -0
- package/dist/analysis/facts.d.ts +63 -0
- package/dist/analysis/facts.js +355 -0
- package/dist/analysis/facts.js.map +1 -0
- package/dist/analysis/handoff.d.ts +58 -0
- package/dist/analysis/handoff.js +208 -0
- package/dist/analysis/handoff.js.map +1 -0
- package/dist/analysis/pyfmt.d.ts +16 -0
- package/dist/analysis/pyfmt.js +156 -0
- package/dist/analysis/pyfmt.js.map +1 -0
- package/dist/analysis/rerun.d.ts +13 -0
- package/dist/analysis/rerun.js +125 -0
- package/dist/analysis/rerun.js.map +1 -0
- package/dist/analysis/table.d.ts +18 -0
- package/dist/analysis/table.js +109 -0
- package/dist/analysis/table.js.map +1 -0
- package/dist/analysis/tools.d.ts +67 -0
- package/dist/analysis/tools.js +217 -0
- package/dist/analysis/tools.js.map +1 -0
- package/dist/analysis/write_table.d.ts +13 -0
- package/dist/analysis/write_table.js +59 -0
- package/dist/analysis/write_table.js.map +1 -0
- package/dist/bin/cli.d.ts +10 -0
- package/dist/bin/cli.js +177 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/core/cache.d.ts +14 -0
- package/dist/core/cache.js +90 -0
- package/dist/core/cache.js.map +1 -0
- package/dist/core/context.d.ts +12 -0
- package/dist/core/context.js +15 -0
- package/dist/core/context.js.map +1 -0
- package/dist/core/env.d.ts +14 -0
- package/dist/core/env.js +52 -0
- package/dist/core/env.js.map +1 -0
- package/dist/core/generic-rest.d.ts +61 -0
- package/dist/core/generic-rest.js +639 -0
- package/dist/core/generic-rest.js.map +1 -0
- package/dist/core/http.d.ts +120 -0
- package/dist/core/http.js +514 -0
- package/dist/core/http.js.map +1 -0
- package/dist/core/keys.d.ts +43 -0
- package/dist/core/keys.js +174 -0
- package/dist/core/keys.js.map +1 -0
- package/dist/core/manual.d.ts +41 -0
- package/dist/core/manual.js +218 -0
- package/dist/core/manual.js.map +1 -0
- package/dist/core/package.d.ts +58 -0
- package/dist/core/package.js +228 -0
- package/dist/core/package.js.map +1 -0
- package/dist/core/packs.d.ts +139 -0
- package/dist/core/packs.js +173 -0
- package/dist/core/packs.js.map +1 -0
- package/dist/core/policy.d.ts +69 -0
- package/dist/core/policy.js +189 -0
- package/dist/core/policy.js.map +1 -0
- package/dist/core/py.d.ts +40 -0
- package/dist/core/py.js +171 -0
- package/dist/core/py.js.map +1 -0
- package/dist/core/routing.d.ts +10 -0
- package/dist/core/routing.js +39 -0
- package/dist/core/routing.js.map +1 -0
- package/dist/core/tabular.d.ts +21 -0
- package/dist/core/tabular.js +229 -0
- package/dist/core/tabular.js.map +1 -0
- package/dist/deep/_bea_api.d.ts +102 -0
- package/dist/deep/_bea_api.js +457 -0
- package/dist/deep/_bea_api.js.map +1 -0
- package/dist/deep/_bea_fetch.d.ts +151 -0
- package/dist/deep/_bea_fetch.js +1274 -0
- package/dist/deep/_bea_fetch.js.map +1 -0
- package/dist/deep/_bea_util.d.ts +14 -0
- package/dist/deep/_bea_util.js +156 -0
- package/dist/deep/_bea_util.js.map +1 -0
- package/dist/deep/_bls_api.d.ts +84 -0
- package/dist/deep/_bls_api.js +231 -0
- package/dist/deep/_bls_api.js.map +1 -0
- package/dist/deep/_bls_ids.d.ts +43 -0
- package/dist/deep/_bls_ids.js +188 -0
- package/dist/deep/_bls_ids.js.map +1 -0
- package/dist/deep/_bls_lib.d.ts +61 -0
- package/dist/deep/_bls_lib.js +442 -0
- package/dist/deep/_bls_lib.js.map +1 -0
- package/dist/deep/_fred_api.d.ts +148 -0
- package/dist/deep/_fred_api.js +545 -0
- package/dist/deep/_fred_api.js.map +1 -0
- package/dist/deep/_fred_pack.d.ts +162 -0
- package/dist/deep/_fred_pack.js +1027 -0
- package/dist/deep/_fred_pack.js.map +1 -0
- package/dist/deep/_fred_py.d.ts +40 -0
- package/dist/deep/_fred_py.js +199 -0
- package/dist/deep/_fred_py.js.map +1 -0
- package/dist/deep/_ipums_bundle.d.ts +29 -0
- package/dist/deep/_ipums_bundle.js +194 -0
- package/dist/deep/_ipums_bundle.js.map +1 -0
- package/dist/deep/_ipums_ddi.d.ts +23 -0
- package/dist/deep/_ipums_ddi.js +162 -0
- package/dist/deep/_ipums_ddi.js.map +1 -0
- package/dist/deep/_opm_io.d.ts +26 -0
- package/dist/deep/_opm_io.js +383 -0
- package/dist/deep/_opm_io.js.map +1 -0
- package/dist/deep/_opm_parquet.d.ts +31 -0
- package/dist/deep/_opm_parquet.js +744 -0
- package/dist/deep/_opm_parquet.js.map +1 -0
- package/dist/deep/_opm_py.d.ts +6 -0
- package/dist/deep/_opm_py.js +74 -0
- package/dist/deep/_opm_py.js.map +1 -0
- package/dist/deep/_treasury_api.d.ts +48 -0
- package/dist/deep/_treasury_api.js +221 -0
- package/dist/deep/_treasury_api.js.map +1 -0
- package/dist/deep/_treasury_context.d.ts +34 -0
- package/dist/deep/_treasury_context.js +142 -0
- package/dist/deep/_treasury_context.js.map +1 -0
- package/dist/deep/_treasury_lib.d.ts +109 -0
- package/dist/deep/_treasury_lib.js +686 -0
- package/dist/deep/_treasury_lib.js.map +1 -0
- package/dist/deep/bea.d.ts +3 -0
- package/dist/deep/bea.js +248 -0
- package/dist/deep/bea.js.map +1 -0
- package/dist/deep/bls.d.ts +3 -0
- package/dist/deep/bls.js +220 -0
- package/dist/deep/bls.js.map +1 -0
- package/dist/deep/fred.d.ts +3 -0
- package/dist/deep/fred.js +325 -0
- package/dist/deep/fred.js.map +1 -0
- package/dist/deep/ipums.d.ts +59 -0
- package/dist/deep/ipums.js +744 -0
- package/dist/deep/ipums.js.map +1 -0
- package/dist/deep/opm.d.ts +56 -0
- package/dist/deep/opm.js +1033 -0
- package/dist/deep/opm.js.map +1 -0
- package/dist/deep/treasury.d.ts +3 -0
- package/dist/deep/treasury.js +218 -0
- package/dist/deep/treasury.js.map +1 -0
- package/dist/envelope.d.ts +47 -0
- package/dist/envelope.js +88 -0
- package/dist/envelope.js.map +1 -0
- package/dist/index.d.ts +277 -0
- package/dist/index.js +106 -0
- package/dist/index.js.map +1 -0
- package/dist/remote/app.d.ts +21 -0
- package/dist/remote/app.js +218 -0
- package/dist/remote/app.js.map +1 -0
- package/dist/remote/oauth.d.ts +14 -0
- package/dist/remote/oauth.js +90 -0
- package/dist/remote/oauth.js.map +1 -0
- package/dist/remote/pages.d.ts +8 -0
- package/dist/remote/pages.js +56 -0
- package/dist/remote/pages.js.map +1 -0
- package/dist/remote/sign.d.ts +4 -0
- package/dist/remote/sign.js +40 -0
- package/dist/remote/sign.js.map +1 -0
- package/dist/remote/store.d.ts +31 -0
- package/dist/remote/store.js +129 -0
- package/dist/remote/store.js.map +1 -0
- package/dist/report/audit_answer.d.ts +94 -0
- package/dist/report/audit_answer.js +1349 -0
- package/dist/report/audit_answer.js.map +1 -0
- package/dist/report/audit_report.d.ts +23 -0
- package/dist/report/audit_report.js +637 -0
- package/dist/report/audit_report.js.map +1 -0
- package/dist/report/build_report.d.ts +27 -0
- package/dist/report/build_report.js +1168 -0
- package/dist/report/build_report.js.map +1 -0
- package/dist/report/method_audit.d.ts +47 -0
- package/dist/report/method_audit.js +710 -0
- package/dist/report/method_audit.js.map +1 -0
- package/dist/report/policyset.d.ts +50 -0
- package/dist/report/policyset.js +421 -0
- package/dist/report/policyset.js.map +1 -0
- package/dist/report/py.d.ts +58 -0
- package/dist/report/py.js +311 -0
- package/dist/report/py.js.map +1 -0
- package/dist/report/scan_secrets.d.ts +21 -0
- package/dist/report/scan_secrets.js +234 -0
- package/dist/report/scan_secrets.js.map +1 -0
- package/dist/report/style_check.d.ts +29 -0
- package/dist/report/style_check.js +173 -0
- package/dist/report/style_check.js.map +1 -0
- package/dist/report/tools.d.ts +87 -0
- package/dist/report/tools.js +167 -0
- package/dist/report/tools.js.map +1 -0
- package/dist/server.d.ts +5 -0
- package/dist/server.js +246 -0
- package/dist/server.js.map +1 -0
- package/dist/session.d.ts +47 -0
- package/dist/session.js +107 -0
- package/dist/session.js.map +1 -0
- package/dist/toolkit.d.ts +21 -0
- package/dist/toolkit.js +2 -0
- package/dist/toolkit.js.map +1 -0
- package/dist/tools.d.ts +299 -0
- package/dist/tools.js +491 -0
- package/dist/tools.js.map +1 -0
- package/guide/WORKFLOW.md +134 -0
- package/guide/assets/disclaimer.txt +1 -0
- package/guide/assets/download_data.ps1 +162 -0
- package/guide/assets/download_data.sh +143 -0
- package/guide/assets/report_template.html +597 -0
- package/guide/references/report_patterns.md +199 -0
- package/guide/references/routing.md +171 -0
- package/guide/references/style_guide.md +398 -0
- package/package.json +56 -6
- package/packs/acf/endpoints.json +114 -0
- package/packs/acf/policy.json +104 -0
- package/packs/acf/source.md +138 -0
- package/packs/actuaries/endpoints.json +82 -0
- package/packs/actuaries/policy.json +109 -0
- package/packs/actuaries/source.md +137 -0
- package/packs/bea/assets/download_bea.ps1 +182 -0
- package/packs/bea/assets/download_bea.sh +144 -0
- package/packs/bea/docs/bea_api.md +461 -0
- package/packs/bea/docs/datasets.md +157 -0
- package/packs/bea/docs/report_patterns.md +112 -0
- package/packs/bea/policy.json +170 -0
- package/packs/bea/source.md +152 -0
- package/packs/bls/assets/download_bls.ps1 +152 -0
- package/packs/bls/assets/download_bls.sh +167 -0
- package/packs/bls/docs/analysis_patterns.md +108 -0
- package/packs/bls/docs/bls_api.md +73 -0
- package/packs/bls/docs/series_ids.md +149 -0
- package/packs/bls/policy.json +238 -0
- package/packs/bls/series_ids.json +1375 -0
- package/packs/bls/source.md +156 -0
- package/packs/bts/endpoints.json +347 -0
- package/packs/bts/policy.json +94 -0
- package/packs/bts/source.md +97 -0
- package/packs/cdc/endpoints.json +197 -0
- package/packs/cdc/policy.json +83 -0
- package/packs/cdc/source.md +74 -0
- package/packs/census/endpoints.json +99 -0
- package/packs/census/policy.json +238 -0
- package/packs/census/source.md +304 -0
- package/packs/census-geocoder/endpoints.json +70 -0
- package/packs/census-geocoder/policy.json +80 -0
- package/packs/census-geocoder/source.md +53 -0
- package/packs/cfpb/endpoints.json +327 -0
- package/packs/cfpb/policy.json +119 -0
- package/packs/cfpb/source.md +96 -0
- package/packs/clinical-trials/endpoints.json +167 -0
- package/packs/clinical-trials/policy.json +84 -0
- package/packs/clinical-trials/source.md +82 -0
- package/packs/cms/endpoints.json +69 -0
- package/packs/cms/policy.json +96 -0
- package/packs/cms/source.md +112 -0
- package/packs/college-scorecard/endpoints.json +253 -0
- package/packs/college-scorecard/policy.json +106 -0
- package/packs/college-scorecard/source.md +92 -0
- package/packs/congress/endpoints.json +1701 -0
- package/packs/congress/policy.json +117 -0
- package/packs/congress/source.md +190 -0
- package/packs/dhs-ohss/endpoints.json +66 -0
- package/packs/dhs-ohss/policy.json +107 -0
- package/packs/dhs-ohss/source.md +120 -0
- package/packs/doj-news/endpoints.json +59 -0
- package/packs/doj-news/policy.json +96 -0
- package/packs/doj-news/source.md +99 -0
- package/packs/dol/endpoints.json +818 -0
- package/packs/dol/policy.json +135 -0
- package/packs/dol/source.md +181 -0
- package/packs/eia/endpoints.json +718 -0
- package/packs/eia/policy.json +112 -0
- package/packs/eia/source.md +112 -0
- package/packs/epa/endpoints.json +292 -0
- package/packs/epa/policy.json +99 -0
- package/packs/epa/source.md +99 -0
- package/packs/epa-aqs/endpoints.json +174 -0
- package/packs/epa-aqs/policy.json +96 -0
- package/packs/epa-aqs/source.md +97 -0
- package/packs/fbi/endpoints.json +1842 -0
- package/packs/fbi/policy.json +118 -0
- package/packs/fbi/source.md +108 -0
- package/packs/fda/endpoints.json +238 -0
- package/packs/fda/policy.json +121 -0
- package/packs/fda/source.md +117 -0
- package/packs/fdic/endpoints.json +417 -0
- package/packs/fdic/policy.json +83 -0
- package/packs/fdic/source.md +92 -0
- package/packs/fec/endpoints.json +708 -0
- package/packs/fec/policy.json +93 -0
- package/packs/fec/source.md +90 -0
- package/packs/fed-board/endpoints.json +89 -0
- package/packs/fed-board/policy.json +136 -0
- package/packs/fed-board/source.md +118 -0
- package/packs/federal-register/endpoints.json +143 -0
- package/packs/federal-register/policy.json +86 -0
- package/packs/federal-register/source.md +98 -0
- package/packs/fema/endpoints.json +646 -0
- package/packs/fema/policy.json +103 -0
- package/packs/fema/source.md +103 -0
- package/packs/fhfa/endpoints.json +105 -0
- package/packs/fhfa/policy.json +109 -0
- package/packs/fhfa/source.md +108 -0
- package/packs/fred/assets/download_fred.ps1 +122 -0
- package/packs/fred/assets/download_fred.sh +123 -0
- package/packs/fred/docs/analysis_patterns.md +124 -0
- package/packs/fred/docs/fred_api.md +94 -0
- package/packs/fred/docs/series.md +188 -0
- package/packs/fred/policy.json +253 -0
- package/packs/fred/source.md +142 -0
- package/packs/fsa/endpoints.json +150 -0
- package/packs/fsa/policy.json +99 -0
- package/packs/fsa/source.md +102 -0
- package/packs/govinfo/endpoints.json +520 -0
- package/packs/govinfo/policy.json +116 -0
- package/packs/govinfo/source.md +241 -0
- package/packs/gsa-calc/endpoints.json +93 -0
- package/packs/gsa-calc/policy.json +97 -0
- package/packs/gsa-calc/source.md +108 -0
- package/packs/hud/endpoints.json +147 -0
- package/packs/hud/policy.json +84 -0
- package/packs/hud/source.md +97 -0
- package/packs/ipums/assets/download_ipums.ps1 +215 -0
- package/packs/ipums/assets/download_ipums.sh +192 -0
- package/packs/ipums/docs/ipums_api.md +67 -0
- package/packs/ipums/docs/report_patterns.md +117 -0
- package/packs/ipums/docs/variables.md +284 -0
- package/packs/ipums/lib/fetch_text.json +112 -0
- package/packs/ipums/policy.json +215 -0
- package/packs/ipums/source.md +169 -0
- package/packs/irs-soi/endpoints.json +114 -0
- package/packs/irs-soi/policy.json +107 -0
- package/packs/irs-soi/source.md +124 -0
- package/packs/medicaid/endpoints.json +412 -0
- package/packs/medicaid/policy.json +108 -0
- package/packs/medicaid/source.md +136 -0
- package/packs/naep/endpoints.json +217 -0
- package/packs/naep/policy.json +100 -0
- package/packs/naep/source.md +120 -0
- package/packs/nhtsa/endpoints.json +132 -0
- package/packs/nhtsa/policy.json +93 -0
- package/packs/nhtsa/source.md +109 -0
- package/packs/nih/endpoints.json +453 -0
- package/packs/nih/policy.json +86 -0
- package/packs/nih/source.md +108 -0
- package/packs/noaa/endpoints.json +432 -0
- package/packs/noaa/policy.json +95 -0
- package/packs/noaa/source.md +88 -0
- package/packs/nrel/endpoints.json +328 -0
- package/packs/nrel/policy.json +96 -0
- package/packs/nrel/source.md +91 -0
- package/packs/nws/endpoints.json +272 -0
- package/packs/nws/policy.json +82 -0
- package/packs/nws/source.md +81 -0
- package/packs/nyfed/endpoints.json +80 -0
- package/packs/nyfed/policy.json +92 -0
- package/packs/nyfed/source.md +89 -0
- package/packs/omb/endpoints.json +460 -0
- package/packs/omb/policy.json +106 -0
- package/packs/omb/source.md +130 -0
- package/packs/open-payments/endpoints.json +298 -0
- package/packs/open-payments/policy.json +101 -0
- package/packs/open-payments/source.md +99 -0
- package/packs/opm/assets/download_opm.ps1 +125 -0
- package/packs/opm/assets/download_opm.sh +85 -0
- package/packs/opm/docs/fields.md +184 -0
- package/packs/opm/docs/opm_api.md +71 -0
- package/packs/opm/docs/report_patterns.md +83 -0
- package/packs/opm/lib/data_dictionary.csv +73 -0
- package/packs/opm/policy.json +142 -0
- package/packs/opm/source.md +137 -0
- package/packs/pbgc/endpoints.json +483 -0
- package/packs/pbgc/policy.json +94 -0
- package/packs/pbgc/source.md +95 -0
- package/packs/philfed/endpoints.json +85 -0
- package/packs/philfed/policy.json +94 -0
- package/packs/philfed/source.md +125 -0
- package/packs/port.json +287 -0
- package/packs/regulations/endpoints.json +288 -0
- package/packs/regulations/policy.json +86 -0
- package/packs/regulations/source.md +84 -0
- package/packs/sec/endpoints.json +237 -0
- package/packs/sec/policy.json +86 -0
- package/packs/sec/source.md +101 -0
- package/packs/senate-lobbying/endpoints.json +554 -0
- package/packs/senate-lobbying/policy.json +99 -0
- package/packs/senate-lobbying/source.md +100 -0
- package/packs/snapqc/endpoints.json +1426 -0
- package/packs/snapqc/policy.json +92 -0
- package/packs/snapqc/source.md +96 -0
- package/packs/treasury/catalog.json +2267 -0
- package/packs/treasury/docs/api_guide.md +245 -0
- package/packs/treasury/docs/datasets.md +56 -0
- package/packs/treasury/docs/report_patterns.md +126 -0
- package/packs/treasury/policy.json +159 -0
- package/packs/treasury/source.md +165 -0
- package/packs/treasury-yields/endpoints.json +226 -0
- package/packs/treasury-yields/policy.json +86 -0
- package/packs/treasury-yields/source.md +80 -0
- package/packs/usaspending/endpoints.json +1316 -0
- package/packs/usaspending/policy.json +109 -0
- package/packs/usaspending/source.md +103 -0
- package/packs/usda-fna/endpoints.json +427 -0
- package/packs/usda-fna/policy.json +133 -0
- package/packs/usda-fna/source.md +217 -0
- package/packs/usda-fooddata/endpoints.json +181 -0
- package/packs/usda-fooddata/policy.json +94 -0
- package/packs/usda-fooddata/source.md +105 -0
- package/packs/usda-nass/endpoints.json +324 -0
- package/packs/usda-nass/policy.json +95 -0
- package/packs/usda-nass/source.md +85 -0
- package/packs/usda-outlook/endpoints.json +86 -0
- package/packs/usda-outlook/policy.json +109 -0
- package/packs/usda-outlook/source.md +144 -0
- package/packs/usgs/endpoints.json +313 -0
- package/packs/usgs/policy.json +95 -0
- package/packs/usgs/source.md +96 -0
- package/packs/usitc/endpoints.json +74 -0
- package/packs/usitc/policy.json +111 -0
- package/packs/usitc/source.md +90 -0
- package/packs/uspto/endpoints.json +141 -0
- package/packs/uspto/policy.json +95 -0
- package/packs/uspto/source.md +101 -0
- package/packs/va/endpoints.json +414 -0
- package/packs/va/policy.json +101 -0
- package/packs/va/source.md +129 -0
- package/packs/world-bank/endpoints.json +122 -0
- package/packs/world-bank/policy.json +101 -0
- package/packs/world-bank/source.md +93 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# CMS Provider Data and Medicare data (data.cms.gov)
|
|
2
|
+
Depth: standard. Key: none. Care Compare provider datasets (hospitals, nursing homes, home health, hospice,
|
|
3
|
+
dialysis) and Medicare statistics from data.cms.gov's data-api (enrollment, geographic variation in
|
|
4
|
+
spending, Part B/D drug spending, inpatient and physician utilization).
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- Quality and characteristics of named providers: hospital star ratings, mortality, readmissions,
|
|
8
|
+
infections, HCAHPS; nursing home ratings, staffing, deficiencies; home health, hospice, dialysis.
|
|
9
|
+
- Medicare totals by place and year: beneficiaries (Original Medicare vs Medicare Advantage), FFS spending
|
|
10
|
+
per capita, drug spending by drug, DRG discharges and payments, opioid prescribing rates.
|
|
11
|
+
- Not here: Medicaid and CHIP enrollment, spending and drug data (medicaid), Medicare Trustees Report
|
|
12
|
+
projections and national health expenditures (actuaries), industry payments to doctors
|
|
13
|
+
(open-payments), drug safety and recalls (fda), health insurance coverage rates (census ACS), deaths and
|
|
14
|
+
disease rates (cdc). Medicare claims microdata (LDS/RIF files) need a CMS data use agreement: not covered.
|
|
15
|
+
|
|
16
|
+
## Endpoints and datasets
|
|
17
|
+
| Endpoint | Returns | Parameters |
|
|
18
|
+
|---|---|---|
|
|
19
|
+
| `provider` | rows of one Provider Data dataset (500 a page) | `dataset` (alias or id like `xubh-q36u`), `where`, `conditions`, `sort`, `columns` |
|
|
20
|
+
| `medicare` | rows of one data-api dataset (5,000 a page) | `dataset` (alias or UUID), `where`, `keyword`, `columns`, `sort` |
|
|
21
|
+
|
|
22
|
+
Provider aliases (`request_schema` with `search: "dialysis"` finds them and also searches the live catalog of 237
|
|
23
|
+
Provider Data datasets, returning their ids): `hospital_info`, `hospital_mortality`,
|
|
24
|
+
`hospital_readmissions`, `hospital_infections`, `hospital_timely_care`, `hospital_spending`,
|
|
25
|
+
`hospital_patient_survey`, `nursing_home_info`, `nursing_home_deficiencies`, `nursing_home_quality`,
|
|
26
|
+
`home_health_info`, `hospice_info`, `dialysis_info`.
|
|
27
|
+
|
|
28
|
+
Medicare aliases: `monthly_enrollment` (2013-present, monthly plus `MONTH = "Year"` rows), `geo_variation`
|
|
29
|
+
(2014-2024, national/state/county), `ma_geo_variation`, `partd_spending_by_drug` and
|
|
30
|
+
`partb_spending_by_drug` (wide: one column set per year, e.g. `Tot_Spndng_2020` ... `Tot_Spndng_2024`),
|
|
31
|
+
`partd_opioid_geo` (2013-), `inpatient_geo_2024`, `inpatient_provider_2024`, `physician_geo_2024`,
|
|
32
|
+
`partd_prescribers_geo_2024`, `market_saturation_county`. The `_2024` datasets hold one data year each;
|
|
33
|
+
other years are separate data.cms.gov datasets with their own UUIDs (find them on the dataset page's
|
|
34
|
+
"API" panel or in https://data.cms.gov/data.json) and work in `dataset` directly.
|
|
35
|
+
|
|
36
|
+
Filters:
|
|
37
|
+
- `where`: `{"column": "value"}` equality; a list value means IN (both endpoints; matching ignores case on the
|
|
38
|
+
data-api). Rows outside the filter values fail the fetch rather than pass silently. Provider column names are snake_case
|
|
39
|
+
(`state`, `citytown`, `facility_id`); data-api names are as published (`BENE_GEO_LVL`, `Brnd_Name`).
|
|
40
|
+
- `conditions` (provider only): `[{"property": "facility_name", "value": "%MAYO%", "operator": "LIKE"}]`;
|
|
41
|
+
operators `= <> < <= > >= LIKE IN "NOT IN" BETWEEN`. LIKE matching is case-insensitive.
|
|
42
|
+
- `sort`: `"facility_id"` or `"-hospital_overall_rating"`; `columns`: a list of column names. Column names
|
|
43
|
+
differ by dataset (the id column is not `facility_id` in every dataset): a name the dataset lacks answers
|
|
44
|
+
HTTP 400 "Column not found", and the pack then names the unknown column(s) and lists the dataset's columns.
|
|
45
|
+
|
|
46
|
+
## Spec examples
|
|
47
|
+
```json
|
|
48
|
+
{"description": "Vermont hospitals: overall star rating",
|
|
49
|
+
"requests": [{"name": "vt_hospitals", "endpoint": "provider",
|
|
50
|
+
"params": {"dataset": "hospital_info", "where": {"state": "VT"},
|
|
51
|
+
"columns": ["facility_id", "facility_name", "citytown", "hospital_type", "hospital_overall_rating"],
|
|
52
|
+
"sort": "facility_id"}}]}
|
|
53
|
+
```
|
|
54
|
+
```json
|
|
55
|
+
{"description": "Medicare FFS standardized spending per capita by state, 2024",
|
|
56
|
+
"requests": [{"name": "ffs_spending_2024", "endpoint": "medicare",
|
|
57
|
+
"params": {"dataset": "geo_variation", "where": {"YEAR": "2024", "BENE_GEO_LVL": "State", "BENE_AGE_LVL": "All"},
|
|
58
|
+
"columns": ["YEAR", "BENE_GEO_DESC", "BENES_OM_CNT", "TOT_MDCR_STDZD_PYMT_PC", "TOT_MDCR_PYMT_PC"]}}]}
|
|
59
|
+
```
|
|
60
|
+
```json
|
|
61
|
+
{"description": "Medicare enrollment, United States, annual",
|
|
62
|
+
"requests": [{"name": "enroll_us", "endpoint": "medicare",
|
|
63
|
+
"params": {"dataset": "monthly_enrollment", "where": {"BENE_GEO_LVL": "National", "MONTH": "Year"},
|
|
64
|
+
"columns": ["YEAR", "TOT_BENES", "ORGNL_MDCR_BENES", "MA_AND_OTH_BENES"]}}]}
|
|
65
|
+
```
|
|
66
|
+
To see a dataset's columns, fetch with `"max_rows": 5` and no `columns`, then read `data_dictionary.csv`.
|
|
67
|
+
|
|
68
|
+
## Data format and traps
|
|
69
|
+
- Every value is text, as published: numbers, `"Not Available"` (provider ratings), footnote codes in
|
|
70
|
+
`*_footnote` columns. Convert with `compute` (`number(x)` in a derive step); treat "Not Available" and
|
|
71
|
+
footnoted cells as missing, never as zero.
|
|
72
|
+
- Provider Data columns are stored as text, so `sort` and `<`/`>`/`BETWEEN` compare characters, not
|
|
73
|
+
numbers or dates (`"-hospital_overall_rating"` puts "Not Available" first; `"91.06" > "900"`). The pack
|
|
74
|
+
refuses comparisons against numbers or MM/DD/YYYY dates (set `"text_compare_ok": true` on a condition to
|
|
75
|
+
override); fetch with equality filters and rank with `compute` (orderby).
|
|
76
|
+
- data-api silently ignores a filter on a column that does not exist and drops unknown `columns` names
|
|
77
|
+
(verified). The pack therefore always returns the filter columns and fails the request if a filter or
|
|
78
|
+
requested column is absent, rather than hand back an unfiltered table. Names are case-sensitive.
|
|
79
|
+
- Provider Data measures cover rolling reporting windows that differ by measure (`start_date`,
|
|
80
|
+
`end_date` columns); the star rating is recalculated periodically. Report the window, not "2026".
|
|
81
|
+
- Geographic Variation, inpatient and physician datasets cover fee-for-service (Original Medicare)
|
|
82
|
+
beneficiaries only; Medicare Advantage enrollees are excluded. Compare places with standardized amounts
|
|
83
|
+
(`*_STDZD_*`), which remove geographic price adjustments; actual amounts include them.
|
|
84
|
+
- Rates in data-api tables are fractions (`MA_PRTCPTN_RATE = 0.3213` is 32.13%).
|
|
85
|
+
- Geography codes differ: `geo_variation` uses postal codes in `BENE_GEO_DESC` for states ("AK");
|
|
86
|
+
`monthly_enrollment` has `BENE_STATE_ABRVTN` and `BENE_STATE_DESC`; provider data use `state` = "VT".
|
|
87
|
+
County FIPS fields may be padded with spaces. Align states with the `compute` step `state_codes`.
|
|
88
|
+
- Small cells are suppressed under CMS's cell-size rule (counts under 11). data-api datasets publish a
|
|
89
|
+
suppressed cell as the text "*" (verified in `monthly_enrollment` and `geo_variation`, 2026-10-22); the pack
|
|
90
|
+
writes an empty cell plus a `<column>_flag` column reading "suppressed (*)". Treat them as missing, never as
|
|
91
|
+
zero. Other datasets leave the value blank and say why in a flag column (`partd_prescribers_geo_2024`:
|
|
92
|
+
`GE65_Sprsn_Flag` "*" or "#"): flag columns keep their text. A descending data-api `sort` on a numeric column
|
|
93
|
+
puts the "*" rows first (numbers themselves sort numerically): take the top N with `compute` (filter,
|
|
94
|
+
orderby, slice) after dropping suppressed rows, not with `sort` plus `max_rows`.
|
|
95
|
+
- Part B/D spending by drug is wide (columns per year) and has `Mftr_Name = "Overall"` summary rows plus
|
|
96
|
+
one row per manufacturer: filter to "Overall" before summing, or totals double.
|
|
97
|
+
- Provider Data API: `limit` is capped at 1,500 by the API; the pack pages 500 rows at a time. The service
|
|
98
|
+
is slow (15-50 s a page observed) and answers intermittent HTTP 503; the client retries.
|
|
99
|
+
- `/datastore/query/{distribution_id}/0` returns 404; the pack uses `/datastore/query/{dataset_id}/0` (index 0 = the dataset's only CSV distribution).
|
|
100
|
+
|
|
101
|
+
## Access
|
|
102
|
+
No key. `fetch` downloads from data.cms.gov when it answers. Manual route (`manual_bundle`): INSTRUCTIONS.md
|
|
103
|
+
lists one JSON link per page with the filters already applied (open in a browser, save under the shown name,
|
|
104
|
+
upload, then `ingest`). Alternatively, open the dataset page (`https://data.cms.gov/provider-data/dataset/<id>`,
|
|
105
|
+
or the Medicare dataset's `page` from a `request_schema` search), click Download for the full CSV and upload
|
|
106
|
+
it; the CSV uses display-style column
|
|
107
|
+
names ("Facility ID"), so say which columns to use.
|
|
108
|
+
|
|
109
|
+
## Citation and terms
|
|
110
|
+
"Centers for Medicare & Medicaid Services, <dataset name>, data.cms.gov, retrieved <date>." U.S.
|
|
111
|
+
government work in the public domain (data.cms.gov terms of use); redistribution allowed. Cite CMS, the
|
|
112
|
+
dataset, and the reporting period.
|
|
@@ -0,0 +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
|
+
}
|
|
253
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "college-scorecard",
|
|
3
|
+
"title": "College Scorecard (U.S. Department of Education)",
|
|
4
|
+
"agency": "U.S. Department of Education",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"education",
|
|
8
|
+
"higher education",
|
|
9
|
+
"student debt"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"college",
|
|
13
|
+
"colleges",
|
|
14
|
+
"university",
|
|
15
|
+
"universities",
|
|
16
|
+
"tuition",
|
|
17
|
+
"net price",
|
|
18
|
+
"cost of college",
|
|
19
|
+
"graduation rate",
|
|
20
|
+
"completion rate",
|
|
21
|
+
"earnings after college",
|
|
22
|
+
"student debt",
|
|
23
|
+
"student loans",
|
|
24
|
+
"admission rate",
|
|
25
|
+
"pell",
|
|
26
|
+
"scorecard",
|
|
27
|
+
"ipeds",
|
|
28
|
+
"unitid",
|
|
29
|
+
"hbcu",
|
|
30
|
+
"community college",
|
|
31
|
+
"for-profit college"
|
|
32
|
+
],
|
|
33
|
+
"questions": [
|
|
34
|
+
"median earnings ten years after entry by college",
|
|
35
|
+
"net price of public universities in a state",
|
|
36
|
+
"graduation rates of colleges in a state",
|
|
37
|
+
"student debt of graduates by school",
|
|
38
|
+
"most selective colleges by admission rate"
|
|
39
|
+
],
|
|
40
|
+
"homepage": "https://collegescorecard.ed.gov/data/",
|
|
41
|
+
"terms_url": "https://collegescorecard.ed.gov/data/documentation/",
|
|
42
|
+
"auth": {
|
|
43
|
+
"env": "DATA_GOV_API_KEY",
|
|
44
|
+
"required": "optional",
|
|
45
|
+
"placement": "query",
|
|
46
|
+
"param": "api_key",
|
|
47
|
+
"home": "data-gov",
|
|
48
|
+
"signup_url": "https://api.data.gov/signup/",
|
|
49
|
+
"echoes_key": false,
|
|
50
|
+
"key_only": [
|
|
51
|
+
"more than a few requests an hour (DEMO_KEY is limited per IP address)"
|
|
52
|
+
],
|
|
53
|
+
"demo_key": "DEMO_KEY"
|
|
54
|
+
},
|
|
55
|
+
"limits": {
|
|
56
|
+
"rps": 2,
|
|
57
|
+
"burst": 5,
|
|
58
|
+
"daily_quota": null,
|
|
59
|
+
"max_rows": 10000
|
|
60
|
+
},
|
|
61
|
+
"routes": {
|
|
62
|
+
"api": {
|
|
63
|
+
"base": "https://api.data.gov/ed/collegescorecard/v1",
|
|
64
|
+
"probe": "https://api.data.gov/ed/collegescorecard/v1/schools.json?id=130943&fields=id",
|
|
65
|
+
"hosts": [
|
|
66
|
+
"api.data.gov"
|
|
67
|
+
]
|
|
68
|
+
},
|
|
69
|
+
"manual": {
|
|
70
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md (they carry api.data.gov's public DEMO_KEY; replace it with your own free key if it answers OVER_RATE_LIMIT), save the JSON pages under the names shown, and upload them. Without the links: download the full data files from https://collegescorecard.ed.gov/data/ (Most Recent Institution-Level Data, CSV inside a zip) and upload the CSV; the CSV uses upper-case variable names (UNITID, INSTNM, MD_EARN_WNE_P10) listed in the data dictionary."
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
"cache": {
|
|
74
|
+
"mode": "run_only",
|
|
75
|
+
"ttl_hours": null,
|
|
76
|
+
"why": "Queries are small and the data are refreshed a few times a year; data/ is reused within a run."
|
|
77
|
+
},
|
|
78
|
+
"redistribution": {
|
|
79
|
+
"mode": "allowed",
|
|
80
|
+
"why": "College Scorecard data are U.S. government works (Department of Education) in the public domain (17 U.S.C. 105); the earnings and debt measures derive from federal administrative records and are published for public use."
|
|
81
|
+
},
|
|
82
|
+
"notices": [],
|
|
83
|
+
"retention": null,
|
|
84
|
+
"citation": "U.S. Department of Education, College Scorecard, {dataset}, api.data.gov/ed/collegescorecard, retrieved {retrieved_long}.",
|
|
85
|
+
"audit_hooks": [
|
|
86
|
+
{
|
|
87
|
+
"id": "scorecard_title_iv",
|
|
88
|
+
"kind": "require_text",
|
|
89
|
+
"any": [
|
|
90
|
+
"federal aid",
|
|
91
|
+
"title iv",
|
|
92
|
+
"federally aided",
|
|
93
|
+
"federal student aid"
|
|
94
|
+
],
|
|
95
|
+
"why": "Earnings, debt and net price cover only students who received federal aid (Title IV); a report must say so."
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"clarify": [
|
|
99
|
+
"Which schools? All institutions, or only bachelor's-predominant (predominant_degree 3), and which ownership (public, private nonprofit, for-profit)?",
|
|
100
|
+
"Which cost measure: published tuition (in-state or out-of-state) or average net price after grants?",
|
|
101
|
+
"Earnings 6 or 10 years after entry? Both cover only federally aided students who are working."
|
|
102
|
+
],
|
|
103
|
+
"formats": [
|
|
104
|
+
"json"
|
|
105
|
+
]
|
|
106
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# College Scorecard (U.S. Department of Education)
|
|
2
|
+
Depth: standard. Key: optional (DATA_GOV_API_KEY; DEMO_KEY works for a few requests). Institution-level
|
|
3
|
+
cost, aid, debt, completion, earnings and admissions data for every U.S. college that takes federal aid.
|
|
4
|
+
|
|
5
|
+
## When to use
|
|
6
|
+
- Compare colleges on tuition, net price, admission rate, completion rate, median debt, Pell share and
|
|
7
|
+
median earnings 6, 7 or 10 years after entry; list schools in a state, by ownership or by degree type.
|
|
8
|
+
- Not here: K-12 achievement (naep), enrollment and finance surveys beyond what Scorecard carries (IPEDS
|
|
9
|
+
itself, not covered), student loan portfolio totals (fred, treasury), earnings by occupation (bls).
|
|
10
|
+
- One row per institution (UNITID). Field-of-study (program) data exist but are very large per school.
|
|
11
|
+
|
|
12
|
+
## Endpoints and datasets
|
|
13
|
+
| Endpoint | Returns | Key parameters |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| `schools` | institutions, one row each, the chosen `fields` as dotted columns | filters on any field, `fields`, `sort` |
|
|
16
|
+
|
|
17
|
+
Filters: `school.state` (DE or DE,MD), `school.ownership` (1 public, 2 private nonprofit, 3 for-profit),
|
|
18
|
+
`school.degrees_awarded.predominant` (0-4: not classified, certificate, associate, bachelor's, graduate),
|
|
19
|
+
`school.name` (word search), `id` (UNITID, comma list), any field with `__range=lo..hi` (e.g.
|
|
20
|
+
`latest.admissions.admission_rate.overall__range=0..0.2`). Short aliases: `name`, `state`, `ownership`,
|
|
21
|
+
`predominant_degree` (also inside `sort`, with the catalog aliases: `name:asc`). `fields` takes a list or comma string of field names or catalog aliases:
|
|
22
|
+
`admission_rate`, `size`, `tuition_in_state`, `tuition_out_of_state`, `net_price`, `attendance_cost`,
|
|
23
|
+
`median_debt`, `pell_rate`, `loan_rate`, `completion_rate`, `retention_rate`, `earnings_6yr`,
|
|
24
|
+
`earnings_7yr` (live from October 2026), `earnings_10yr`, `default_rate_3yr`, `share_first_generation`,
|
|
25
|
+
demographics, `locale`, `hbcu`, `operating` (`request_schema` with `search: "earnings"` lists them with the dotted names). Without `fields` the pack sends a
|
|
26
|
+
popular set of 16 fields. Year-specific values: replace `latest.` with a year (`2019.student.size`).
|
|
27
|
+
|
|
28
|
+
## Spec examples
|
|
29
|
+
```json
|
|
30
|
+
{"description": "Public bachelor's colleges in Delaware and Maryland, by 10-year earnings",
|
|
31
|
+
"requests": [{"name": "de_md_public", "endpoint": "schools",
|
|
32
|
+
"params": {"state": "DE,MD", "ownership": 1, "predominant_degree": 3,
|
|
33
|
+
"sort": "latest.earnings.10_yrs_after_entry.median:desc"}}]}
|
|
34
|
+
```
|
|
35
|
+
```json
|
|
36
|
+
{"description": "Most selective colleges: admission rate under 10%",
|
|
37
|
+
"requests": [{"name": "selective", "endpoint": "schools",
|
|
38
|
+
"params": {"latest.admissions.admission_rate.overall__range": "0.001..0.1",
|
|
39
|
+
"fields": ["name", "state", "admission_rate", "net_price", "earnings_10yr", "completion_rate"],
|
|
40
|
+
"sort": "latest.admissions.admission_rate.overall:asc"}}]}
|
|
41
|
+
```
|
|
42
|
+
```json
|
|
43
|
+
{"description": "One school by UNITID",
|
|
44
|
+
"requests": [{"name": "mit", "endpoint": "schools",
|
|
45
|
+
"params": {"id": 166683, "fields": ["name", "admission_rate", "net_price", "earnings_10yr", "completion_rate"]}}]}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Data format and traps
|
|
49
|
+
- Rates are shares 0-1 (admission rate 0.0455 = 4.55%); dollars are nominal per year. `latest.` means the
|
|
50
|
+
most recent value the Department publishes for each measure; measures come from different years (cost
|
|
51
|
+
and admissions are recent, earnings follow cohorts that entered about a decade earlier). Name the
|
|
52
|
+
data year from the documentation when a year matters.
|
|
53
|
+
- Earnings, debt and net price cover only students who received federal (Title IV) aid; earnings are
|
|
54
|
+
medians of those working and not enrolled. Schools with few aided students are suppressed: the API
|
|
55
|
+
returns empty cells (the CSV files write `PrivacySuppressed`). Empty does not mean zero.
|
|
56
|
+
- An unknown field name is silently dropped (no error): check the CSV columns. Without `fields` the API
|
|
57
|
+
returns about 3,000 fields per school, so the pack always sends a field list.
|
|
58
|
+
- `per_page` above 100 is silently cut to 100; the pack pages (100 a page, pages start at 0) up to
|
|
59
|
+
`max_rows` (default 10,000; 6,278 institutions in October 2026). Do not set `page`/`per_page` yourself.
|
|
60
|
+
- The 6-, 7- and 10-year earnings measure different entry cohorts: the 7-year median is often below the
|
|
61
|
+
6-year one for the same school (three large universities checked, 2026-10). Do not read the three as one
|
|
62
|
+
cohort's earnings growth; compare schools on the same measure.
|
|
63
|
+
- Sorting puts schools with no value last (verified for a descending earnings sort).
|
|
64
|
+
- `admission_rate` is exactly 0 for a few schools (3 of the 40 under 0.1 in October 2026, small or
|
|
65
|
+
specialized schools that enroll students): a reporting artifact, not the most selective, yet an ascending
|
|
66
|
+
sort puts them first. Start selectivity ranges above zero (`__range=0.001..0.1`) and say zeros were left out.
|
|
67
|
+
- `__range` works only on the API's indexed columns; others answer HTTP 400 `unknown_column` (verified
|
|
68
|
+
for 7-year earnings, 2026-10). Filter such fields in the analysis instead.
|
|
69
|
+
- Coded columns stay numeric; the pack adds `<column>_label` for ownership and degree codes.
|
|
70
|
+
- Name search matches words, so "Delaware" also finds "Delaware State" and "Delaware Technical"; use `id`
|
|
71
|
+
once you know the school. Branch campuses have their own UNITIDs; some outcomes are reported only at the
|
|
72
|
+
parent (OPEID) level.
|
|
73
|
+
- `latest.repayment.3_yr_repayment.overall` returns a count (5,295 for one university), not a rate: read
|
|
74
|
+
the data dictionary before using repayment fields. Three-year default rates are near zero for recent
|
|
75
|
+
cohorts because federal loan repayment was paused from 2020 to 2023.
|
|
76
|
+
- Field-of-study fields (`latest.programs.cip_4_digit`) return hundreds of nested records per school (1.8 to
|
|
77
|
+
2.4 MB for one large university, 2026-10); request them for one `id` at a time. They arrive as JSON text
|
|
78
|
+
in one cell.
|
|
79
|
+
|
|
80
|
+
## Access
|
|
81
|
+
Key optional: DATA_GOV_API_KEY (free at https://api.data.gov/signup/), sent as `api_key`; without one the
|
|
82
|
+
pack sends DEMO_KEY (api.data.gov: 30 requests an hour and 50 a day per IP address). A personal key allows 1,000
|
|
83
|
+
requests an hour. `fetch` downloads when api.data.gov answers. Manual route (`manual_bundle`):
|
|
84
|
+
`manual_download/INSTRUCTIONS.md` lists JSON page links with `api_key=DEMO_KEY` (one per 100 schools); open
|
|
85
|
+
each, save under the name shown, upload, then `ingest`. Without the links: https://collegescorecard.ed.gov/data/ has the full
|
|
86
|
+
institution-level CSV (zip) and the data dictionary (xlsx); its variable names differ (UNITID, INSTNM,
|
|
87
|
+
MD_EARN_WNE_P10), so map them with the dictionary.
|
|
88
|
+
|
|
89
|
+
## Citation and terms
|
|
90
|
+
"U.S. Department of Education, College Scorecard, <data year / file>, api.data.gov/ed/collegescorecard,
|
|
91
|
+
retrieved <date>." Public domain (U.S. government work). Redistribution allowed. Say in the report that
|
|
92
|
+
earnings and debt cover federally aided students only (audit hook).
|