{ "openapi": "3.0.1", "info": { "title": "FHFA House Price Index API — US State, Metro & National HPI", "description": "FHFA House Price Index (HPI) as data: purchase-only, all-transactions and expanded-data indexes for the US, census divisions, states and 400+ metro areas, monthly and quarterly from 1975. Filter by place, level and year. No API key. Part of NexGen Signal — official-source data products", "version": "0.1", "x-build-id": "2imiAXu4Sc3yQrNxS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgensignal~us-fhfa-house-price-index-observations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgensignal-us-fhfa-house-price-index-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nexgensignal~us-fhfa-house-price-index-observations/runs": { "post": { "operationId": "runs-sync-nexgensignal-us-fhfa-house-price-index-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nexgensignal~us-fhfa-house-price-index-observations/run-sync": { "post": { "operationId": "run-sync-nexgensignal-us-fhfa-house-price-index-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "places": { "title": "Places", "type": "array", "description": "FHFA place IDs or exact place names, e.g. USA, CA (California), DV_PAC (Pacific Division), 10180 (Abilene, TX metro). Leave empty for all.", "default": [], "items": { "type": "string" } }, "placeNameContains": { "title": "Place name contains", "type": "array", "description": "Places whose name contains any of these words, e.g. Denver, Texas.", "default": [], "items": { "type": "string" } }, "levels": { "title": "Geography levels", "type": "array", "description": "USA or Census Division, State, MSA, Puerto Rico. Leave empty for all.", "default": [], "items": { "type": "string" } }, "hpiTypes": { "title": "Index types", "type": "array", "description": "traditional, non-metro, distress-free, developmental, manufactured.", "default": [], "items": { "type": "string" } }, "flavors": { "title": "Index flavors", "type": "array", "description": "purchase-only, all-transactions, expanded-data.", "default": [], "items": { "type": "string" } }, "frequencies": { "title": "Frequencies", "type": "array", "description": "monthly, quarterly.", "default": [], "items": { "type": "string" } }, "yearFrom": { "title": "Year from", "type": "integer", "description": "First year wanted, e.g. 2020." }, "yearTo": { "title": "Year to", "type": "integer", "description": "Last year wanted." }, "latestOnly": { "title": "Latest period only", "type": "boolean", "description": "One record per series (place, type, flavor, frequency): its newest period.", "default": false }, "order": { "title": "Order", "enum": [ "newest_first", "oldest_first" ], "type": "string", "description": "By period.", "default": "newest_first" }, "maxRecords": { "title": "Maximum records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many index values (each is charged once).", "default": 1000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }