{ "openapi": "3.0.1", "info": { "title": "UK Sold House Price Stats by Postcode Area (HM Land Registry)", "description": "Area-level sold-price stats for England & Wales from official HM Land Registry Price Paid Data: median, mean, quartiles, sales volume, property-type mix, new-build and freehold share, and period change for any postcode district or sector. Aggregated only.", "version": "0.1", "x-build-id": "RSw9s3UEhHdxwyJxH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/owenryland~uk-sold-price-stats/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-owenryland-uk-sold-price-stats", "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/owenryland~uk-sold-price-stats/runs": { "post": { "operationId": "runs-sync-owenryland-uk-sold-price-stats", "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/owenryland~uk-sold-price-stats/run-sync": { "post": { "operationId": "run-sync-owenryland-uk-sold-price-stats", "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", "required": [ "areas" ], "properties": { "areas": { "title": "Postcode areas", "type": "array", "description": "Postcode districts (e.g. BB11, M20, SW1A), sectors (e.g. BB11 1) or full postcodes (e.g. BB11 1NL). England & Wales only. Max 50 per run.", "items": { "type": "string" } }, "dateFrom": { "title": "From date", "type": "string", "description": "Earliest completion date to include (YYYY-MM-DD).", "default": "2023-01-01" }, "dateTo": { "title": "To date", "type": "string", "description": "Latest completion date to include (YYYY-MM-DD). Leave empty for latest available." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "D = detached, S = semi-detached, T = terraced, F = flat/maisonette, O = other (often commercial or non-standard).", "items": { "type": "string", "enum": [ "D", "S", "T", "F", "O" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat/maisonette", "Other" ] }, "default": [ "D", "S", "T", "F" ] }, "groupBy": { "title": "Group results by", "enum": [ "year", "quarter", "month", "none" ], "type": "string", "description": "One row per area per period, plus an ALL row covering the whole date range.", "default": "year" }, "includeAdditionalTransactions": { "title": "Include additional price paid transactions (category B)", "type": "boolean", "description": "Category B covers repossessions, buy-to-lets bought by companies, transfers under a power of sale, etc. Off by default to match standard market sales (category A).", "default": false }, "addGeo": { "title": "Add location info (postcodes.io)", "type": "boolean", "description": "Adds latitude/longitude, local authority and country for each area using the free postcodes.io API.", "default": true } } }, "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 } } } } } } } } } }