Skip to main content
POST
Returns the percent change over the latest quarter, one year, five years and since 1991 in the index of home values of the US Federal Housing Finance Agency, with its rank, for a US state, a metropolitan area by name, or a census division or the nation. It gives percent changes for the latest quarter, not prices or index levels. This product uses FHFA Data but is neither endorsed nor certified by FHFA.

Authentication

Requires x402 payment in the payment-signature header.

Request Body

string
A two-letter US state code, or DC, for example MI. One of AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY.
string
Words of a metropolitan area name, for example Detroit or Ann Arbor. 2 to 80 characters.
string
A US census division, or united_states for the nation. One of united_states, new_england, middle_atlantic, east_north_central, west_north_central, south_atlantic, east_south_central, west_south_central, mountain, pacific.

Response (200 OK)

Top-level envelope: success (boolean) and data (object). All fields below are nested under data.
string
Durable job ID for audit and lookup
string
Job status: completed
string
Always place_home_price_index
object
The answer, described under Result below
object
Where the answer came from and when
string
The public body the data comes from. Always US Federal Housing Finance Agency.
string
public when the data comes from a public body, commercial otherwise
string
When the lookup was made, as an ISO 8601 UTC time
string | null
When the source says the fact was last updated, or null when the source gives no date

Result

Nested under data.result.
boolean
Whether at least one area matched.
string
Which list was read.
string
Which index the changes come from.
number
How many areas are in the source’s list, so the rank can be read.
object[]
The matching areas in rank order, up to 10.
string
The area’s name as the source writes it.
number | null
Rank by one-year change, 1 for the largest rise; null for the nation.
number | null
Percent change over the latest quarter. null when the source gives no value.
number | null
Percent change over one year. null when the source gives no value.
number | null
Percent change over five years. null when the source gives no value.
number | null
Percent change since 1991. null when the source gives no value.
boolean
True when more than 10 metros matched.
string
The notice the source requires every answer to carry.
See Pricing for this tool’s price. A wallet (x402) call receives it in the 402 quote before anything is charged; a call paid from prepaid credits is charged when the API accepts the request and answers 200.

Notes

  • Give exactly one of state, metro or division. metro matches a substring of the source’s metro name, case-insensitively; up to 10 matches are returned in rank order and more says whether others matched.
  • The answer does not name the quarter; the source publishes it quarterly.
  • State and division changes come from the purchase-only, seasonally adjusted index; metro changes from the all-transactions, not seasonally adjusted index. Rank 1 is the largest one-year rise among ranked_among areas.
  • A value the source leaves blank (too few sales) is null. A metro matching nothing gives found: false.
  • Results return inline. The finished job stays available at /v1/requests/{request_id}