100 trial credits · No credit card required

FHFA House Price Index Search markets API

Search official FHFA Purchase-Only state HPI markets. platforms=["fhfa"], query matches state name or two-letter code, or US text/source_region location (region_id=state code); choose exactly query or location. 50 states and DC only. Limit 1–51 (default20), alphabetical state-name order, no cursor. Each successful live dataset request costs 50 credits. Returned market IDs are account-owned selectors retained 24 hours. No portal, national or metropolitan geography is inferred. Requires separate FHFA runtime enablement. Source: FHFA House Price Index®. Get structured JSON through one RealtyCrawl API key.

Get an API key View documentation

Use platforms=[fhfa] and a state name/code query, or one US location selector. Query and location are exclusive. Check live capabilities for accepted inputs and availability before running your request.

FHFA House Price Index API

What can you do with the Search markets API?

Example request

curl --request POST 'https://realtycrawl.dev/v1/markets/search' \
  --header "x-api-key: $REALTYCRAWL_API_KEY" \
  --header 'X-Max-Credits: 50' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: YOUR_IDEMPOTENCY_KEY' \
  --data '{"platforms":["fhfa"],"query":"California"}'

import os
import json
import requests

headers = {
  "X-Max-Credits": "50",
  "Content-Type": "application/json",
  "Idempotency-Key": "YOUR_IDEMPOTENCY_KEY"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]
payload = json.loads("{\"platforms\":[\"fhfa\"],\"query\":\"California\"}")

response = requests.request("POST", "https://realtycrawl.dev/v1/markets/search",
    headers=headers, json=payload, timeout=60)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

const response = await fetch("https://realtycrawl.dev/v1/markets/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REALTYCRAWL_API_KEY,
    ...{
      "X-Max-Credits": "50",
      "Content-Type": "application/json",
      "Idempotency-Key": "YOUR_IDEMPOTENCY_KEY"
    }
  },
  body: JSON.stringify({
    "platforms": [
      "fhfa"
    ],
    "query": "California"
  })
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());

Parameters

Parameters for FHFA House Price Index Search markets API
Parameter	Required	Description
platforms	Yes	platforms
query	Yes	query
location	No	A location selector supported by this source: text, postal code, bounding box, radius, polygon, or source region. Check capabilities before choosing one.
limit	No	Requested result count, from 1 to 100. The default is 20; source limits may also apply.
cursor	No	The continuation cursor from a preceding response, for sources that support pagination.

Use platforms=[fhfa] and a state name/code query, or one US location selector. Query and location are exclusive.

Example response

What does the FHFA House Price Index Search markets API return?

The response includes an array of state markets in data, plus source outcomes and request metadata. Explore the structure below before making a call.

Illustrative response

{
  "data": [
    {
      "id": "mkt_fhfa_state_CA",
      "name": "California",
      "country": "US",
      "geography_type": "state",
      "source": {
        "platform": "fhfa",
        "native_id": "CA",
        "provider": "example",
        "observed_at": "2026-01-01T12:00:00Z",
        "access_class": "modeled"
      }
    }
  ],
  "meta": {
    "request_id": "example_request",
    "schema_version": "1.0.0",
    "generated_at": "2026-01-01T12:00:00Z",
    "completeness": "unknown",
    "sources": []
  }
}

Schema example with placeholder values; not a live source result. Actual fields, values, and completeness vary by source and request.

API details

How does the FHFA House Price Index Search markets API work?

Send a POST request with your API key and accepted inputs. RealtyCrawl returns structured JSON and preserves the source context for your application.

Method

POST

Response

JSON

POST /v1/markets/search

Why RealtyCrawl

Why use RealtyCrawl for FHFA House Price Index state markets?

Keep source collection behind a shared interface so you can focus on the product you’re building.

One API key for supported operations across the RealtyCrawl catalog.
State identity, quarterly index units and methodology returned in a common JSON schema.
Source identifiers, timestamps, and completeness metadata stay with the result.
50 credits per successful call, with failed calls refunded.

Developer first

How do you bring real estate data into your app?

Use familiar HTTP requests, inspect a common schema, and connect the results to the tools your team already uses.

One key, many sources

Use the same credential across supported operations and check capabilities for each source.

Property data with context

Keep base periods, seasonal adjustment, source attribution, methodology and retrieval times with your results.

Your language, your workflow

Call the API with cURL, Python, TypeScript, or any backend that can send an HTTP request.

PythonTypeScript{ }cURL

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'zillow'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'redfin'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'realtor'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'rightmove'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'idealista'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'

Capability excerpt · illustrative

{
  "platform": "zillow",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "redfin",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "realtor",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "rightmove",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "GB"
  ],
  "execution": "sync"
}

{
  "platform": "idealista",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "ES"
  ],
  "execution": "sync"
}

ZillowRedfinRealtor.comRightmoveIdealistaBrowse the platform catalog

FAQ

Have a question?
We got answers

Find answers to common questions about FHFA House Price Index requests, responses, and credits.

How do I get FHFA House Price Index state markets for a test?

Create an account for 100 trial credits, check live capabilities for FHFA House Price Index, and use the example request above with your API key. This operation lists 50 credits per successful call.

What does the Search markets API return?

an array of state markets in data, with state, index and methodology and source fields. The meta object includes request diagnostics and source outcomes. Fields depend on what the source publishes.

Where do I put the request parameters?

Use platforms=[fhfa] and a state name/code query, or one US location selector. Query and location are exclusive.

Is this endpoint available for every market?

Availability is operation-specific. Check /v1/meta/capabilities for the platform’s live status, accepted selectors, and markets. Unavailable requests are not charged.

Is this an official FHFA House Price Index endpoint?

RealtyCrawl is an independent real estate data API and is not affiliated with FHFA House Price Index.