{ "openapi": "3.0.1", "info": { "title": "UK Land Registry Scraper — Price Paid & House Price Index", "description": "Scrape HM Land Registry Price Paid Data and UK House Price Index by postcode, town, district or region. Extract sale price, date, address, property type, tenure and new-build flag. No API key, no login.", "version": "1.0", "x-build-id": "1nhLm8yehsGL2gT13" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~uk-land-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-uk-land-registry-scraper", "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/logiover~uk-land-registry-scraper/runs": { "post": { "operationId": "runs-sync-logiover-uk-land-registry-scraper", "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/logiover~uk-land-registry-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-uk-land-registry-scraper", "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": { "mode": { "title": "Dataset", "enum": [ "price-paid", "house-price-index" ], "type": "string", "description": "Which HM Land Registry dataset to query. 'Price Paid Data' = individual property sales (England & Wales). 'House Price Index' = monthly average prices & indices per region.", "default": "price-paid" }, "searchBy": { "title": "Search Price Paid by", "enum": [ "postcode", "town", "district", "county" ], "type": "string", "description": "Which address field your queries match (Price Paid mode only). 'Postcode' expects a full postcode (e.g. PL6 6AA). 'Town' / 'District' / 'County' expect a place name (e.g. PLYMOUTH, CITY OF WESTMINSTER, DEVON).", "default": "town" }, "queries": { "title": "Queries", "type": "array", "description": "One or more values matching the 'Search by' field above. Each runs as a separate task. Examples: ['PLYMOUTH','EXETER'] for towns, or ['PL6 6AA','EX4 4QD'] for postcodes. Leave empty to demo with 'PLYMOUTH'.", "items": { "type": "string" } }, "dateFrom": { "title": "Date from", "type": "string", "description": "Only include transactions on/after this date (YYYY-MM-DD). In House Price Index mode this filters the reporting month. Leave empty for no lower bound.", "default": "" }, "dateTo": { "title": "Date to", "type": "string", "description": "Only include transactions on/before this date (YYYY-MM-DD). Leave empty for no upper bound.", "default": "" }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Minimum sale price in GBP (Price Paid mode). 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Maximum sale price in GBP (Price Paid mode). 0 = no maximum.", "default": 0 }, "propertyType": { "title": "Property type", "enum": [ "any", "detached", "semi-detached", "terraced", "flat-maisonette", "other" ], "type": "string", "description": "Filter Price Paid sales by property type.", "default": "any" }, "estateType": { "title": "Tenure", "enum": [ "any", "freehold", "leasehold" ], "type": "string", "description": "Filter by tenure / estate type.", "default": "any" }, "newBuildOnly": { "title": "New builds only", "type": "boolean", "description": "If enabled, only return newly-built properties (first sale). Price Paid mode only.", "default": false }, "categoryType": { "title": "Transaction category", "enum": [ "any", "standard", "additional" ], "type": "string", "description": "'Standard' = ordinary residential sales at full market value. 'Additional' = repossessions, buy-to-let, transfers to non-private individuals and other non-standard sales.", "default": "any" }, "sort": { "title": "Sort by", "enum": [ "newest", "oldest", "price-desc", "price-asc" ], "type": "string", "description": "Ordering of Price Paid results.", "default": "newest" }, "regions": { "title": "Regions (House Price Index)", "type": "array", "description": "Region slugs for House Price Index mode. Examples: 'england', 'wales', 'london', 'south-west', 'city-of-plymouth', 'united-kingdom'. Each is a separate task. Leave empty to demo with 'england'.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum total rows to collect across all tasks. Raise to pull everything for an area/region.", "default": 500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The Land Registry endpoint is open, so proxy is not required; enable Apify Proxy only if you run very large volumes." } } }, "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 } } } } } } } } } }