# hmlr-price-paid (`charles986/hmlr-price-paid`) Actor Fetch UK house sold prices from HM Land Registry Price Paid Data. Search by postcode or address — returns price, date, property type, tenure and full address for every registered sale since 1995. For property investors, estate agents and researchers. No API key. England and Wales. - **URL**: https://apify.com/charles986/hmlr-price-paid.md - **Developed by:** [Charles](https://apify.com/charles986) (community) - **Categories:** Real estate, Developer tools - **Stats:** 2 total users, 1 monthly users, 71.4% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.01 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## HMLR Price Paid Data Fetches UK residential property sale history from the HM Land Registry Price Paid dataset. Search by postcode or address and get every registered transaction — price, date, property type, tenure, and full address. No API key required. **Data source:** Free official UK government open data (OGL v3). **Coverage:** England and Wales only. Scotland uses Registers of Scotland; Northern Ireland uses LPSNI. --- ### Sample output ```json { "record_type": "transaction", "transaction_id": "9B361207-056B-1904-E053-6B04A8C0EEB5", "price": 395000, "date": "Fri, 22 Nov 2019", "postcode": "M14 5QL", "paon": "63", "saon": null, "street": "DAISY BANK ROAD", "locality": null, "town": "MANCHESTER", "district": "MANCHESTER", "county": "GREATER MANCHESTER", "full_address": "63, DAISY BANK ROAD, MANCHESTER, MANCHESTER, GREATER MANCHESTER, M14 5QL", "property_type": "Semi-Detached", "property_type_code": "semi-detached", "tenure": "Freehold", "tenure_code": "freehold", "is_new_build": false } ```` *** ### Output fields #### Transaction records (`record_type: "transaction"`) | Field | Type | Description | |---|---|---| | `record_type` | string | Always `"transaction"` | | `transaction_id` | string | Unique HMLR transaction UUID | | `price` | integer | Sale price in GBP | | `date` | string | Transaction date as returned by HMLR (e.g. `"Fri, 22 Nov 2019"`) | | `postcode` | string | Full UK postcode | | `paon` | string | Primary addressable object name (house number or name) | | `saon` | string|null | Secondary addressable object name (flat number etc.), if present | | `street` | string | Street name | | `locality` | string|null | Locality, if recorded | | `town` | string | Town or city | | `district` | string | Local authority district | | `county` | string | County | | `full_address` | string | Constructed full address string | | `property_type` | string | Detached / Semi-Detached / Terraced / Flat/Maisonette / Other | | `property_type_code` | string | URI slug: `detached`, `semi-detached`, `terraced`, `flat-maisonette`, `other` | | `tenure` | string | Freehold / Leasehold | | `tenure_code` | string | `freehold` or `leasehold` | | `is_new_build` | boolean | True if the sale was a new build | #### INSPIRE polygon records (`record_type: "inspire_polygon"`) Returned when `includeInspirePolygons` is true and the postcode is provided. Each record is a registered title boundary from the HMLR INSPIRE Index. | Field | Type | Description | |---|---|---| | `record_type` | string | Always `"inspire_polygon"` | | `inspire_id` | string | INSPIRE feature ID | | `title_number` | string | Land Registry title number | | `tenure` | string | Freehold / Leasehold | | `property_address` | string|null | Associated property description | | `geometry_type` | string | GeoJSON geometry type (e.g. `"Polygon"`) | | `geometry` | string | GeoJSON geometry as a JSON string | > **Note:** INSPIRE polygon data may not be available from cloud environments due to government IP restrictions. When unavailable the actor skips silently and still returns all transaction records. *** ### Inputs | Field | Type | Required | Default | Description | |---|---|---|---|---| | `postcode` | string | one of | — | UK postcode, e.g. `M14 5QL` | | `address` | string | one of | — | Partial or full address, e.g. `63 Daisy Bank Road` | | `startDate` | string | no | — | Filter from date, format `YYYY-MM-DD` | | `endDate` | string | no | — | Filter to date, format `YYYY-MM-DD` | | `propertyType` | select | no | all | Property type filter | | `tenure` | select | no | all | Freehold or Leasehold | | `newBuildOnly` | boolean | no | false | Return new build transactions only | | `maxResults` | integer | no | 100 | Maximum transactions to return (up to 5,000) | | `includeInspirePolygons` | boolean | no | true | Also fetch HMLR INSPIRE property boundary polygons | At least one of `postcode` or `address` must be provided. *** ### Use cases - **Property research** — full sale history for a postcode or address, going back to 1995 - **Investment analysis** — price trends, comparable sales, buy-to-let yield estimation - **Stranded asset risk** — combine with EPC data to identify D/E/F/G-rated properties that will need upgrade before 2028 BTL regulation - **Area intelligence** — median prices, property type breakdown, market activity - **Data journalism** — academic and journalistic research on UK housing *** ### APIs used | API | URL | Key required | |---|---|---| | HMLR Price Paid REST | `landregistry.data.gov.uk/data/ppi/transaction-record.json` | No | | HMLR INSPIRE WFS | `inspire.landregistry.gov.uk/inspire/wfs` | No | | postcodes.io | `api.postcodes.io/postcodes` | No | *** ### Notes - **Registration lag:** New build prices may appear several months after exchange — HMLR registers on legal completion, not on exchange of contracts. - **England and Wales only:** Does not cover Scotland (Registers of Scotland) or Northern Ireland (LPSNI). - **Historical data:** The dataset goes back to January 1995 for residential properties. - **Additional Price Paid (APP) transactions** are included alongside standard transactions. These are sales that fall outside the standard residential categories (e.g. repossessions, right-to-buy). # Actor input Schema ## `postcode` (type: `string`): UK postcode to search (e.g. SW1A 1AA). At least one of postcode or address is required. ## `address` (type: `string`): Partial or full address to search (e.g. '10 Downing Street'). At least one of postcode or address is required. ## `startDate` (type: `string`): Filter transactions from this date. Format: YYYY-MM-DD. Leave blank for no lower limit. ## `endDate` (type: `string`): Filter transactions up to this date. Format: YYYY-MM-DD. Leave blank for today. ## `propertyType` (type: `string`): Filter by property type. Leave blank for all types. ## `tenure` (type: `string`): Filter by freehold or leasehold. Leave blank for all. ## `newBuildOnly` (type: `boolean`): If true, only return new build properties. ## `maxResults` (type: `integer`): Maximum number of transactions to return. Default 100. ## `includeInspirePolygons` (type: `boolean`): If true, fetches HMLR INSPIRE Index Polygons — the free property boundary shapes for all registered titles near the postcode. Returns GeoJSON geometry per title. ## Actor input object example ```json { "postcode": "GL15 4BA", "newBuildOnly": false, "maxResults": 100, "includeInspirePolygons": true } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("charles986/hmlr-price-paid").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("charles986/hmlr-price-paid").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call charles986/hmlr-price-paid --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=charles986/hmlr-price-paid", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "hmlr-price-paid", "description": "Fetch UK house sold prices from HM Land Registry Price Paid Data. Search by postcode or address — returns price, date, property type, tenure and full address for every registered sale since 1995. For property investors, estate agents and researchers. No API key. England and Wales.", "version": "0.0", "x-build-id": "T5lxgsUWJFL6TdQ3m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/charles986~hmlr-price-paid/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-charles986-hmlr-price-paid", "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/charles986~hmlr-price-paid/runs": { "post": { "operationId": "runs-sync-charles986-hmlr-price-paid", "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/charles986~hmlr-price-paid/run-sync": { "post": { "operationId": "run-sync-charles986-hmlr-price-paid", "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": { "postcode": { "title": "Postcode", "type": "string", "description": "UK postcode to search (e.g. SW1A 1AA). At least one of postcode or address is required.", "default": "GL15 4BA" }, "address": { "title": "Address string", "type": "string", "description": "Partial or full address to search (e.g. '10 Downing Street'). At least one of postcode or address is required." }, "startDate": { "title": "Start date", "type": "string", "description": "Filter transactions from this date. Format: YYYY-MM-DD. Leave blank for no lower limit." }, "endDate": { "title": "End date", "type": "string", "description": "Filter transactions up to this date. Format: YYYY-MM-DD. Leave blank for today." }, "propertyType": { "title": "Property type", "enum": [ "detached", "semi-detached", "terraced", "flat-maisonette", "other" ], "type": "string", "description": "Filter by property type. Leave blank for all types." }, "tenure": { "title": "Tenure", "enum": [ "freehold", "leasehold" ], "type": "string", "description": "Filter by freehold or leasehold. Leave blank for all." }, "newBuildOnly": { "title": "New builds only", "type": "boolean", "description": "If true, only return new build properties.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of transactions to return. Default 100.", "default": 100 }, "includeInspirePolygons": { "title": "Include property boundary polygons", "type": "boolean", "description": "If true, fetches HMLR INSPIRE Index Polygons — the free property boundary shapes for all registered titles near the postcode. Returns GeoJSON geometry per title.", "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 } } }, "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 } } } } } } } } } } ```