data-analyst-mcp 0.3.0 → 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.
Files changed (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. package/packs/world-bank/policy.json +101 -101
@@ -1,103 +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
- }
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
+ }
@@ -1,105 +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
- }
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
+ }