{ "openapi": "3.0.1", "info": { "title": "UK Sold Property Prices — Land Registry & House Price Index", "description": "Sold house prices by postcode, street, town, or district from official HM Land Registry data. Monitor new sales on a schedule, pull a property's full sale history, and get monthly average-price statistics. No key, no scraping, no proxies.", "version": "0.0", "x-build-id": "wo2xqJZSYCXxG1zei" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaz_kakyo~uk-property-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaz_kakyo-uk-property-data", "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/kaz_kakyo~uk-property-data/runs": { "post": { "operationId": "runs-sync-kaz_kakyo-uk-property-data", "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/kaz_kakyo~uk-property-data/run-sync": { "post": { "operationId": "run-sync-kaz_kakyo-uk-property-data", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "sold-prices", "new-sales-monitor", "property-history", "area-stats" ], "type": "string", "description": "All modes are keyless — official HM Land Registry open data. `sold-prices` searches transactions by area; `new-sales-monitor` returns recent sales for scheduled runs; `property-history` returns every recorded sale of one property; `area-stats` returns monthly UK House Price Index figures.", "default": "sold-prices" }, "postcodes": { "title": "Postcodes (exact)", "type": "array", "description": "Full postcodes, e.g. `SW11 5HY`. Used by `sold-prices` and (single entry) `property-history`.", "items": { "type": "string" } }, "postcodeDistrict": { "title": "Postcode district (prefix)", "type": "string", "description": "Postcode district or sector prefix, e.g. `SW11` or `BS3` — matches every postcode in the district. Used by `sold-prices` and `new-sales-monitor`. District searches default to the last 5 years unless `fromDate` is set." }, "town": { "title": "Town / city", "type": "string", "description": "Town or city name as recorded by Land Registry, e.g. `BATH`, `MANCHESTER`." }, "district": { "title": "Local authority district", "type": "string", "description": "E.g. `CITY OF WESTMINSTER`, `BATH AND NORTH EAST SOMERSET`." }, "county": { "title": "County", "type": "string", "description": "E.g. `GREATER LONDON`, `DEVON`." }, "houseNumber": { "title": "House number / name (property history)", "type": "string", "description": "The PAON for `property-history` mode — house number (`8`) or name (`ROSE COTTAGE`). Combine with one entry in Postcodes." }, "fromDate": { "title": "From date", "type": "string", "description": "Earliest transaction date, `YYYY-MM-DD`. Price Paid data goes back to 1995." }, "toDate": { "title": "To date", "type": "string", "description": "Latest transaction date, `YYYY-MM-DD`." }, "sinceDays": { "title": "Window in days (monitor)", "minimum": 1, "maximum": 730, "type": "integer", "description": "`new-sales-monitor`: how many days back to look (default 45). Land Registry publishes monthly, so schedule monthly and dedupe by `transactionId`.", "default": 45 }, "minPrice": { "title": "Minimum price (GBP)", "minimum": 0, "type": "integer", "description": "Only transactions at or above this price." }, "maxPrice": { "title": "Maximum price (GBP)", "minimum": 0, "type": "integer", "description": "Only transactions at or below this price." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Filter to: `detached`, `semi-detached`, `terraced`, `flat`, `other`. Empty = all types.", "items": { "type": "string" } }, "newBuildOnly": { "title": "New builds only", "type": "boolean", "description": "Only newly built properties.", "default": false }, "region": { "title": "UKHPI region (area stats)", "type": "string", "description": "`area-stats` region slug, e.g. `united-kingdom`, `england`, `city-of-westminster`, `bath-and-north-east-somerset`. Find slugs at landregistry.data.gov.uk/app/ukhpi." }, "statsFrom": { "title": "Stats from month", "type": "string", "description": "`area-stats`: first month, `YYYY-MM`. Defaults to 12 months before the latest published month." }, "statsTo": { "title": "Stats to month", "type": "string", "description": "`area-stats`: last month, `YYYY-MM`. UKHPI publishes with a ~2 month lag." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum records returned per run. Keeps cost predictable.", "default": 100 } } }, "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 } } }, "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 } } } } } } } } } }