One key, many sources
Use the same credential across supported operations and check capabilities for each source.
Calculate quarterly, yearly and five-year changes from a fresh official state index series. Get structured JSON through one RealtyCrawl API key.
Use an account-owned FHFA state market_id and the required series. A fresh official quarterly index supports derived quarter-over-quarter, year-over-year and annualized five-year changes. Missing comparison periods stay null; an index change is not an individual-home price change or forecast. This operation requests source data through its enabled adapter. Preserve observation times, source warnings and any idempotent-replay metadata. Check live capabilities for accepted inputs and availability before running your request.
Calculate quarterly, yearly and five-year changes from a fresh official state index series.
Example request
curl --request GET 'https://realtycrawl.dev/v1/markets/mkt_fhfa_state_CA/summary?series=purchase_only_sa' \
--header "x-api-key: $REALTYCRAWL_API_KEY" \
--header 'X-Max-Credits: 50'import os
import json
import requests
headers = {
"X-Max-Credits": "50"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]
response = requests.request("GET", "https://realtycrawl.dev/v1/markets/mkt_fhfa_state_CA/summary?series=purchase_only_sa",
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/summary?series=purchase_only_sa", {
method: "GET",
headers: {
"x-api-key": process.env.REALTYCRAWL_API_KEY,
...{
"X-Max-Credits": "50"
}
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());| 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. |
| series | Yes | series |
Use an account-owned FHFA state market_id and the required series. A fresh official quarterly index supports derived quarter-over-quarter, year-over-year and annualized five-year changes. Missing comparison periods stay null; an index change is not an individual-home price change or forecast.
The response includes a derived quarterly index-growth summary in data, plus source outcomes and request metadata. Explore the structure below before making a call.
{
"data": {
"market_id": "mkt_fhfa_state_CA",
"series": "purchase_only_sa",
"period": "1991-01-01",
"value": 100,
"unit": "index_1991_q1_100",
"frequency": "quarterly",
"changes": {
"quarter_over_quarter_percent": null,
"year_over_year_percent": null,
"five_year_annualized_percent": null
},
"origin": "derived_from_source_index",
"methodology": "Illustrative index summary. Comparison-period changes remain null when those index points are missing. Source: FHFA House Price Index®.",
"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.
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}/summaryKeep source collection behind a shared interface so you can focus on the product you’re building.
Use familiar HTTP requests, inspect a common schema, and connect the results to the tools your team already uses.
Use the same credential across supported operations and check capabilities for each source.
Keep base periods, seasonal adjustment, source attribution, methodology and retrieval times with your results.
Call the API with cURL, Python, TypeScript, or any backend that can send an HTTP request.
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'{
"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"
}Find answers to common questions about FHFA House Price Index requests, responses, and credits.
Contact usCreate 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 50 credits per successful call.
The JSON response contains a derived quarterly index-growth summary in data. The meta object carries request diagnostics and source outcomes. CSV/NDJSON exports contain data records with request and credit metadata in headers.
Use an account-owned FHFA state market_id and the required series. A fresh official quarterly index supports derived quarter-over-quarter, year-over-year and annualized five-year changes. Missing comparison periods stay null; an index change is not an individual-home price change or forecast.
Availability is operation-specific. Check /v1/meta/capabilities for the platform’s live status, accepted selectors, and markets. Unavailable requests are not charged.
RealtyCrawl is an independent real estate data API and is not affiliated with FHFA House Price Index.
Get your API key and start building a source-linked property workflow.
50 credits per successful call · Failed calls are refunded