500 trial credits · No credit card required

FHFA House Price Index Saved market definition API

Read the state-market definition saved by your account. Get structured JSON through one RealtyCrawl API key.

Use the market_id returned by this account’s FHFA market discovery. This one-credit retained read returns the market definition; use getMarketSeries for quarterly index points. This operation reads an account-owned retained observation. It does not refresh the source; inspect its collection time and retention limits. Check live capabilities for accepted inputs and availability before running your request.

FHFA House Price Index API

What can you do with the Saved market definition API?

Read the state-market definition saved by your account.

Example request

curl --request GET 'https://realtycrawl.dev/v1/markets/mkt_fhfa_state_CA' \
  --header "x-api-key: $REALTYCRAWL_API_KEY" \
  --header 'X-Max-Credits: 1'

import os
import json
import requests

headers = {
  "X-Max-Credits": "1"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]

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

const response = await fetch("https://realtycrawl.dev/v1/markets/mkt_fhfa_state_CA", {
  method: "GET",
  headers: {
    "x-api-key": process.env.REALTYCRAWL_API_KEY,
    ...{
      "X-Max-Credits": "1"
    }
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());

Parameters

Parameters for FHFA House Price Index Saved market definition API
Parameter	Required	Description
market_id	Yes	market_id
fields	No	Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.
format	No	Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Use the market_id returned by this account’s FHFA market discovery. This one-credit retained read returns the market definition; use getMarketSeries for quarterly index points.

Example response

What does the FHFA House Price Index Saved market definition API return?

The response includes a retained state-market definition 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 Saved market definition API work?

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

Method

GET

Response

JSON · CSV · NDJSON

GET /v1/markets/{market_id}

Why RealtyCrawl

Why use RealtyCrawl for FHFA House Price Index Saved market definition?

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.
Operation-specific source fields returned in a common JSON schema.
Source identifiers, timestamps, and completeness metadata stay with the result.
1 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 can I try the FHFA House Price Index Saved market definition API?

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

What does the Saved market definition API return?

The JSON response contains a retained state-market definition in data. The meta object carries request diagnostics and source outcomes. CSV/NDJSON exports contain data records with request and credit metadata in headers.

Where do I put the request parameters?

Use the market_id returned by this account’s FHFA market discovery. This one-credit retained read returns the market definition; use getMarketSeries for quarterly index points.

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.