{ "openapi": "3.0.1", "info": { "title": "UK House Sold Prices: Land Registry Data by Postcode", "description": "Search UK house sold prices from HM Land Registry Price Paid Data by postcode, street, town or county, with date, property type and new-build filters, median/average prices and a new-sales monitor. Beta.", "version": "0.2", "x-build-id": "5aEqadOhXNkyp4JRE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/transparent_meteorite~uk-land-registry-sold-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-transparent_meteorite-uk-land-registry-sold-prices", "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/transparent_meteorite~uk-land-registry-sold-prices/runs": { "post": { "operationId": "runs-sync-transparent_meteorite-uk-land-registry-sold-prices", "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/transparent_meteorite~uk-land-registry-sold-prices/run-sync": { "post": { "operationId": "run-sync-transparent_meteorite-uk-land-registry-sold-prices", "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": { "postcodes": { "title": "Postcodes", "type": "array", "description": "Full UK postcodes, e.g. M1 1AE. One search per postcode. If given, towns, districts and counties are ignored.", "items": { "type": "string" } }, "towns": { "title": "Towns", "type": "array", "description": "Town names as recorded by HM Land Registry, e.g. LEEDS. Exact match.", "items": { "type": "string" } }, "districts": { "title": "Districts", "type": "array", "description": "Local authority district names, e.g. CITY OF WESTMINSTER. Exact match.", "items": { "type": "string" } }, "counties": { "title": "Counties", "type": "array", "description": "County names, e.g. WEST YORKSHIRE or GREATER LONDON. Exact match.", "items": { "type": "string" } }, "street": { "title": "Street (optional)", "type": "string", "description": "Narrow the area to one street name, e.g. NEWTON STREET. Exact match, combined with the town, district, county or postcode." }, "yearsBack": { "title": "Years back", "minimum": 1, "maximum": 40, "type": "integer", "description": "Only sales in the last N years. Ignored if Date from is set." }, "dateFrom": { "title": "Date from (YYYY-MM-DD)", "type": "string", "description": "Earliest transfer date, e.g. 2024-01-01." }, "dateTo": { "title": "Date to (YYYY-MM-DD)", "type": "string", "description": "Latest transfer date." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat-maisonette", "otherPropertyType" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / maisonette", "Other" ] } }, "newBuild": { "title": "New builds", "enum": [ "any", "only", "exclude" ], "type": "string", "description": "Filter by the new-build flag.", "default": "any" }, "minPrice": { "title": "Min price (GBP)", "minimum": 0, "type": "integer", "description": "Optional lower price bound." }, "maxPrice": { "title": "Max price (GBP)", "minimum": 0, "type": "integer", "description": "Optional upper price bound." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap on sale records delivered (and charged) this run, split evenly across the places searched. Most recent first.", "default": 100 }, "includeStats": { "title": "Add sold-price statistics", "type": "boolean", "description": "Adds one free summary row per place: count, median, average, min, max and a breakdown by property type.", "default": true }, "monitorNewSales": { "title": "Monitor: only new sales since last run", "type": "boolean", "description": "Skip sales delivered in a previous run (tracked in a named key-value store). Schedule the actor daily or weekly to be told about new sales. A repeat run with nothing new delivers and charges nothing.", "default": false }, "stateStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that remembers delivered sales. Change it to keep separate monitors or reset it.", "default": "uk-sold-prices-seen" } } }, "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 } } } } } } } } } }