{"service":"realestate","description":"Normalized US real-estate market-intelligence profiles, fused from free public-domain government sources with per-value provenance. Aggregate market-tier (state / metro CBSA / county FIPS / ZIP), not a per-address AVM.","routes":{"/realestate/market":"composite profile: FHFA momentum + ACS + FRED context + HUD FMR + derivatives","/realestate/prices":"FHFA House Price Index level + YoY/QoQ/5yr momentum","/realestate/rents":"HUD Fair Market Rents by bedroom + ACS median gross rent","/realestate/compare":"cross-metro ranking on a metric + rank/min/max/spread signals"},"geo_input":{"types":["address","auto","cbsa","county","state","zip"],"note":"geo accepts a state (2-letter USPS or name), metro CBSA code (5-digit), county FIPS (5-digit), ZIP (5-digit), or an address. In auto mode a 5-digit number is treated as a ZIP; pass type=cbsa or type=county to disambiguate."},"acs_metrics":[{"metric":"median_home_value","label":"Median home value (owner-occupied)","unit":"USD","category":"price","source_code":"B25077_001E","source":"acs"},{"metric":"median_gross_rent","label":"Median gross rent","unit":"USD/month","category":"rent","source_code":"B25064_001E","source":"acs"},{"metric":"median_household_income","label":"Median household income","unit":"USD","category":"income","source_code":"B19013_001E","source":"acs"},{"metric":"population","label":"Total population","unit":"persons","category":"demography","source_code":"B01003_001E","source":"acs"},{"metric":"occupied_units","label":"Occupied housing units","unit":"units","category":"housing","source_code":"B25003_001E","source":"acs"},{"metric":"owner_occupied_units","label":"Owner-occupied housing units","unit":"units","category":"housing","source_code":"B25003_002E","source":"acs"},{"metric":"renter_occupied_units","label":"Renter-occupied housing units","unit":"units","category":"housing","source_code":"B25003_003E","source":"acs"},{"metric":"total_housing_units","label":"Total housing units","unit":"units","category":"housing","source_code":"B25001_001E","source":"acs"},{"metric":"total_occupancy_units","label":"Housing units (occupancy universe)","unit":"units","category":"housing","source_code":"B25002_001E","source":"acs"},{"metric":"vacant_units","label":"Vacant housing units","unit":"units","category":"housing","source_code":"B25002_003E","source":"acs"}],"national_context_series":[{"metric":"mortgage_30yr","label":"30-year fixed mortgage rate","unit":"percent","source_code":"MORTGAGE30US","source":"fred"},{"metric":"median_sale_price_us","label":"Median sales price of houses sold (US)","unit":"USD","source_code":"MSPUS","source":"fred"},{"metric":"housing_starts","label":"Housing starts (new privately-owned)","unit":"thousands_saar","source_code":"HOUST","source":"fred"},{"metric":"monthly_supply","label":"Monthly supply of new houses","unit":"months","source_code":"MSACSR","source":"fred"},{"metric":"new_1family_sold","label":"New one-family houses sold","unit":"thousands_saar","source_code":"HSN1F","source":"fred"},{"metric":"case_shiller","label":"S&P/Case-Shiller US National Home Price Index","unit":"index","source_code":"CSUSHPINSA","source":"fred"}],"derivatives":{"price_momentum":"FHFA HPI change: year-over-year, quarter-over-quarter and 5-year CAGR (%)","gross_rental_yield":"ACS annual median gross rent divided by median home value (%, proxy)","price_to_income":"ACS median home value divided by median household income (x)","rent_to_income":"ACS annual median gross rent divided by median household income (share)","homeownership_rate":"ACS owner-occupied units divided by occupied units (%)","vacancy_rate":"ACS vacant units divided by total housing units (%)"},"compare_metrics":{"price_momentum_yoy":"FHFA HPI year-over-year change (%)","gross_rental_yield":"gross rental yield proxy (%)","price_to_income":"price-to-income ratio (x, lower = more affordable)","median_home_value":"ACS median home value (USD)","median_gross_rent":"ACS median gross rent (USD/month)","median_household_income":"ACS median household income (USD)"},"fhfa_levels":["state","msa","usa_division","puerto_rico"],"sources":{"fhfa":{"attribution":"Source: U.S. Federal Housing Finance Agency, House Price Index (public domain)","license":"US-gov public domain","keyless":true,"enabled":true,"cache_ttl_seconds":86400,"note":"Keyless bulk CSV (hpi_master.csv). Levels: USA/Census Division, State (place_id=2-letter USPS), MSA (place_id=OMB CBSA code). Bulk-loaded in memory + TTL cache. ZIP/county HPI are separate developmental files -> deferred."},"acs":{"attribution":"Source: U.S. Census Bureau, American Community Survey 5-Year","license":"US-gov public domain","keyless":false,"enabled":true,"cache_ttl_seconds":86400,"note":"Free key (CENSUS_API_KEY, runtime-only). Levels: state / county / metropolitan statistical area (CBSA) / ZCTA (ZIP). The level source for price/rent/demography."},"fred":{"attribution":"Source: Federal Reserve Bank of St. Louis (FRED)","license":"St. Louis Fed terms (attribution)","keyless":false,"enabled":true,"cache_ttl_seconds":21600,"note":"Free key (FRED_API_KEY, runtime-only). US-NATIONAL housing context (mortgage rate, median sale price, starts, supply). Absent key => the national facet is silently omitted; the core (FHFA + ACS) still works."},"hud":{"attribution":"Source: U.S. Department of Housing and Urban Development (HUD USER)","license":"US-gov public domain","keyless":false,"enabled":true,"cache_ttl_seconds":86400,"note":"Free Bearer token (HUD_API_TOKEN, runtime-only). Fair Market Rents + Small Area FMR by bedroom count + ZIP<->CBSA<->county crosswalk. Absent token => the FMR facet is omitted; ACS median gross rent still covers the rent level."},"zillow":{"attribution":"Source: Zillow Research","license":"Zillow ToU (no commercial redistribution)","keyless":true,"enabled":false,"cache_ttl_seconds":86400,"note":"DEFERRED — ToU restricts commercial redistribution. Kept public-domain-only."}},"attribution":["Source: U.S. Federal Housing Finance Agency, House Price Index (public domain)","Source: U.S. Census Bureau, American Community Survey 5-Year","Source: Federal Reserve Bank of St. Louis (FRED)","Source: U.S. Department of Housing and Urban Development (HUD USER)"],"disclaimer":"Market indicators at an aggregate market-tier (state / metro / county / ZIP), fused from public government sources. Not an appraisal, not investment advice, and not a per-address valuation. US-only."}