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,103 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "fema",
|
|
3
|
+
"title": "OpenFEMA (FEMA open data API)",
|
|
4
|
+
"agency": "Federal Emergency Management Agency (U.S. Department of Homeland Security)",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"disasters",
|
|
8
|
+
"emergency management",
|
|
9
|
+
"housing",
|
|
10
|
+
"insurance",
|
|
11
|
+
"federal spending"
|
|
12
|
+
],
|
|
13
|
+
"keywords": [
|
|
14
|
+
"fema",
|
|
15
|
+
"disaster",
|
|
16
|
+
"disaster declaration",
|
|
17
|
+
"major disaster",
|
|
18
|
+
"emergency declaration",
|
|
19
|
+
"hurricane",
|
|
20
|
+
"flood",
|
|
21
|
+
"wildfire",
|
|
22
|
+
"tornado",
|
|
23
|
+
"severe storm",
|
|
24
|
+
"nfip",
|
|
25
|
+
"flood insurance",
|
|
26
|
+
"flood claims",
|
|
27
|
+
"public assistance",
|
|
28
|
+
"individual assistance",
|
|
29
|
+
"housing assistance",
|
|
30
|
+
"ihp",
|
|
31
|
+
"hazard mitigation",
|
|
32
|
+
"hmgp",
|
|
33
|
+
"mission assignment",
|
|
34
|
+
"disaster aid"
|
|
35
|
+
],
|
|
36
|
+
"questions": [
|
|
37
|
+
"how many major disasters were declared in a state each year",
|
|
38
|
+
"FEMA housing assistance after a hurricane",
|
|
39
|
+
"NFIP flood insurance claims paid for a storm",
|
|
40
|
+
"public assistance obligations by disaster",
|
|
41
|
+
"flood insurance policies in force by county"
|
|
42
|
+
],
|
|
43
|
+
"homepage": "https://www.fema.gov/about/openfema",
|
|
44
|
+
"terms_url": "https://www.fema.gov/about/openfema/terms-conditions",
|
|
45
|
+
"auth": {
|
|
46
|
+
"env": null,
|
|
47
|
+
"required": "none",
|
|
48
|
+
"placement": "none",
|
|
49
|
+
"signup_url": null,
|
|
50
|
+
"echoes_key": false
|
|
51
|
+
},
|
|
52
|
+
"limits": {
|
|
53
|
+
"rps": 3,
|
|
54
|
+
"burst": 6,
|
|
55
|
+
"max_rows": 200000
|
|
56
|
+
},
|
|
57
|
+
"routes": {
|
|
58
|
+
"api": {
|
|
59
|
+
"base": "https://www.fema.gov/api/open",
|
|
60
|
+
"probe": "https://www.fema.gov/api/open/v2/FemaRegions?$top=1",
|
|
61
|
+
"hosts": [
|
|
62
|
+
"www.fema.gov"
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
"manual": {
|
|
66
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (JSON pages of up to 10,000 rows; save each under the name shown) and upload them. Add $format=csv to a link for CSV instead. Whole datasets: each dataset page at https://www.fema.gov/about/openfema/data-sets has full CSV/Parquet downloads (large: NFIP policies are tens of GB); filter after download and upload the subset."
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"cache": {
|
|
70
|
+
"mode": "run_only",
|
|
71
|
+
"ttl_hours": null,
|
|
72
|
+
"why": "Datasets are refreshed daily to weekly (lastRefresh column); data/ is reused only within a run."
|
|
73
|
+
},
|
|
74
|
+
"redistribution": {
|
|
75
|
+
"mode": "allowed",
|
|
76
|
+
"why": "OpenFEMA data are U.S. government works (17 U.S.C. 105); the OpenFEMA terms (https://www.fema.gov/about/openfema/terms-conditions) allow use with the attribution and no-endorsement statement in notices. NFIP and IHP files are already redacted by FEMA for privacy."
|
|
77
|
+
},
|
|
78
|
+
"notices": [
|
|
79
|
+
"This product uses the Federal Emergency Management Agency's OpenFEMA API, but is not endorsed by FEMA. The Federal Government or FEMA cannot vouch for the data or analyses derived from these data after the data have been retrieved from the Agency's website(s)."
|
|
80
|
+
],
|
|
81
|
+
"retention": null,
|
|
82
|
+
"citation": "Federal Emergency Management Agency, OpenFEMA {dataset}, www.fema.gov/api/open, retrieved {retrieved_long}.",
|
|
83
|
+
"audit_hooks": [
|
|
84
|
+
{
|
|
85
|
+
"id": "fema_notice",
|
|
86
|
+
"kind": "require_text",
|
|
87
|
+
"any": [
|
|
88
|
+
"not endorsed by FEMA"
|
|
89
|
+
],
|
|
90
|
+
"why": "The OpenFEMA terms require the attribution and no-endorsement statement."
|
|
91
|
+
}
|
|
92
|
+
],
|
|
93
|
+
"clarify": [
|
|
94
|
+
"Count disasters or declared counties? DisasterDeclarationsSummaries has one row per designated area; count distinct disasterNumber for disasters.",
|
|
95
|
+
"Which declaration types: major disasters (DR) only, or also emergencies (EM) and fire management (FM)?",
|
|
96
|
+
"Calendar year or federal fiscal year (fyDeclared)? Default: say which one is used."
|
|
97
|
+
],
|
|
98
|
+
"formats": [
|
|
99
|
+
"json",
|
|
100
|
+
"csv",
|
|
101
|
+
"parquet"
|
|
102
|
+
]
|
|
103
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# OpenFEMA (FEMA open data API)
|
|
2
|
+
Depth: standard. Key: none. FEMA disaster declarations since 1953, Individual and Public Assistance, NFIP
|
|
3
|
+
flood insurance claims and policies, hazard mitigation grants, mission assignments, by state, county, ZIP.
|
|
4
|
+
|
|
5
|
+
## When to use
|
|
6
|
+
- Disaster declarations by state, year, incident type; FEMA aid after a disaster (housing assistance,
|
|
7
|
+
IHP registrations, Public Assistance obligations, per-disaster financial totals); NFIP flood claims
|
|
8
|
+
and policies; hazard mitigation grants; FEMA tasking of other agencies (mission assignments).
|
|
9
|
+
- Not here: earthquake events and streamflow (usgs), weather alerts and forecasts (nws), historical
|
|
10
|
+
weather (noaa), federal spending in general (usaspending), Census population for per-capita rates (census).
|
|
11
|
+
|
|
12
|
+
## Endpoints and datasets
|
|
13
|
+
One endpoint per dataset (JSON, `$top`/`$skip` paging of 10,000 rows) plus `query` for any other entity.
|
|
14
|
+
|
|
15
|
+
| Endpoint | Dataset (version/entity) | Grain |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
| `disaster_declarations` | v2/DisasterDeclarationsSummaries | one row per disaster x designated area (county, tribe) |
|
|
18
|
+
| `disaster_summaries` | v1/FemaWebDisasterSummaries | one row per disaster: IHP, HA, ONA approved; PA, HMGP obligated |
|
|
19
|
+
| `housing_owners`, `housing_renters` | v2/HousingAssistanceOwners, ...Renters | disaster x county x city x ZIP |
|
|
20
|
+
| `ihp_registrations` | v2/RegistrationIntakeIndividualsHouseholdPrograms | disaster x county x city x ZIP |
|
|
21
|
+
| `ihp_valid_registrations` | v2/IndividualsAndHouseholdsProgramValidRegistrations | one row per registration (26 M rows) |
|
|
22
|
+
| `public_assistance` | v2/PublicAssistanceGrantAwardActivities | award activity (project version) |
|
|
23
|
+
| `pa_projects` | v2/PublicAssistanceFundedProjectsDetails | funded project |
|
|
24
|
+
| `nfip_claims` | v3/NfipClaims | one claim (2.7 M rows) |
|
|
25
|
+
| `nfip_policies` | v3/NfipPolicies | one policy transaction (75 M rows) |
|
|
26
|
+
| `hmgp_summaries` | v3/HazardMitigationGrantProgramDisasterSummaries | disaster x program |
|
|
27
|
+
| `mission_assignments` | v2/MissionAssignments | mission assignment amendment |
|
|
28
|
+
| `fema_regions`, `datasets` | v2/FemaRegions, v1/DataSets | reference; DataSets lists every entity, version, record count |
|
|
29
|
+
| `query` | `version` + `entity` path parameters, CSV | any CSV-capable entity, e.g. v1/DeclarationDenials |
|
|
30
|
+
|
|
31
|
+
Parameters on every endpoint: `$filter` (OData), `$select`, `$orderby`, `$count` (`true` adds the total to
|
|
32
|
+
`metadata.count`). Paging parameters are set by the fetcher; use `max_rows` on the request.
|
|
33
|
+
`request_schema` with `search: "flood insurance"` finds a dataset alias.
|
|
34
|
+
`query` asks for CSV, so it works only for entities whose `distribution` in `datasets` lists `csv`:
|
|
35
|
+
IpawsArchivedAlerts v1 is JSON-only and answers HTTP 400 "does not support csv format"; an entity can be
|
|
36
|
+
listed in `datasets` and still answer 404 (PublicAssistanceProjectsStatus v1, verified 2026-10-22). For a
|
|
37
|
+
JSON-only entity use `manual_bundle` (JSON page links) and `ingest`.
|
|
38
|
+
|
|
39
|
+
## Spec examples
|
|
40
|
+
```json
|
|
41
|
+
{"description": "Major disaster declarations in Vermont, FY2023 (one row per county)",
|
|
42
|
+
"requests": [{"name": "vt_dr_fy2023", "endpoint": "disaster_declarations",
|
|
43
|
+
"params": {"$filter": "state eq 'VT' and fyDeclared eq 2023 and declarationType eq 'DR'", "$orderby": "id"}}]}
|
|
44
|
+
```
|
|
45
|
+
```json
|
|
46
|
+
{"description": "NFIP claims in Vermont with a 2023 date of loss (selected fields)",
|
|
47
|
+
"requests": [{"name": "vt_claims_2023", "endpoint": "nfip_claims",
|
|
48
|
+
"params": {"$filter": "state eq 'VT' and yearOfLoss eq 2023",
|
|
49
|
+
"$select": "id,dateOfLoss,yearOfLoss,floodEvent,state,countyCode,ratedFloodZone,netBuildingPaymentAmount,netContentsPaymentAmount"},
|
|
50
|
+
"max_rows": 50000}]}
|
|
51
|
+
```
|
|
52
|
+
```json
|
|
53
|
+
{"description": "Any other OpenFEMA entity as CSV",
|
|
54
|
+
"requests": [{"name": "regions", "endpoint": "query", "params": {"version": "v2", "entity": "FemaRegions"}}]}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Data format and traps
|
|
58
|
+
- **Declarations are per area.** `disaster_declarations` has one row per designated county or tribal
|
|
59
|
+
area; a disaster with 14 counties is 14 rows. Count disasters with distinct `disasterNumber` (or
|
|
60
|
+
`femaDeclarationString`, e.g. DR-4720-VT). `declarationType`: DR major disaster, EM emergency, FM fire
|
|
61
|
+
management. `fyDeclared` is the federal fiscal year (October-September), not the calendar year;
|
|
62
|
+
`declarationDate` gives the calendar date.
|
|
63
|
+
- **OData filters**: text in single quotes (`state eq 'VT'`), numbers bare (`fyDeclared eq 2023`), dates
|
|
64
|
+
as `declarationDate ge '2020-01-01T00:00:00.000z'`. Field names are case-sensitive and differ by
|
|
65
|
+
dataset: `state` (declarations, NFIP claims, housing), `stateAbbreviation` (Public Assistance),
|
|
66
|
+
`propertyState` (NFIP policies), `damagedStateAbbreviation` (valid registrations), `stt` (mission
|
|
67
|
+
assignments), `disasterState` with the full name (`disasterState eq 'Vermont'`, HMGP summaries; verified
|
|
68
|
+
2026-10). An unknown field fails with "Field ... not found"; fetch 5 rows unfiltered to see the names. Functions:
|
|
69
|
+
`contains(floodEvent,'Harvey')`, `startswith(...)`. A filter that matches nothing fails the fetch with
|
|
70
|
+
"returned no rows".
|
|
71
|
+
- **NFIP storm names** (`floodEvent`) are FEMA's labels ("Vermont/New York Flooding", "Hurricane Harvey",
|
|
72
|
+
some run together like "2026-03-KonaStorm"); match with `contains(floodEvent,'Harvey')` and check the
|
|
73
|
+
distinct values. `yearOfLoss` / `dateOfLoss` place a claim in time. Total paid = net building + net
|
|
74
|
+
contents + net ICC payment amounts. NFIP records are redacted by FEMA (no names or addresses; locations generalized).
|
|
75
|
+
- **Money** is nominal dollars. PA `federalShareObligated` changes as projects are versioned; IHP amounts
|
|
76
|
+
are approved, not necessarily disbursed. Say "obligated" or "approved", not "spent".
|
|
77
|
+
- **Size**: `nfip_policies` (75 M) and `ihp_valid_registrations` (26 M) need narrow filters; `max_rows`
|
|
78
|
+
defaults to 200,000. Ask for `$select` fields to keep files small.
|
|
79
|
+
- **Paging**: the fetcher asks for 10,000 rows per call (`$top`; 1,000 when not set) and pages with `$skip`.
|
|
80
|
+
Set `$orderby` (default `id` where the entity has one) so pages do not overlap; `pa_projects` and
|
|
81
|
+
`hmgp_summaries` have no `id` field (verified 2026-10).
|
|
82
|
+
- `fema_regions` has 11 rows (the ten regions plus FEMA Headquarters). CSV from `query` keeps every column,
|
|
83
|
+
including map geometry (`regionGeometry` is 200-450 KB a row); add `$select` when the shapes are not needed.
|
|
84
|
+
- Booleans are written as `True`/`False` by the named endpoints (JSON) but as `0`/`1` by `query` (CSV);
|
|
85
|
+
dates are ISO 8601 UTC strings (`2023-07-14T00:00:00.000Z`).
|
|
86
|
+
- Versions: OpenFEMA versions each dataset separately (v1, v2, v3) and deprecates old versions; the
|
|
87
|
+
`datasets` endpoint lists current versions and `depDate`, and a retired version answers 404 (the fetch
|
|
88
|
+
says "not found"): check `datasets` before assuming the data are missing. NFIP entities
|
|
89
|
+
were renamed from FimaNfipClaims/FimaNfipPolicies to NfipClaims/NfipPolicies (v3).
|
|
90
|
+
- Data are refreshed daily to weekly (`lastRefresh`), and recent disasters change as aid is processed.
|
|
91
|
+
|
|
92
|
+
## Access
|
|
93
|
+
No key, no published rate limit (the fetcher sends 3 requests a second). `fetch` downloads when www.fema.gov
|
|
94
|
+
answers. Manual route (`manual_bundle`): `manual_download/INSTRUCTIONS.md` lists one JSON link per 10,000-row page (append
|
|
95
|
+
`&$format=csv` for CSV); or download a whole dataset as CSV or Parquet from its page at
|
|
96
|
+
https://www.fema.gov/about/openfema/data-sets, filter it locally, and upload the subset; then `ingest`.
|
|
97
|
+
|
|
98
|
+
## Citation and terms
|
|
99
|
+
"Federal Emergency Management Agency, OpenFEMA <dataset>, www.fema.gov/api/open, retrieved <date>."
|
|
100
|
+
Every product must carry the OpenFEMA statement (in policy notices): "This product uses the Federal
|
|
101
|
+
Emergency Management Agency's OpenFEMA API, but is not endorsed by FEMA," plus the statement that FEMA
|
|
102
|
+
cannot vouch for data or analyses derived after retrieval. U.S. government data; redistribution allowed
|
|
103
|
+
under the OpenFEMA terms (https://www.fema.gov/about/openfema/terms-conditions).
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://www.fhfa.gov",
|
|
3
|
+
"timeout": 180,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"hpi_master": {
|
|
6
|
+
"path": "/hpi/download/monthly/hpi_master.csv",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"description": "Every FHFA House Price Index series in one file (17 MB, about 186,000 rows): purchase-only monthly U.S. and census divisions (NSA and SA), quarterly purchase-only, all-transactions and expanded-data indexes for the U.S., divisions, states and metro areas, plus distress-free, non-metro, manufactured-home and Puerto Rico indexes. The pack reads the whole file and keeps the rows that match the filters.",
|
|
9
|
+
"params": {
|
|
10
|
+
"hpi_type": {"in": "spec", "column": "hpi_type", "enum": ["traditional", "non-metro", "distress-free", "developmental", "manufactured"], "desc": "index family (traditional = the standard FHFA HPI)"},
|
|
11
|
+
"hpi_flavor": {"in": "spec", "column": "hpi_flavor", "enum": ["purchase-only", "all-transactions", "expanded-data"], "desc": "purchase-only (flagship; sales only), all-transactions (adds refinance appraisals), expanded-data (purchase-only plus county recorder and FHA data)"},
|
|
12
|
+
"frequency": {"in": "spec", "column": "frequency", "enum": ["monthly", "quarterly"], "desc": "monthly exists only for purchase-only U.S. and census divisions"},
|
|
13
|
+
"level": {"in": "spec", "column": "level", "enum": ["USA or Census Division", "State", "MSA", "Puerto Rico"], "desc": "geography level"},
|
|
14
|
+
"place_id": {"in": "spec", "column": "place_id", "desc": "USA, a division code (DV_ENC, DV_PAC, ...), a state abbreviation, or a CBSA code; a list matches any"},
|
|
15
|
+
"place_name": {"in": "spec", "column": "place_name", "desc": "exact place name (United States, Vermont, ...); a list matches any"},
|
|
16
|
+
"where": {"in": "spec", "desc": "more equality filters {column: value or list}; matching ignores case and surrounding spaces"},
|
|
17
|
+
"min_year": {"in": "spec", "desc": "first year (yr) to keep"},
|
|
18
|
+
"max_year": {"in": "spec", "desc": "last year (yr) to keep"}
|
|
19
|
+
},
|
|
20
|
+
"year_column": "yr",
|
|
21
|
+
"records": "$csv",
|
|
22
|
+
"paging": {"type": "none"},
|
|
23
|
+
"max_rows": 400000,
|
|
24
|
+
"missing": [""],
|
|
25
|
+
"flatten": false
|
|
26
|
+
},
|
|
27
|
+
"hpi_state": {
|
|
28
|
+
"path": "/hpi/download/quarterly_datasets/hpi_at_state.csv",
|
|
29
|
+
"method": "GET",
|
|
30
|
+
"description": "Quarterly all-transactions HPI for the 50 states and DC, 1975Q1 on, NSA, 1980Q1 = 100 (188 KB; the same numbers as hpi_master all-transactions State rows). The file has no header row: the pack names the columns state, yr, qtr, index_nsa.",
|
|
31
|
+
"params": {
|
|
32
|
+
"state": {"in": "spec", "column": "state", "desc": "state abbreviation (VT) or a list"},
|
|
33
|
+
"where": {"in": "spec", "desc": "more equality filters {column: value or list}"},
|
|
34
|
+
"min_year": {"in": "spec", "desc": "first year to keep"},
|
|
35
|
+
"max_year": {"in": "spec", "desc": "last year to keep"}
|
|
36
|
+
},
|
|
37
|
+
"header": ["state", "yr", "qtr", "index_nsa"],
|
|
38
|
+
"year_column": "yr",
|
|
39
|
+
"records": "$csv",
|
|
40
|
+
"paging": {"type": "none"},
|
|
41
|
+
"max_rows": 100000,
|
|
42
|
+
"missing": [""],
|
|
43
|
+
"flatten": false
|
|
44
|
+
},
|
|
45
|
+
"hpi_annual": {
|
|
46
|
+
"path": "/hpi/download/annual/hpi_at_{geography}.xlsx",
|
|
47
|
+
"method": "GET",
|
|
48
|
+
"description": "Annual all-transactions HPI (developmental) for the nation, states, CBSAs, counties or three-digit ZIP codes: annual change (%) and the index on three bases (first year = 100, 1990 = 100, 2000 = 100), NSA, through the last full year. County 5.3 MB, CBSA 2.1 MB, ZIP3 1.9 MB.",
|
|
49
|
+
"params": {
|
|
50
|
+
"geography": {"in": "path", "required": true, "enum": ["national", "state", "cbsa", "county", "zip3"], "desc": "national, state, cbsa, county or zip3 (ZIP5 and tract files are too large: see source.md)"},
|
|
51
|
+
"where": {"in": "spec", "desc": "equality filters on the file's columns {column: value or list}: State / Abbreviation / FIPS (state), State / County / FIPS code (county), CBSA / Name (cbsa), Three-Digit ZIP Code (zip3)"},
|
|
52
|
+
"min_year": {"in": "spec", "desc": "first Year to keep"},
|
|
53
|
+
"max_year": {"in": "spec", "desc": "last Year to keep"}
|
|
54
|
+
},
|
|
55
|
+
"year_column": "Year",
|
|
56
|
+
"records": "$xlsx",
|
|
57
|
+
"sheet": 1,
|
|
58
|
+
"header_row": 6,
|
|
59
|
+
"paging": {"type": "none"},
|
|
60
|
+
"max_rows": 200000,
|
|
61
|
+
"missing": ["", "."],
|
|
62
|
+
"flatten": false
|
|
63
|
+
},
|
|
64
|
+
"loan_limits": {
|
|
65
|
+
"path": "/document/d/cll/fullcountyloanlimitlist{year}_hera-based_final_flat.csv",
|
|
66
|
+
"method": "GET",
|
|
67
|
+
"description": "Conforming loan limits by county for one calendar year (Fannie Mae and Freddie Mac; HERA-based), for one- to four-unit properties: about 3,235 counties. CSV files exist for 2024 on; next year's file appears when FHFA announces the limits in late November. Columns are renamed to snake_case and dollar amounts made plain numbers.",
|
|
68
|
+
"params": {
|
|
69
|
+
"year": {"in": "path", "required": true, "desc": "calendar year of the limits, 2024 or later (2022-2023 are .xlsx only: manual)"},
|
|
70
|
+
"state": {"in": "spec", "column": "state", "desc": "state abbreviation (CA) or a list"},
|
|
71
|
+
"where": {"in": "spec", "desc": "more equality filters {column: value or list}, snake_case names (county_name, cbsa_number, fips_state_code)"}
|
|
72
|
+
},
|
|
73
|
+
"snake_columns": true,
|
|
74
|
+
"records": "$csv",
|
|
75
|
+
"paging": {"type": "none"},
|
|
76
|
+
"max_rows": 10000,
|
|
77
|
+
"missing": [""],
|
|
78
|
+
"flatten": false
|
|
79
|
+
},
|
|
80
|
+
"fhlb_pudb": {
|
|
81
|
+
"path": "/document/d/pud/{year}-pudb.csv",
|
|
82
|
+
"method": "GET",
|
|
83
|
+
"description": "Federal Home Loan Bank System Public Use Database: one row per single-family mortgage acquired by an FHLBank in the year (loan amount, LTV, note rate, borrower income, census tract, race, sex, age, credit score bucket). 12 MB for 2025. Enterprise (Fannie Mae, Freddie Mac) loan-level files are large zips: manual.",
|
|
84
|
+
"params": {
|
|
85
|
+
"year": {"in": "path", "required": true, "enum": ["2023", "2024", "2025"], "desc": "acquisition year (files named {year}-pudb.csv)"},
|
|
86
|
+
"where": {"in": "spec", "desc": "equality filters {column: value or list} on the file's columns (Bank, FIPSStateNumericCode, FIPSCountyCode, CoreBasedStatisticalAreaCode, LoanPurposeType, BorrowerFirstTimeHomebuyer, PropertyUnitCount)"}
|
|
87
|
+
},
|
|
88
|
+
"records": "$csv",
|
|
89
|
+
"paging": {"type": "none"},
|
|
90
|
+
"max_rows": 200000,
|
|
91
|
+
"missing": [""],
|
|
92
|
+
"flatten": false
|
|
93
|
+
}
|
|
94
|
+
},
|
|
95
|
+
"catalog": {
|
|
96
|
+
"hpi_us_po_monthly": {"id": "hpi_master", "name": "Purchase-only HPI, U.S. and census divisions, monthly (NSA and SA)", "description": "Flagship monthly FHFA HPI: hpi_master with hpi_flavor purchase-only, frequency monthly, place_id USA (or a division)", "endpoint": "hpi_master"},
|
|
97
|
+
"hpi_state_po_quarterly": {"id": "hpi_master", "name": "Purchase-only HPI by state, quarterly (NSA and SA)", "description": "hpi_master with hpi_flavor purchase-only, frequency quarterly, level State", "endpoint": "hpi_master"},
|
|
98
|
+
"hpi_metro": {"id": "hpi_master", "name": "HPI by metro area (CBSA), quarterly", "description": "hpi_master with level MSA: all-transactions and expanded-data for 410 metros and metro divisions, purchase-only for the 100 largest", "endpoint": "hpi_master"},
|
|
99
|
+
"hpi_state_at": {"id": "hpi_state", "name": "All-transactions HPI by state, quarterly, since 1975", "description": "hpi_state (small file, NSA)", "endpoint": "hpi_state"},
|
|
100
|
+
"hpi_county_annual": {"id": "hpi_annual", "name": "Annual HPI by county (developmental)", "description": "hpi_annual with geography county", "endpoint": "hpi_annual"},
|
|
101
|
+
"hpi_zip3_annual": {"id": "hpi_annual", "name": "Annual HPI by three-digit ZIP code (developmental)", "description": "hpi_annual with geography zip3", "endpoint": "hpi_annual"},
|
|
102
|
+
"conforming_loan_limits": {"id": "loan_limits", "name": "Conforming loan limits by county", "description": "loan_limits with a year; baseline and high-cost (HERA) limits for one to four units", "endpoint": "loan_limits"},
|
|
103
|
+
"fhlbank_pudb": {"id": "fhlb_pudb", "name": "FHLBank Public Use Database (loan level)", "description": "fhlb_pudb with a year (2023-2025)", "endpoint": "fhlb_pudb"}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "fhfa",
|
|
3
|
+
"title": "FHFA House Price Index, conforming loan limits and Public Use Databases (fhfa.gov files)",
|
|
4
|
+
"agency": "Federal Housing Finance Agency",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"housing",
|
|
8
|
+
"house prices",
|
|
9
|
+
"mortgage finance"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"fhfa",
|
|
13
|
+
"house price index",
|
|
14
|
+
"hpi",
|
|
15
|
+
"home prices",
|
|
16
|
+
"house prices",
|
|
17
|
+
"home values",
|
|
18
|
+
"purchase-only index",
|
|
19
|
+
"all-transactions index",
|
|
20
|
+
"conforming loan limit",
|
|
21
|
+
"loan limit",
|
|
22
|
+
"jumbo",
|
|
23
|
+
"high-cost area",
|
|
24
|
+
"fannie mae",
|
|
25
|
+
"freddie mac",
|
|
26
|
+
"enterprises",
|
|
27
|
+
"gse",
|
|
28
|
+
"federal home loan bank",
|
|
29
|
+
"fhlbank",
|
|
30
|
+
"public use database",
|
|
31
|
+
"pudb",
|
|
32
|
+
"mortgage"
|
|
33
|
+
],
|
|
34
|
+
"questions": [
|
|
35
|
+
"latest FHFA house price index for the U.S., seasonally adjusted",
|
|
36
|
+
"house price growth by state over the last year",
|
|
37
|
+
"home price appreciation in a metro area since 2020",
|
|
38
|
+
"annual house price index by county",
|
|
39
|
+
"2026 conforming loan limit for a one-unit home in a county",
|
|
40
|
+
"which counties have high-cost loan limits"
|
|
41
|
+
],
|
|
42
|
+
"homepage": "https://www.fhfa.gov/data",
|
|
43
|
+
"terms_url": "https://www.fhfa.gov/about/fhfa-policies",
|
|
44
|
+
"auth": {
|
|
45
|
+
"env": null,
|
|
46
|
+
"required": "none",
|
|
47
|
+
"placement": "none",
|
|
48
|
+
"param": null,
|
|
49
|
+
"prefix": "",
|
|
50
|
+
"home": null,
|
|
51
|
+
"signup_url": null,
|
|
52
|
+
"echoes_key": false,
|
|
53
|
+
"key_only": [],
|
|
54
|
+
"extra": {},
|
|
55
|
+
"demo_key": null
|
|
56
|
+
},
|
|
57
|
+
"limits": {
|
|
58
|
+
"rps": 1,
|
|
59
|
+
"burst": 2,
|
|
60
|
+
"daily_quota": null,
|
|
61
|
+
"errors_per_min": null,
|
|
62
|
+
"bytes_per_min": null,
|
|
63
|
+
"max_rows": 400000
|
|
64
|
+
},
|
|
65
|
+
"routes": {
|
|
66
|
+
"api": {
|
|
67
|
+
"base": "https://www.fhfa.gov",
|
|
68
|
+
"probe": "https://www.fhfa.gov/hpi/download/quarterly_datasets/hpi_at_state.csv",
|
|
69
|
+
"hosts": [
|
|
70
|
+
"www.fhfa.gov"
|
|
71
|
+
]
|
|
72
|
+
},
|
|
73
|
+
"manual": {
|
|
74
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser; the file downloads (hpi_master.csv is 17 MB). Upload it under the name shown; the pack applies the request's filters to the uploaded file. Without the links: HPI files are listed on https://www.fhfa.gov/data/hpi/datasets, conforming loan limits on https://www.fhfa.gov/data/conforming-loan-limit, Public Use Databases on https://www.fhfa.gov/data/pudb."
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
"cache": {
|
|
78
|
+
"mode": "run_only",
|
|
79
|
+
"ttl_hours": null,
|
|
80
|
+
"why": "Files are overwritten in place at each release (monthly HPI, quarterly, annual); data/ is reused only within a run."
|
|
81
|
+
},
|
|
82
|
+
"redistribution": {
|
|
83
|
+
"mode": "allowed",
|
|
84
|
+
"why": "FHFA data are works of a U.S. government agency, in the public domain (17 U.S.C. 105); cite FHFA as the source."
|
|
85
|
+
},
|
|
86
|
+
"notices": [],
|
|
87
|
+
"retention": null,
|
|
88
|
+
"citation": "Federal Housing Finance Agency, {dataset}, www.fhfa.gov, retrieved {retrieved_long}.",
|
|
89
|
+
"audit_hooks": [],
|
|
90
|
+
"clarify": [
|
|
91
|
+
"Which index: purchase-only (the flagship, sales only) or all-transactions (adds refinance appraisals, longer history)? Default: purchase-only.",
|
|
92
|
+
"Seasonally adjusted or not? Default: seasonally adjusted for month-to-month or quarter-to-quarter changes, not adjusted for year-over-year changes.",
|
|
93
|
+
"Which loan limit: the baseline (most counties) or a specific county's limit (high-cost areas are higher), and for how many units? Default: one-unit."
|
|
94
|
+
],
|
|
95
|
+
"formats": [
|
|
96
|
+
"csv",
|
|
97
|
+
"xlsx"
|
|
98
|
+
],
|
|
99
|
+
"use_instead": [
|
|
100
|
+
{
|
|
101
|
+
"question": "One FHFA house price series for the U.S. or a state, with no index flavor choice",
|
|
102
|
+
"source": "fred",
|
|
103
|
+
"terms": [
|
|
104
|
+
"USSTHPI"
|
|
105
|
+
],
|
|
106
|
+
"why": "FRED carries the all-transactions and purchase-only HPI series under stable IDs."
|
|
107
|
+
}
|
|
108
|
+
]
|
|
109
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# FHFA House Price Index, conforming loan limits and Public Use Databases (fhfa.gov files)
|
|
2
|
+
Depth: standard. Key: none. The Federal Housing Finance Agency's House Price Index (U.S., divisions, states,
|
|
3
|
+
metros, counties, ZIP3), the conforming loan limits for Fannie Mae and Freddie Mac by county, and the FHLBank
|
|
4
|
+
loan-level Public Use Database, read from FHFA's published files.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- House price levels and growth (monthly U.S. and census divisions; quarterly states and metros; annual counties
|
|
8
|
+
and three-digit ZIP codes), as an input to housing, property-tax or mortgage questions; the conforming loan
|
|
9
|
+
limit for a county and year (baseline and high-cost); loan-level FHLBank mortgage acquisitions.
|
|
10
|
+
- Not here: Case-Shiller or Zillow indexes (not federal); FRED also carries many FHFA HPI series (USSTHPI
|
|
11
|
+
all-transactions U.S., HPIPONM226S purchase-only U.S. SA monthly, <ST>STHPI by state) and is simpler for one
|
|
12
|
+
series: use fred when the question needs only those. Mortgage originations and denials by lender
|
|
13
|
+
(HMDA: not covered; the cfpb pack holds complaints only); FHA loan limits (not covered; the hud pack has Fair
|
|
14
|
+
Market Rents and income limits only).
|
|
15
|
+
|
|
16
|
+
## Endpoints and datasets
|
|
17
|
+
Base `https://www.fhfa.gov`, keyless files, stable names overwritten in place at each release (verified live
|
|
18
|
+
2026-10-30). The pack downloads the whole file and keeps the rows that match the filters; `max_rows` counts
|
|
19
|
+
rows after filtering. Filters match without case or surrounding spaces; a list matches any of its values.
|
|
20
|
+
|
|
21
|
+
| Endpoint | File, size | Filters | Columns, units, coverage |
|
|
22
|
+
|---|---|---|---|
|
|
23
|
+
| `hpi_master` | `/hpi/download/monthly/hpi_master.csv`, 17 MB, 186,000 rows | `hpi_type`, `hpi_flavor`, `frequency`, `level`, `place_id`, `place_name`, `where`, `min_year`, `max_year` | `hpi_type, hpi_flavor, frequency, level, place_name, place_id, yr, period, index_nsa, index_sa, rstderr, note`; `period` is the month (monthly) or quarter; index points |
|
|
24
|
+
| `hpi_state` | `/hpi/download/quarterly_datasets/hpi_at_state.csv`, 188 KB | `state`, `where`, `min_year`, `max_year` | `state, yr, qtr, index_nsa` (the file has no header row; the pack names the columns): all-transactions, NSA, 1975Q1 on, 1980Q1 = 100 |
|
|
25
|
+
| `hpi_annual` | `/hpi/download/annual/hpi_at_{geography}.xlsx`, `geography` = `national`, `state`, `cbsa`, `county`, `zip3` (0.02-5.3 MB) | `where` on the file's columns, `min_year`, `max_year` | annual all-transactions, developmental: `Year`, `Annual Change (%)`, `HPI` (first year = 100), `HPI with 1990 base`, `HPI with 2000 base`; geography columns `State, Abbreviation, FIPS` (state), `State, County, FIPS code` (county), `CBSA, Name` (cbsa), `Three-Digit ZIP Code` (zip3); through the last full year (2025 on 2026-10-30) |
|
|
26
|
+
| `loan_limits` | `/document/d/cll/fullcountyloanlimitlist{year}_hera-based_final_flat.csv`, 280 KB, about 3,235 counties | `year` (2024 on, required), `state`, `where` | `fips_state_code, fips_county_code, county_name, state, cbsa_number, one_unit_limit, two_unit_limit, three_unit_limit, four_unit_limit` in dollars (renamed and cleaned so all years match) |
|
|
27
|
+
| `fhlb_pudb` | `/document/d/pud/{year}-pudb.csv`, `year` 2023-2025, 12 MB | `where` (e.g. `{"FIPSStateNumericCode": "50"}`) | one row per FHLBank single-family loan; codes in FHFA's PUDB definitions PDF on https://www.fhfa.gov/data/pudb |
|
|
28
|
+
|
|
29
|
+
`hpi_master` contents (rows by `hpi_type`/`hpi_flavor`/`frequency`/`level`): purchase-only monthly for the U.S.
|
|
30
|
+
(`place_id` USA) and the nine census divisions (`DV_ENC`, `DV_ESC`, `DV_MA`, `DV_MT`, `DV_NE`, `DV_PAC`, `DV_SA`,
|
|
31
|
+
`DV_WNC`, `DV_WSC`) from 1991-01; quarterly purchase-only, all-transactions (from 1975) and expanded-data for the
|
|
32
|
+
U.S., divisions and states; `MSA` rows: all-transactions and expanded-data for 410 metros and metro divisions
|
|
33
|
+
(`place_id` = CBSA code), purchase-only for the 100 largest; distress-free (14 metros), non-metro (state),
|
|
34
|
+
manufactured-home (U.S. and divisions) and developmental Puerto Rico indexes. Catalog aliases (`request_schema`
|
|
35
|
+
`search`) point to these endpoints. Not wrapped: the ZIP5 (40 MB .xlsx) and census tract (90 MB .csv) annual files, the
|
|
36
|
+
quarterly expanded-data and purchase-only .xlsx variants (the same series are in `hpi_master`), and the release
|
|
37
|
+
summary workbooks (`hpi_po_monthly_sa.xlsx`, a formatted table of percent changes, not a data table).
|
|
38
|
+
|
|
39
|
+
## Spec examples
|
|
40
|
+
```json
|
|
41
|
+
{"description": "Latest FHFA purchase-only HPI for the U.S., monthly, seasonally adjusted",
|
|
42
|
+
"requests": [{"name": "us_po_monthly", "endpoint": "hpi_master",
|
|
43
|
+
"params": {"hpi_type": "traditional", "hpi_flavor": "purchase-only", "frequency": "monthly", "place_id": "USA"}}]}
|
|
44
|
+
```
|
|
45
|
+
```json
|
|
46
|
+
{"description": "Vermont: quarterly purchase-only index since 2024, all-transactions since 2025, annual county indexes",
|
|
47
|
+
"requests": [
|
|
48
|
+
{"name": "vt_po", "endpoint": "hpi_master", "params": {"hpi_flavor": "purchase-only", "level": "State", "place_id": "VT", "min_year": 2024}},
|
|
49
|
+
{"name": "vt_at", "endpoint": "hpi_state", "params": {"state": "VT", "min_year": 2025}},
|
|
50
|
+
{"name": "vt_counties", "endpoint": "hpi_annual", "params": {"geography": "county", "where": {"State": "VT"}, "min_year": 2015}}]}
|
|
51
|
+
```
|
|
52
|
+
```json
|
|
53
|
+
{"description": "2026 conforming loan limits, California counties",
|
|
54
|
+
"requests": [{"name": "ca_2026", "endpoint": "loan_limits", "params": {"year": 2026, "state": "CA"}}]}
|
|
55
|
+
```
|
|
56
|
+
Put several geographies in one request (`"place_id": ["USA", "DV_PAC"]`) rather than one request each: every
|
|
57
|
+
`hpi_master` request downloads the 17 MB file again.
|
|
58
|
+
|
|
59
|
+
## Data format and traps
|
|
60
|
+
- Three flavors: purchase-only (sales prices of Fannie Mae and Freddie Mac mortgages; the flagship, from 1991),
|
|
61
|
+
all-transactions (adds refinance appraisals; from 1975; quarterly only) and
|
|
62
|
+
expanded-data (purchase-only plus county recorder and FHA data; quarterly). They differ in level and growth:
|
|
63
|
+
name the flavor in every answer and never splice them.
|
|
64
|
+
- NSA vs SA: `index_sa` exists only for purchase-only and expanded-data; all-transactions is NSA only (empty
|
|
65
|
+
`index_sa`). FHFA's monthly release reports SA month-over-month changes; its year-over-year change matches SA
|
|
66
|
+
(Aug 2026: SA 444.61 / 434.04 = +2.4 %, the release's figure; NSA 450.45 / 439.64 gives +2.5 %).
|
|
67
|
+
- Index levels are relative to a base period that differs by series (purchase-only 1991-01 or 1991Q1 = 100,
|
|
68
|
+
all-transactions 1980Q1 = 100, annual files three bases); compare growth rates, never levels across series or
|
|
69
|
+
geographies (a state at 600 is not "more expensive" than one at 400).
|
|
70
|
+
- Revisions: every release re-estimates the whole history (the July 2026 monthly change was revised from 0.3 % to
|
|
71
|
+
0.2 % in the October 27, 2026 release). The files are overwritten in place, so a refetch can change past values;
|
|
72
|
+
cite the retrieval date.
|
|
73
|
+
- Latest periods (2026-10-30): monthly through 2026-08, quarterly through 2026Q2, annual through 2025.
|
|
74
|
+
`rstderr` (revision standard error) and `note` are mostly empty; purchase-only state rows flag small samples in
|
|
75
|
+
the xlsx files, not in `hpi_master`.
|
|
76
|
+
- The annual county, CBSA, ZIP3 and state files are labeled developmental by FHFA; a "." in the file (written as
|
|
77
|
+
an empty cell) means too few sales. Their `HPI` column is 100 in each area's own first year, so use `HPI with
|
|
78
|
+
2000 base` or `Annual Change (%)` to compare areas. The .xlsx stores numbers as binary floats; the pack writes
|
|
79
|
+
them in shortest form (69.15, not 69.150000000000006), the same value.
|
|
80
|
+
- Conforming loan limits are set per calendar year by county and number of units (1-4). The 2026 baseline
|
|
81
|
+
one-unit limit is $832,750 (3,075 of 3,235 counties; 2025: $806,500); high-cost areas (HERA: 115 % of the local
|
|
82
|
+
median home value) go up to a ceiling of 150 % of the baseline, $1,249,125 in 2026. Alaska, Hawaii, Guam and the
|
|
83
|
+
U.S. Virgin Islands have a higher baseline ($1,249,125) and can exceed the ceiling (Maui and Kalawao, HI:
|
|
84
|
+
$1,299,500). The next year's file appears when FHFA announces the limits in late November; a year not yet
|
|
85
|
+
published answers 404. Files before 2024 are .xlsx (2022-2023) or older formats: manual download.
|
|
86
|
+
- The 2025 and 2026 loan-limit files differ in layout (2026: "One-Unit\nLimit" headers, "$832,750 " values,
|
|
87
|
+
"01"/"001" FIPS; 2025: "One_Unit_Limit", 806500, "1"/"1"); the pack renames columns to snake_case, writes
|
|
88
|
+
plain dollars and zero-pads FIPS, and says so in a fetch note. `cbsa_number` 99999 means not in a CBSA.
|
|
89
|
+
- `fhlb_pudb` is FHLBank loan-level data (not Fannie Mae and Freddie Mac): many columns hold codes, and
|
|
90
|
+
placeholder values (e.g. 9999, 9999-12-31) appear where a field does not apply; read the definitions PDF
|
|
91
|
+
before summarizing any column. The Enterprise
|
|
92
|
+
(Fannie Mae, Freddie Mac) PUDB is in zips of 13-136 MB per year on https://www.fhfa.gov/data/pudb: not
|
|
93
|
+
wrapped (manual download, then analysis on the uploaded file).
|
|
94
|
+
- FHFA can answer HTTP 200 with a web page when a file moves; the pack refuses such a reply rather than reading it.
|
|
95
|
+
|
|
96
|
+
## Access
|
|
97
|
+
No key, no API: files on www.fhfa.gov, which answers scripts (verified 2026-10-30). Limit used: one request per
|
|
98
|
+
second. `fetch` downloads the file; manual route (`manual_bundle`): open the link in
|
|
99
|
+
`manual_download/INSTRUCTIONS.md`, save the file under the name shown, upload it and call `ingest` (the pack
|
|
100
|
+
applies the same filters to the upload). Index pages:
|
|
101
|
+
https://www.fhfa.gov/data/hpi/datasets (every HPI file), https://www.fhfa.gov/data/conforming-loan-limit (loan
|
|
102
|
+
limits by year, with FAQs and the announcement), https://www.fhfa.gov/data/pudb (Public Use Databases and their
|
|
103
|
+
definitions).
|
|
104
|
+
|
|
105
|
+
## Citation and terms
|
|
106
|
+
Federal Housing Finance Agency, <dataset> (e.g. "FHFA House Price Index, purchase-only, seasonally adjusted"),
|
|
107
|
+
www.fhfa.gov, retrieved <date>. U.S. government work in the public domain (17 U.S.C. 105): redistribution
|
|
108
|
+
allowed; cite FHFA as the source and name the index flavor and adjustment.
|