data-analyst-mcp 0.0.0-stage → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +261 -2
- 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 +716 -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 +24 -0
- package/dist/report/scan_secrets.js +265 -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 +247 -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 +54 -4
- 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 +170 -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,188 @@
|
|
|
1
|
+
# FRED series for budget and economic analysis
|
|
2
|
+
|
|
3
|
+
Every ID below was checked to exist on 2026-10-20 (titles, units, frequency and adjustment as FRED shows
|
|
4
|
+
them). FRED edits titles and adds series; confirm with the `request_schema` search `describe <IDs>` before downloading, and
|
|
5
|
+
read the title back against the concept. Copyright tags were read on the series page only where marked ✔;
|
|
6
|
+
read the page for the others before sharing data.
|
|
7
|
+
|
|
8
|
+
Contents: 1. Output and potential · 2. Prices · 3. Labor · 4. Interest rates · 5. The federal budget ·
|
|
9
|
+
6. Income and other · 7. Recessions · 8. States and areas · 9. Finding a series you do not know
|
|
10
|
+
|
|
11
|
+
## 1. Output and potential output
|
|
12
|
+
| ID | What | Units, frequency | Notes |
|
|
13
|
+
|---|---|---|---|
|
|
14
|
+
| `GDP` | Gross domestic product | Billions of dollars, quarterly, SAAR | Nominal; the denominator for shares of GDP (average the 4 quarters of a fiscal year) |
|
|
15
|
+
| `GDPA` | GDP, annual | Billions of dollars, annual | Calendar year; the denominator of FRED's FY*GDA188S ratios |
|
|
16
|
+
| `FYGDP` | GDP, fiscal year (OMB) | Billions of dollars, annual, fiscal year (dated Sep 30) | OMB's figure from its latest budget; lags BEA revisions. The mean of the four quarters of `GDP` is the current-vintage alternative |
|
|
17
|
+
| `GDPC1` | Real GDP | Billions of chained 2017 dollars, quarterly, SAAR | BEA; Public Domain ✔ |
|
|
18
|
+
| `A191RL1Q225SBEA` | Real GDP, percent change from preceding period | Percent, quarterly, SAAR | BEA's published growth rate: the benchmark for an annualized growth rate computed from `GDPC1` |
|
|
19
|
+
| `A939RX0Q048SBEA` | Real GDP per capita | Chained 2017 dollars, quarterly, SAAR | |
|
|
20
|
+
| `GDPPOT` | Real potential GDP (CBO) | Billions of chained 2017 dollars, quarterly, NSA | CBO; Public Domain ✔; **projected ~10 years ahead**; last updated with CBO's latest outlook, so it may rest on an older GDP vintage than GDPC1 |
|
|
21
|
+
| `NGDPPOT` | Nominal potential GDP (CBO) | Billions of dollars, quarterly | Projections as above |
|
|
22
|
+
| `NROU` | Noncyclical rate of unemployment (CBO) | Percent, quarterly | Projections as above |
|
|
23
|
+
| `GDPDEF` | GDP implicit price deflator | Index 2017=100, quarterly, SA | |
|
|
24
|
+
|
|
25
|
+
Output gap = `GDPC1 / GDPPOT - 1` (both chained 2017 dollars), on dates both have (join on date; stop at the last date both series hold).
|
|
26
|
+
|
|
27
|
+
## 2. Prices
|
|
28
|
+
| ID | What | Units, frequency | Notes |
|
|
29
|
+
|---|---|---|---|
|
|
30
|
+
| `PCEPI` | PCE price index | Index 2017=100, monthly, SA | The measure in the Federal Reserve's 2 percent objective; CBO projects it alongside the CPI-U |
|
|
31
|
+
| `PCEPILFE` | Core PCE price index | Index 2017=100, monthly, SA | |
|
|
32
|
+
| `CPIAUCSL` | CPI-U, all items | Index 1982-84=100, monthly, SA | Monthly changes |
|
|
33
|
+
| `CPIAUCNS` | CPI-U, all items | Index 1982-84=100, monthly, NSA | 12-month changes as BLS reports them; annual averages |
|
|
34
|
+
| `CPILFENS` | Core CPI-U, not seasonally adjusted (12-month changes) | Index 1982-84=100, monthly, NSA | |
|
|
35
|
+
| `CPILFESL` | Core CPI-U | Index 1982-84=100, monthly, SA | |
|
|
36
|
+
| `CWUR0000SA0` | CPI-W, all items | Index 1982-84=100, monthly, NSA | Social Security COLA: average of July-September over the same quarter a year earlier |
|
|
37
|
+
| `SUUR0000SA0` | Chained CPI-U (C-CPI-U) | Index Dec 1999=100, monthly, NSA | Tax-bracket indexing; preliminary for 10-12 months |
|
|
38
|
+
| `T10YIE` | 10-year breakeven inflation | Percent, daily | Market-based expectation (10-year nominal minus 10-year TIPS yield) |
|
|
39
|
+
| `T5YIE` | 5-year breakeven inflation | Percent, daily | 5-year nominal minus 5-year TIPS yield; monthly averages `T5YIEM` |
|
|
40
|
+
| `T5YIFR` | 5-year, 5-year forward inflation expectation | Percent, daily | (((1+b10/100)^10/(1+b5/100)^5)^(1/5)-1)*100 from the 10- and 5-year breakevens; monthly `T5YIFRM` |
|
|
41
|
+
| `UMCSENT` | University of Michigan consumer sentiment | Index 1966:Q1=100, monthly, NSA | **Posted on FRED one month late** at UMich's request: the latest final and preliminary months are on sca.isr.umich.edu (save them in published/). UMich moved from phone to web interviews in 2024, which shifts levels |
|
|
42
|
+
|
|
43
|
+
## 3. Labor
|
|
44
|
+
| ID | What | Units, frequency |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| `UNRATE` | Unemployment rate | Percent, monthly, SA |
|
|
47
|
+
| `PAYEMS` | All employees, total nonfarm | Thousands, monthly, SA |
|
|
48
|
+
| `CIVPART` | Labor force participation rate | Percent, monthly, SA |
|
|
49
|
+
| `CNP16OV` | Civilian noninstitutional population 16+ | Thousands, monthly, NSA |
|
|
50
|
+
| `CES0500000003` | Average hourly earnings, total private | Dollars per hour, monthly, SA |
|
|
51
|
+
| `ECIWAG` | ECI, wages and salaries, private industry | Index Dec 2005=100, quarterly, SA |
|
|
52
|
+
|
|
53
|
+
For more detail on BLS series (demographic groups, industries, significance), the bls pack is the
|
|
54
|
+
better tool; FRED mirrors the same data.
|
|
55
|
+
|
|
56
|
+
## 4. Interest rates
|
|
57
|
+
| ID | What | Units, frequency |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| `DFEDTARU` / `DFEDTARL` | Federal funds target range, upper / lower limit (FOMC) | Percent, daily (steps on decision dates). "Cut since the peak": when the path reverses, report the net change and the gross cuts separately (2024-2026: 1.75 points of cuts, 1.50 net after a 2026 raise); the Board's Open Market Operations table is the benchmark |
|
|
60
|
+
| `FEDFUNDS` | Effective federal funds rate | Percent, monthly average |
|
|
61
|
+
| `DFF` | Effective federal funds rate | Percent, daily (7-day) |
|
|
62
|
+
| `DGS10` | 10-year Treasury constant-maturity yield | Percent, daily (business days; gaps on holidays) |
|
|
63
|
+
| `GS10` | 10-year Treasury yield | Percent, monthly average |
|
|
64
|
+
| `TB3MS` | 3-month Treasury bill, secondary market | Percent, monthly (discount basis) |
|
|
65
|
+
| `MORTGAGE30US` | 30-year fixed mortgage rate (Freddie Mac) | Percent, weekly ending Thursday |
|
|
66
|
+
| `T10Y2Y` / `T10Y2YM` | 10-year minus 2-year Treasury spread (curve inversion when negative) | Percentage points, daily / monthly average |
|
|
67
|
+
| `T10Y3M` | 10-year minus 3-month Treasury spread | Percentage points, daily |
|
|
68
|
+
|
|
69
|
+
Use the monthly averages (GS10, TB3MS) for annual or fiscal-year averages; CBO's interest-rate projections
|
|
70
|
+
are calendar- or fiscal-year averages of these rates.
|
|
71
|
+
|
|
72
|
+
## 5. The federal budget
|
|
73
|
+
| ID | What | Units, frequency | Notes |
|
|
74
|
+
|---|---|---|---|
|
|
75
|
+
| `FYFR` | Federal receipts (revenues) | Millions of dollars, annual, **fiscal year** | OMB/Treasury; dated Sep 30 |
|
|
76
|
+
| `FYONET` | Federal net outlays | Millions of dollars, annual, fiscal year | |
|
|
77
|
+
| `FYFSD` | Federal surplus or deficit (negative = deficit) | Millions of dollars, annual, fiscal year | |
|
|
78
|
+
| `FYOINT` | Federal outlays: interest | Millions of dollars, annual, fiscal year | OMB, Public Domain ✔. OMB's net interest (budget function 900, matches OMB Historical Table 3.1): $970.1 billion in FY2025. CBO's Monthly Budget Review reports "net interest on the public debt" above $1 trillion for FY2025, a different budget category; say which one the text means and benchmark it against its own source |
|
|
79
|
+
| `FYFSGDA188S` | Surplus or deficit as percent of GDP | Percent of GDP, annual (fiscal year, dated Jan 1) | |
|
|
80
|
+
| `FYOIGDA188S` | Interest outlays as percent of GDP | Percent of GDP, annual (fiscal year, dated Jan 1) | Benchmark only: divides by calendar-year GDP (GDPA), not fiscal-year GDP |
|
|
81
|
+
| `FYGFDPUN` | Federal debt held by the public | Millions of dollars, quarterly, end of period | |
|
|
82
|
+
| `FYGFGDQ188S` | Debt held by the public as percent of GDP | Percent of GDP, quarterly, SA | |
|
|
83
|
+
| `GFDEBTN` | Total public debt | Millions of dollars, quarterly, end of period | Includes intragovernmental debt: not "debt held by the public" |
|
|
84
|
+
| `GFDEGDQ188S` | Total public debt as percent of GDP | Percent of GDP, quarterly, SA | |
|
|
85
|
+
| `A091RC1Q027SBEA` | Federal interest payments (NIPA) | Billions of dollars, quarterly, SAAR | National-accounts basis, not budget basis |
|
|
86
|
+
| `W006RC1Q027SBEA` | Federal current tax receipts (NIPA) | Billions of dollars, quarterly, SAAR | NIPA basis |
|
|
87
|
+
| `FGEXPND` | Federal current expenditures (NIPA) | Billions of dollars, quarterly, SAAR | NIPA basis |
|
|
88
|
+
|
|
89
|
+
Budget-basis (OMB/Treasury, fiscal year) and NIPA-basis (BEA, calendar quarters) measures differ in timing and
|
|
90
|
+
coverage; never mix them in one ratio without saying so. For CBO's own baseline projections and historical
|
|
91
|
+
budget data, use CBO's data files (cbo.gov), not FRED.
|
|
92
|
+
|
|
93
|
+
## 6. Income and other
|
|
94
|
+
| ID | What | Units, frequency |
|
|
95
|
+
|---|---|---|
|
|
96
|
+
| `PCE` | Personal consumption expenditures | Billions of dollars, monthly, SAAR |
|
|
97
|
+
| `DSPIC96` | Real disposable personal income | Billions of chained 2017 dollars, monthly, SAAR |
|
|
98
|
+
| `PSAVERT` / `A072RC1Q156SBEA` | Personal saving rate (NIPA Table 2.6 / 2.1 line 35) | Percent of disposable income, monthly / quarterly |
|
|
99
|
+
| `MEHOINUSA672N` | Real median household income (Census) | Dollars of the latest year (C-CPI-U), annual |
|
|
100
|
+
| `SP500` | S&P 500 index | Index, daily; **Copyrighted: Pre-Approval Required** ✔ (only 10 years on FRED) |
|
|
101
|
+
|
|
102
|
+
**International trade** (the Census/BEA monthly release, FT-900, mirrored keyless; BEA's ITA needs a key)
|
|
103
|
+
| ID | What | Units, frequency |
|
|
104
|
+
|---|---|---|
|
|
105
|
+
| `BOPGSTB` / `BOPGTB` / `BOPSTB` | Trade balance: goods and services / goods / services, balance of payments basis | Millions of dollars, monthly, SA |
|
|
106
|
+
| `BOPTEXP` / `BOPTIMP` | Exports / imports of goods and services, BOP basis | Millions of dollars, monthly, SA |
|
|
107
|
+
| `EXPCH` / `IMPCH` | Goods exports to / imports from China, Census basis (other partners: EXP / IMP + country code) | Millions of dollars, monthly, NSA |
|
|
108
|
+
|
|
109
|
+
Annual totals are sums of the months; the June annual revision replaces the first-published year. Partner
|
|
110
|
+
balances are on the Census basis, as the release gives them.
|
|
111
|
+
|
|
112
|
+
## 4b. Money stock (Federal Reserve H.6, monthly)
|
|
113
|
+
`M2SL` M2 (billions of dollars, SA), `M1SL` M1, `M2NS` M2 not adjusted, `WM2NS` weekly M2. The H.6 has not
|
|
114
|
+
published growth rates since February 2021: 12-month growth is computed from levels (`pc1`), and the H.6
|
|
115
|
+
data file is the level benchmark.
|
|
116
|
+
|
|
117
|
+
## 5a. Industrial production and capacity utilization (Federal Reserve G.17, monthly)
|
|
118
|
+
`INDPRO` industrial production, total (index 2017=100), `IPMAN` manufacturing; `TCU` capacity
|
|
119
|
+
utilization, total (percent), `MCUMFN` manufacturing (metadata checked on 2026-10-21). The
|
|
120
|
+
latest months are preliminary and revised for several months. G.17 states the gap to the long-run
|
|
121
|
+
average as the difference of its one-decimal rates (76.9 - 79.4 = 2.5 points below): compute it the
|
|
122
|
+
same way to match, and show the unrounded gap as a sensitivity.
|
|
123
|
+
|
|
124
|
+
## 5c. Housing starts and permits (Census New Residential Construction, monthly)
|
|
125
|
+
`HOUST` total starts, `HOUST1F` single-family, `PERMIT` permits (thousands of units, SAAR; metadata checked
|
|
126
|
+
on 2026-10-21); `HOUSTNSA` not adjusted. The latest month is preliminary and revised twice.
|
|
127
|
+
An annual total from FRED sums rounded months: Census's annual sheet sums unrounded estimates (0.1 apart).
|
|
128
|
+
|
|
129
|
+
## 5b. Unemployment insurance claims (DOL, weekly)
|
|
130
|
+
`ICSA` initial claims (SA), `IC4WSA` 4-week moving average (SA), `ICNSA` (NSA), `CCSA` continued claims.
|
|
131
|
+
Weeks end on Saturday; the latest week is an advance figure (preliminary). The keyless route when the dol
|
|
132
|
+
pack has no key. A calendar-year average needs all the weeks of the year (count them; never average a
|
|
133
|
+
partial year).
|
|
134
|
+
|
|
135
|
+
## 6a. Household debt service (Federal Reserve DSR release)
|
|
136
|
+
Quarterly, percent of disposable personal income: `TDSP` total, `MDSP` mortgage, `CDSP` consumer debt
|
|
137
|
+
service. The Fed rebuilt the series on credit-bureau data in 2024: its levels are about 2.5 points above the
|
|
138
|
+
archived lender-based series (2007 Q4 15.8 against 13.3), so never mix the two; the latest quarter is
|
|
139
|
+
preliminary. Benchmark: federalreserve.gov/releases/dsr.
|
|
140
|
+
|
|
141
|
+
## 6b. Federal Reserve balance sheet (H.4.1)
|
|
142
|
+
Weekly, millions of dollars (metadata checked on 2026-10-21). Wednesday levels: `WALCL` total
|
|
143
|
+
assets, `TREAST` Treasury securities held outright, `WSHOMCB` mortgage-backed securities, `WSHOSHO` all
|
|
144
|
+
securities held outright, `WLRRAL` reverse repurchase agreements (liability). Week averages (not Wednesday
|
|
145
|
+
levels; do not mix with the above): `WRESBAL` reserve balances, `WTREGEN` Treasury General Account.
|
|
146
|
+
`RRPONTSYD` overnight reverse repos is daily and in billions. Changes between two weeks are differences of
|
|
147
|
+
published levels, not published figures: say so in benchmark.csv. Other assets (premiums, loans, the
|
|
148
|
+
rest) are total minus the securities.
|
|
149
|
+
|
|
150
|
+
## 6d. House prices and the international investment position
|
|
151
|
+
| ID | What | Units, frequency | Notes |
|
|
152
|
+
|---|---|---|---|
|
|
153
|
+
| `CSUSHPINSA`, `CSUSHPISA` | S&P CoreLogic Case-Shiller U.S. National home price index, NSA / SA | Index Jan 2000=100, monthly, two months' lag | `copyright` preapproval_required: say the values may not be republished; S&P's release leads with NSA 12-month changes |
|
|
154
|
+
| `USSTHPI` | FHFA all-transactions house price index, U.S. | Index 1980:Q1=100, quarterly | Public domain |
|
|
155
|
+
| `IIPUSNETIQ`, `IIPUSNETIA` | U.S. net international investment position (BEA), quarterly / annual | Millions of dollars | The keyless route to BEA's IIP (the BEA pack needs a key for IIP); preliminary for the latest quarter |
|
|
156
|
+
|
|
157
|
+
## 6c. Exchange rates (Federal Reserve H.10)
|
|
158
|
+
| ID | What | Units, frequency | Notes |
|
|
159
|
+
|---|---|---|---|
|
|
160
|
+
| `DTWEXBGS` | Nominal broad dollar index (trade-weighted, 26 currencies) | Index Jan 2006=100, daily | The Fed's headline dollar index; checked against H.10 [2026-10-22] |
|
|
161
|
+
| `TWEXBGSMTH` | Nominal broad dollar index, monthly average | Index Jan 2006=100, monthly | A year-to-date change can differ in sign between daily end points and monthly averages: say which |
|
|
162
|
+
| `RTWEXBGS` | Real broad dollar index | Index Jan 2006=100, monthly | Adjusted for relative consumer prices |
|
|
163
|
+
| `DEXUSEU`, `DEXJPUS`, `DEXCHUS`, `DEXCAUS`, `DEXMXUS` | Bilateral rates: dollars per euro; yen, yuan, Canadian dollars, pesos per dollar | daily | Mind the quote direction (US per foreign for the euro) |
|
|
164
|
+
|
|
165
|
+
## 7. Recessions
|
|
166
|
+
`USREC` (monthly; FRBSL from NBER dates; **Copyrighted: Citation Required** ✔), `USRECQ` (quarterly), `USRECD`
|
|
167
|
+
(daily). 1 from the month after the NBER peak through the trough. `"recessions": true` in the spec adds USREC;
|
|
168
|
+
for chart shading, turn its runs of 1 into start and end dates.
|
|
169
|
+
Sahm rule: `SAHMREALTIME` (real-time, as first published; empty where a month's unemployment rate was not
|
|
170
|
+
collected, Oct 2025) and `SAHMCURRENT` (from current UNRATE vintages): the 3-month average of the unemployment
|
|
171
|
+
rate minus its low of the prior 12 months; 0.50 or more signals a recession start.
|
|
172
|
+
|
|
173
|
+
## 8. States and areas
|
|
174
|
+
- Unemployment rate: `<ST>UR` (CAUR, TXUR ...), monthly, SA (BLS LAUS).
|
|
175
|
+
- Per capita personal income: `<ST>PCPI` (CAPCPI ...), annual (BEA).
|
|
176
|
+
- A full cross-section in one call needs a key: spec `"regional": [{"series_id": "CAUR", "region_type": "state",
|
|
177
|
+
"date": "2026-08-01"}]` (GeoFRED finds the group from any member series). Without a key, list the 50 state IDs
|
|
178
|
+
plus DC explicitly; check each with the `request_schema` search `describe <IDs>` (a 404 means the pattern does
|
|
179
|
+
not hold for that series).
|
|
180
|
+
|
|
181
|
+
## 9. Finding a series you do not know
|
|
182
|
+
1. With a key: `request_schema` for fred with the search "federal outlays interest" (sorted by
|
|
183
|
+
popularity; prefer the most popular series from the official source).
|
|
184
|
+
2. Without a key: search https://fred.stlouisfed.org/searchresults/?st=<words> in the browser (or WebSearch
|
|
185
|
+
"site:fred.stlouisfed.org <words>").
|
|
186
|
+
3. Confirm with the `request_schema` search `describe <IDs>`: title, units, frequency, seasonal adjustment, last updated. Prefer the series
|
|
187
|
+
published by the original agency (BEA, BLS, OMB, Treasury, CBO, the Board of Governors) over derived copies,
|
|
188
|
+
and an SA series for short-run changes, NSA for 12-month changes and annual averages.
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "fred",
|
|
3
|
+
"title": "FRED, ALFRED and GeoFRED (Federal Reserve Bank of St. Louis)",
|
|
4
|
+
"agency": "Federal Reserve Bank of St. Louis",
|
|
5
|
+
"depth": "deep",
|
|
6
|
+
"domains": [
|
|
7
|
+
"economy",
|
|
8
|
+
"finance",
|
|
9
|
+
"federal budget",
|
|
10
|
+
"prices",
|
|
11
|
+
"interest rates",
|
|
12
|
+
"revisions"
|
|
13
|
+
],
|
|
14
|
+
"keywords": [
|
|
15
|
+
"trade balance",
|
|
16
|
+
"trade deficit",
|
|
17
|
+
"exports",
|
|
18
|
+
"imports",
|
|
19
|
+
"fred",
|
|
20
|
+
"alfred",
|
|
21
|
+
"geofred",
|
|
22
|
+
"gdp",
|
|
23
|
+
"real gdp",
|
|
24
|
+
"potential gdp",
|
|
25
|
+
"output gap",
|
|
26
|
+
"inflation",
|
|
27
|
+
"pce",
|
|
28
|
+
"cpi",
|
|
29
|
+
"cpi-w",
|
|
30
|
+
"chained cpi",
|
|
31
|
+
"interest rates",
|
|
32
|
+
"treasury yield",
|
|
33
|
+
"10-year",
|
|
34
|
+
"federal funds",
|
|
35
|
+
"mortgage rate",
|
|
36
|
+
"deficit",
|
|
37
|
+
"federal debt",
|
|
38
|
+
"net interest",
|
|
39
|
+
"outlays",
|
|
40
|
+
"receipts",
|
|
41
|
+
"unemployment",
|
|
42
|
+
"recession",
|
|
43
|
+
"nber",
|
|
44
|
+
"vintage",
|
|
45
|
+
"first release",
|
|
46
|
+
"revision",
|
|
47
|
+
"real-time",
|
|
48
|
+
"release calendar",
|
|
49
|
+
"state comparison",
|
|
50
|
+
"fiscal year",
|
|
51
|
+
"fed balance sheet",
|
|
52
|
+
"federal reserve balance sheet",
|
|
53
|
+
"h.4.1",
|
|
54
|
+
"quantitative tightening",
|
|
55
|
+
"quantitative easing",
|
|
56
|
+
"reserve balances",
|
|
57
|
+
"breakeven",
|
|
58
|
+
"inflation expectations",
|
|
59
|
+
"5y5y",
|
|
60
|
+
"tips spread",
|
|
61
|
+
"debt service ratio",
|
|
62
|
+
"household debt service",
|
|
63
|
+
"financial obligations ratio",
|
|
64
|
+
"initial claims",
|
|
65
|
+
"jobless claims",
|
|
66
|
+
"unemployment claims",
|
|
67
|
+
"industrial production",
|
|
68
|
+
"capacity utilization",
|
|
69
|
+
"manufacturing output",
|
|
70
|
+
"g.17",
|
|
71
|
+
"housing starts",
|
|
72
|
+
"building permits",
|
|
73
|
+
"new residential construction",
|
|
74
|
+
"money supply",
|
|
75
|
+
"m2",
|
|
76
|
+
"m1",
|
|
77
|
+
"money stock",
|
|
78
|
+
"h.6",
|
|
79
|
+
"consumer sentiment",
|
|
80
|
+
"university of michigan",
|
|
81
|
+
"exchange rate",
|
|
82
|
+
"case-shiller",
|
|
83
|
+
"home prices",
|
|
84
|
+
"house prices",
|
|
85
|
+
"house price index",
|
|
86
|
+
"net international investment position",
|
|
87
|
+
"niip",
|
|
88
|
+
"exchange rates",
|
|
89
|
+
"dollar index",
|
|
90
|
+
"trade-weighted dollar",
|
|
91
|
+
"broad dollar",
|
|
92
|
+
"h.10",
|
|
93
|
+
"value of the dollar"
|
|
94
|
+
],
|
|
95
|
+
"questions": [
|
|
96
|
+
"how big is the output gap",
|
|
97
|
+
"net interest as a share of GDP by fiscal year",
|
|
98
|
+
"how much was 2020 Q2 GDP revised",
|
|
99
|
+
"the 10-year Treasury yield since 2000",
|
|
100
|
+
"when is the next CPI release",
|
|
101
|
+
"real disposable income since 2019"
|
|
102
|
+
],
|
|
103
|
+
"homepage": "https://fred.stlouisfed.org/",
|
|
104
|
+
"terms_url": "https://fred.stlouisfed.org/docs/api/terms_of_use.html",
|
|
105
|
+
"auth": {
|
|
106
|
+
"env": "FRED_API_KEY",
|
|
107
|
+
"required": "optional",
|
|
108
|
+
"placement": "query",
|
|
109
|
+
"param": "api_key",
|
|
110
|
+
"prefix": "",
|
|
111
|
+
"home": "fred",
|
|
112
|
+
"signup_url": "https://fredaccount.stlouisfed.org/apikeys",
|
|
113
|
+
"echoes_key": false,
|
|
114
|
+
"key_only": [
|
|
115
|
+
"series search",
|
|
116
|
+
"first-release vintages",
|
|
117
|
+
"full revision history (ALFRED real-time periods)",
|
|
118
|
+
"GeoFRED regional cross-sections",
|
|
119
|
+
"source agency, notes and copyright status of each series",
|
|
120
|
+
"release calendar and whole-release downloads"
|
|
121
|
+
],
|
|
122
|
+
"extra": {},
|
|
123
|
+
"demo_key": null
|
|
124
|
+
},
|
|
125
|
+
"limits": {
|
|
126
|
+
"rps": 1.8,
|
|
127
|
+
"burst": 4,
|
|
128
|
+
"daily_quota": null,
|
|
129
|
+
"requests_per_minute": 120,
|
|
130
|
+
"graph_max_series": 12,
|
|
131
|
+
"max_rows": 100000,
|
|
132
|
+
"note": "API: 120 requests a minute, 100,000 observations per call (paged). Graph downloads: at most 12 series per graph (more are silently dropped); fetch sends one series per CSV."
|
|
133
|
+
},
|
|
134
|
+
"routes": {
|
|
135
|
+
"api": {
|
|
136
|
+
"base": "https://api.stlouisfed.org/fred/",
|
|
137
|
+
"probe": "https://api.stlouisfed.org/fred/series?series_id=GNPCA&file_type=json",
|
|
138
|
+
"hosts": [
|
|
139
|
+
"api.stlouisfed.org"
|
|
140
|
+
]
|
|
141
|
+
},
|
|
142
|
+
"api_keyless": {
|
|
143
|
+
"base": "https://fred.stlouisfed.org/graph/fredgraph.csv",
|
|
144
|
+
"probe": "https://fred.stlouisfed.org/graph/fredgraph.csv?id=GNPCA&cosd=2020-01-01",
|
|
145
|
+
"hosts": [
|
|
146
|
+
"fred.stlouisfed.org",
|
|
147
|
+
"alfred.stlouisfed.org"
|
|
148
|
+
]
|
|
149
|
+
},
|
|
150
|
+
"manual": {
|
|
151
|
+
"how": "Call manual_bundle: manual_download/INSTRUCTIONS.md lists one browser link per series (fredgraph.csv / alfredgraph.csv, no key; or the series page's Download button, CSV) and download_data.sh / .ps1 with the request built in (one command each, e.g. bash ~/Downloads/download_data.sh), asking for a key with hidden input only for key-only files. Send INSTRUCTIONS.md, both scripts and spec.json; the user uploads the files unchanged, then call ingest."
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"cache": {
|
|
155
|
+
"mode": "none",
|
|
156
|
+
"ttl_hours": null,
|
|
157
|
+
"why": "FRED's terms of use forbid storing or caching FRED content beyond what a use needs and building an archive of it; only the analysis folder's own data/fred/ copy for this request is kept."
|
|
158
|
+
},
|
|
159
|
+
"redistribution": {
|
|
160
|
+
"mode": "allowed",
|
|
161
|
+
"withhold": {
|
|
162
|
+
"meta": "series.csv",
|
|
163
|
+
"key": "series_id",
|
|
164
|
+
"column": "copyright",
|
|
165
|
+
"shareable": [
|
|
166
|
+
"no_copyright_notice",
|
|
167
|
+
"public_domain",
|
|
168
|
+
"citation_required"
|
|
169
|
+
]
|
|
170
|
+
},
|
|
171
|
+
"why": "FRED's terms (https://fred.stlouisfed.org/docs/api/terms_of_use.html, https://fred.stlouisfed.org/legal/) let users share public-domain series with a citation and copyrighted series marked Citation Required with the owner's citation; series marked Copyrighted: Pre-Approval Required (S&P, some Moody's and ICE indexes) may not be republished without the owner's written permission, so their rows are withheld from shared files."
|
|
172
|
+
},
|
|
173
|
+
"notices": [
|
|
174
|
+
"This product uses the FRED® API but is not endorsed or certified by the Federal Reserve Bank of St. Louis."
|
|
175
|
+
],
|
|
176
|
+
"retention": null,
|
|
177
|
+
"citation": "{dataset}, retrieved from FRED, Federal Reserve Bank of St. Louis; https://fred.stlouisfed.org/, {retrieved_long}. Per-series citations are in data/fred/series.csv.",
|
|
178
|
+
"audit_hooks": [
|
|
179
|
+
{
|
|
180
|
+
"id": "fred_request",
|
|
181
|
+
"kind": "require_file",
|
|
182
|
+
"glob": "data/fred/request.json",
|
|
183
|
+
"why": "The retrieval date, route and vintage of each series must be stated; request.json records them."
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"id": "fred_series_citations",
|
|
187
|
+
"kind": "require_file",
|
|
188
|
+
"glob": "data/fred/[sr]e*.csv",
|
|
189
|
+
"why": "FRED's terms ask that each series be cited; series.csv holds the citation and copyright status (regional.csv, for GeoFRED-only specs, the group titles)."
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"id": "fred_api_notice",
|
|
193
|
+
"kind": "require_text",
|
|
194
|
+
"when_route": [
|
|
195
|
+
"api"
|
|
196
|
+
],
|
|
197
|
+
"any": [
|
|
198
|
+
"not endorsed or certified by the Federal Reserve Bank of St. Louis"
|
|
199
|
+
],
|
|
200
|
+
"why": "FRED's API terms of use require this notice in any product that uses the API (route api in data/fred/request.json)."
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"id": "fred_retrieved",
|
|
204
|
+
"kind": "require_text",
|
|
205
|
+
"any": [
|
|
206
|
+
"retrieved from fred"
|
|
207
|
+
],
|
|
208
|
+
"any_pattern": [
|
|
209
|
+
"retrieved[^\\n]{0,80}\\bfred\\b",
|
|
210
|
+
"\\bfred\\b[^\\n]{0,80}retrieved"
|
|
211
|
+
],
|
|
212
|
+
"why": "FRED's suggested citation names FRED and the retrieval date."
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"clarify": [
|
|
216
|
+
"Calendar or fiscal years? Default: fiscal years (October to September) for budget amounts and their shares of GDP (fiscal-year GDP = mean of the four quarters); calendar years otherwise.",
|
|
217
|
+
"Which vintage: latest data, as published on a date, or as first reported? Default: latest, unless the question is about what was known at a time; then the vintage just before it.",
|
|
218
|
+
"Which measure (PCE or CPI; debt held by the public or total public debt; budget-basis or NIPA interest)? Default: the measure the question's institution uses; indexing questions use the index the law names.",
|
|
219
|
+
"Which growth measure (Q4 over Q4, annual average, quarterly annualized)? Default: the publishing agency's own measure: BEA's annual growth is annual average over annual average (Q4 over Q4 only when comparing with Fed or CBO projections, which use it); annual averages for rates; name it every time."
|
|
220
|
+
],
|
|
221
|
+
"formats": [
|
|
222
|
+
"json",
|
|
223
|
+
"csv",
|
|
224
|
+
"xlsx",
|
|
225
|
+
"zip"
|
|
226
|
+
],
|
|
227
|
+
"use_instead": [
|
|
228
|
+
{
|
|
229
|
+
"question": "BLS detail with preliminary flags, footnotes and gaps",
|
|
230
|
+
"source": "bls",
|
|
231
|
+
"terms": [
|
|
232
|
+
"preliminary"
|
|
233
|
+
],
|
|
234
|
+
"why": "The bls pack keeps BLS's own flags."
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"question": "BEA tables with line numbers and vintages",
|
|
238
|
+
"source": "bea",
|
|
239
|
+
"terms": [
|
|
240
|
+
"NIPA"
|
|
241
|
+
],
|
|
242
|
+
"why": "The bea pack reads BEA tables as published."
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"question": "Treasury daily statements and auctions",
|
|
246
|
+
"source": "treasury",
|
|
247
|
+
"terms": [
|
|
248
|
+
"auction"
|
|
249
|
+
],
|
|
250
|
+
"why": "Treasury Fiscal Data."
|
|
251
|
+
}
|
|
252
|
+
]
|
|
253
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# FRED, ALFRED and GeoFRED (Federal Reserve Bank of St. Louis)
|
|
2
|
+
Depth: deep. Key: optional (FRED_API_KEY). Over 800,000 U.S. and international economic series (GDP and
|
|
3
|
+
potential output, prices, rates, budget, labor, states), their past vintages (ALFRED), state and county
|
|
4
|
+
cross-sections (GeoFRED), and FRED's release calendar.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- GDP, potential output and the output gap, PCE and CPI inflation (CPI-W for COLAs, chained CPI), interest
|
|
8
|
+
rates and Treasury yields, the federal deficit, debt and net interest by fiscal year, recessions (USREC),
|
|
9
|
+
state comparisons, and anything about revisions ("as first reported", "as published on a date").
|
|
10
|
+
- When a release comes out (`release_dates`), or every series of one release at once (`release_observations`).
|
|
11
|
+
- Not here: BLS detail with preliminary flags, footnotes and significance thresholds (bls); BEA tables with
|
|
12
|
+
line numbers and vintages (bea); Treasury daily statements and auctions (treasury); budget projections
|
|
13
|
+
(use the agency's own files). FRED mirrors BLS and BEA series: prefer the original pack when its flags matter.
|
|
14
|
+
|
|
15
|
+
## Endpoints and datasets
|
|
16
|
+
| What | How | Key |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| Series data, latest | spec `series` → API `series/observations`, or keyless `fredgraph.csv` | optional |
|
|
19
|
+
| As-of vintages | `"vintage": {"as_of": [dates]}` → API `vintage_dates`, or keyless `alfredgraph.csv` | optional |
|
|
20
|
+
| First release / full revision history | `"vintage": "first_release"` / `"all"` (real-time window 1776-07-04..9999-12-31) | required |
|
|
21
|
+
| FRED-side transforms / frequency conversion | `units` (pc1, pca ...), `frequency` + `aggregation_method` (prefer your own computation from native data) | optional |
|
|
22
|
+
| Series metadata | `request_schema` search `describe IDs` (API: title, units, frequency, SA, source, release, notes; keyless: XLSX README sheet) | optional |
|
|
23
|
+
| Search | `request_schema` search `"words" [limit N]` (`series/search`, by popularity) | required |
|
|
24
|
+
| Vintage dates | `request_schema` search `vintagedates ID` | required |
|
|
25
|
+
| GeoFRED cross-section | spec `regional`: `[{"series_id": "CAUR", "region_type": "state", "date": "2025-01-01"}]` (group found from any member) | required |
|
|
26
|
+
| Release calendar | `request_schema` search `release_dates [ID] [START] [END]` (20 rows shown) or spec `release_dates` → `release_dates.csv` | required |
|
|
27
|
+
| Whole release | spec `release_observations`: `[{"release_id": 53, "limit": 10000, "max_pages": 5, "series": [IDs]}]` (FRED API v2, cursor-paged) | required |
|
|
28
|
+
Common releases: 10 CPI, 50 Employment Situation, 53 GDP, 18 H.15 interest rates. Verified IDs by topic
|
|
29
|
+
(output, prices, labor, rates, budget, income, recessions, states): docs/series.md.
|
|
30
|
+
|
|
31
|
+
## Spec examples
|
|
32
|
+
```json
|
|
33
|
+
{"description": "Output gap since 2007",
|
|
34
|
+
"series": [{"id": "GDPC1", "label": "Real GDP"}, {"id": "GDPPOT", "label": "Real potential GDP"}],
|
|
35
|
+
"start": "2007-01-01", "recessions": true}
|
|
36
|
+
```
|
|
37
|
+
```json
|
|
38
|
+
{"description": "Real GDP 2020 Q2: first release vs. two later vintages",
|
|
39
|
+
"series": [{"id": "GDPC1", "start": "2020-04-01", "end": "2020-04-01", "vintage": "first_release"},
|
|
40
|
+
{"id": "GDPC1", "start": "2020-04-01", "end": "2020-07-01", "vintage": {"as_of": ["2020-08-27", "2021-07-29"]}}]}
|
|
41
|
+
```
|
|
42
|
+
```json
|
|
43
|
+
{"description": "Net interest as a share of GDP, fiscal years",
|
|
44
|
+
"series": [{"id": "FYOINT"}, {"id": "GDP"}, {"id": "FYOIGDA188S", "label": "benchmark"}], "start": "1999-01-01",
|
|
45
|
+
"release_dates": {"release_id": 53, "start": "2026-10-01", "end": "2026-12-31"}}
|
|
46
|
+
```
|
|
47
|
+
Per series (or globally): `start`, `end`, `vintage`, `units`, `frequency`, `aggregation_method`; packaging
|
|
48
|
+
only: `label`, `source`, `copyright` (`public_domain` / `citation_required` / `preapproval_required`) with
|
|
49
|
+
`copyright_basis`. Request only what the question needs (FRED's terms forbid wholesale downloading).
|
|
50
|
+
Tools: `request_schema` (the spec format; a search finds series, with a key), `fetch` with the spec (without a key
|
|
51
|
+
it takes the keyless route when the request needs no key-only feature), and `manual_bundle` then `ingest` for files
|
|
52
|
+
the user downloads.
|
|
53
|
+
|
|
54
|
+
## Data format and traps
|
|
55
|
+
Output in `data/fred/`: `fred_observations.csv` (series_id, label, variant, vintage, date, value,
|
|
56
|
+
realtime_start, realtime_end), `series.csv` (title, units, frequency, seasonal_adjustment, last_updated,
|
|
57
|
+
fiscal_year, first/last date, n_obs, n_missing, n_future, source, release, copyright, citation, notes),
|
|
58
|
+
`regional.csv`, `release_dates.csv`, `release_series.csv` + `release_observations.csv`, `raw/`,
|
|
59
|
+
`request.json`, `README.md`. Build tables with `compute` (filter by variant, `pivot_wider` on date for one column
|
|
60
|
+
per series) and register cited numbers with `facts`. Read `series.csv` and the README's "Read this before
|
|
61
|
+
analyzing" first.
|
|
62
|
+
- **Keys of a row**: `variant` = ID plus a suffix per option that changes the data (`GDPC1_asof`,
|
|
63
|
+
`CPIAUCSL_pc1`, `GDP_aavg`, `GDPC1_first_release`); `vintage` = `latest`, the as-of date, `first_release`,
|
|
64
|
+
or (full history) the publication date. Filter one variant and `pivot_wider` on `vintage` to put each vintage
|
|
65
|
+
in a column.
|
|
66
|
+
- **Units**: millions vs billions (FYOINT millions, GDP billions: divide FYOINT by 1,000 before the share); SAAR
|
|
67
|
+
levels are already annual rates (average quarters, never sum); index levels are not prices.
|
|
68
|
+
- **Missing values** are empty (`.` in the API). October 2025 was not collected for CPI, CPS, LAUS. FRED's own
|
|
69
|
+
frequency conversion averages whatever exists (a quarter with a missing month still gets a value): prefer
|
|
70
|
+
native data and convert only complete periods (count the months in each; `compute`'s `to_fiscal` flags
|
|
71
|
+
incomplete fiscal years).
|
|
72
|
+
- **Projections are not data**: GDPPOT, NGDPPOT and NROU run about ten years ahead (`n_future` > 0);
|
|
73
|
+
drop periods that have not ended (2026 Q4 on 2026-10-20) before computing anything from them.
|
|
74
|
+
- **Fiscal years** (October to September): dollar series are dated at the fiscal year's end (2025-09-30 =
|
|
75
|
+
FY2025), ratio series at January 1 of the fiscal year's number; `compute`'s `fiscal_year` maps both. FRED's
|
|
76
|
+
FY*GDA188S ratios divide by calendar-year GDP, and are updated about once a year (OMB data), so their GDP
|
|
77
|
+
can predate BEA's latest annual update (FYOIGDA188S FY2025, updated April 2026: 3.15 against 3.18 on
|
|
78
|
+
fiscal-year GDP of the September 2026 vintage): a fiscal-year-GDP ratio differs by a few hundredths;
|
|
79
|
+
name both causes, with the series' `last_updated`, when the benchmark misses.
|
|
80
|
+
- **Vintages**: compare growth rates and ratios across vintages, not levels (real GDP was in 2012 dollars
|
|
81
|
+
before September 2023, 2017 dollars since); `units` in series.csv is FRED's label today. First release
|
|
82
|
+
needs the whole real-time window (else HTTP 400 "No vintage dates exist"); an as-of vintage ends where that
|
|
83
|
+
vintage's data ended (later dates are absent, not missing). In as-of rows `realtime_start` is FRED's window
|
|
84
|
+
clipped to the as-of date, not the date the value was first published: for publication dates ask
|
|
85
|
+
`"vintage": "all"`. Not every vintage is a revision: some only
|
|
86
|
+
change the number of decimals or leave periods empty, and a comprehensive update can arrive in several
|
|
87
|
+
vintages. Find updates by changes larger than rounding over the periods both vintages hold.
|
|
88
|
+
- **Keyless limits**: a graph download holds at most 12 series (with as-of vintages fetch asks 12 at a
|
|
89
|
+
time); mixed
|
|
90
|
+
frequencies come as a zip; an unknown ID answers HTTP 404 with an HTML page. The keyless route gives no
|
|
91
|
+
source, notes or copyright (`copyright` = `unknown`): for a report, read the tag on each series page
|
|
92
|
+
(https://fred.stlouisfed.org/series/ID: "Public Domain: Citation Requested", "Copyrighted: Citation
|
|
93
|
+
Required", "Copyrighted: Pre-Approval Required"; ignore the generic banner) and add `source`, `copyright`,
|
|
94
|
+
`copyright_basis` to the spec; fetching again rebuilds data/fred/ from raw/ without downloading.
|
|
95
|
+
- With a key, `copyright` comes from the series' FRED tag (`public_domain`, `citation_required`,
|
|
96
|
+
`preapproval_required`; `copyright_basis` names the tag; verified 2026-10). Only when the tag cannot be read
|
|
97
|
+
does it fall back to the notes (`copyrighted` / `no_copyright_notice`), and `no_copyright_notice` is not
|
|
98
|
+
proof of public domain: read the series page. `release_series.csv` carries FRED's own tag (v2 `copyright_id`).
|
|
99
|
+
- Keyless graph CSVs can carry one more digit than the API (GDPPOT differs in the 17th significant digit).
|
|
100
|
+
- Metro CPI IDs on FRED often keep BLS's pre-2018 area codes: FRED `CUURA101SA0` (New York) is BLS
|
|
101
|
+
`CUURS12ASA0`, `CUURA207SA0` (Chicago) is `CUURS23ASA0`; the values are identical (checked 2026-10-22), but
|
|
102
|
+
the bls pack and data.bls.gov answer "not found" for the FRED ID. Current codes: BLS's cu.area list.
|
|
103
|
+
- GeoFRED: trust the date key; the title can name a later month. `release_observations` stops after
|
|
104
|
+
`max_pages` (README notes the next cursor); filter with `series`.
|
|
105
|
+
- Choices that change headline numbers, benchmarks, report layout: docs/analysis_patterns.md. API details
|
|
106
|
+
and errors (checked live): docs/fred_api.md.
|
|
107
|
+
|
|
108
|
+
## Access
|
|
109
|
+
- Key: optional, free at https://fredaccount.stlouisfed.org/apikeys (one per user; never share or embed
|
|
110
|
+
one). The user stores it with `npx -y data-analyst-mcp setup fred` in their own terminal (FRED answers HTTP 400
|
|
111
|
+
naming api_key when it rejects a key); the server reads FRED_API_KEY, FRED_API_KEY_FILE, keys.json,
|
|
112
|
+
Claude Code settings.json or ~/.fred/api_key. v1 takes it as `api_key` (dropped from every recorded URL); v2
|
|
113
|
+
(release observations) as `Authorization: Bearer` (a query key answers HTTP 401).
|
|
114
|
+
- Limits: 120 requests a minute (the client paces at 1.8 a second), 100,000 observations per call (paged).
|
|
115
|
+
- How fetch proceeds: a folder that already holds the same request is reused (also when only labels, sources
|
|
116
|
+
or copyright changed: it is rebuilt from raw/; `force: true` downloads again). With a stored key it uses the
|
|
117
|
+
API. Without one it takes FRED's keyless graph downloads when the request needs no key-only feature: mention
|
|
118
|
+
once what a key adds. A key-only feature with no key fails with `key_missing`: the user stores a key with
|
|
119
|
+
`npx -y data-analyst-mcp setup fred` in their own terminal; never ask for the key in chat; offer as-of
|
|
120
|
+
vintages or explicit state IDs instead. A spec problem fails with `invalid_request`.
|
|
121
|
+
- Manual download: `manual_bundle` writes `manual_download/INSTRUCTIONS.md`, which lists one browser link per
|
|
122
|
+
keyless file (no key, no software) plus one command per OS (`bash ~/Downloads/download_data.sh`, or
|
|
123
|
+
`powershell -NoProfile -ExecutionPolicy Bypass -File "$HOME\Downloads\download_data.ps1"`). Each script has
|
|
124
|
+
the requests built in, asks for the key with hidden input only when a request needs one (`FRED_API_KEY`
|
|
125
|
+
wins), and saves next to itself. The scripts make one request per file: they cannot send v2's Bearer header
|
|
126
|
+
(whole releases need a fetch with a key) or chain GeoFRED's two-step lookup (put `series_group` in the spec's
|
|
127
|
+
`regional` block to make it one step). Send INSTRUCTIONS.md and both scripts. The user uploads every file
|
|
128
|
+
unchanged; then `ingest` with the uploaded files or their folder reads the CSV, XLSX and JSON files (release
|
|
129
|
+
pages are merged).
|
|
130
|
+
|
|
131
|
+
## Citation and terms
|
|
132
|
+
- Cite each series as FRED suggests (in `series.csv` and the README): "U.S. Bureau of Economic Analysis, Real
|
|
133
|
+
Gross Domestic Product [GDPC1], retrieved from FRED, Federal Reserve Bank of St. Louis;
|
|
134
|
+
https://fred.stlouisfed.org/series/GDPC1, October 20, 2026."
|
|
135
|
+
- Required notice in any product built on the API: "This product uses the FRED® API but is not endorsed or
|
|
136
|
+
certified by the Federal Reserve Bank of St. Louis." Never use the FRED or St. Louis Fed logo.
|
|
137
|
+
- Cache: none. FRED's terms (https://fred.stlouisfed.org/docs/api/terms_of_use.html,
|
|
138
|
+
https://fred.stlouisfed.org/legal/) forbid archives and wholesale downloads; only this run's data/fred/
|
|
139
|
+
copy is kept.
|
|
140
|
+
- Redistribution: allowed with citation, except series tagged Copyrighted: Pre-Approval Required (S&P, some
|
|
141
|
+
Moody's and ICE indexes): policy.json `withhold` drops their rows (series.csv `copyright` =
|
|
142
|
+
`preapproval_required`) from shared files unless the user has the owner's permission (record it).
|