{ "openapi": "3.0.1", "info": { "title": "UK Sold House Prices (HM Land Registry Price Paid Data)", "description": "Sold house prices for any postcode, postcode district, town, district or county in England and Wales from HM Land Registry's official Price Paid Data, with median, mean and quartile summaries per area. Open Government Licence, no scraping of property portals.", "version": "1.0", "x-build-id": "jpNy6maC0K1M5hqEx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mercury_ops~uk-sold-house-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mercury_ops-uk-sold-house-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/mercury_ops~uk-sold-house-prices/runs": { "post": { "operationId": "runs-sync-mercury_ops-uk-sold-house-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/mercury_ops~uk-sold-house-prices/run-sync": { "post": { "operationId": "run-sync-mercury_ops-uk-sold-house-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", "required": [ "areas" ], "properties": { "areas": { "title": "Areas", "type": "array", "description": "One per line. A full postcode (BA1 3JA), a postcode district/outcode (SW11), or a prefixed name: town:Bath, district:Wandsworth, county:Kent, locality:Timsbury, street:Royal Crescent, Bath. A plain word is treated as a town. Postcode sectors (SW11 1) aren't supported by the Land Registry query.", "items": { "type": "string" } }, "dateFrom": { "title": "Sold on or after", "type": "string", "description": "YYYY-MM-DD. Leave empty for the last 12 months. Data starts 1 Jan 1995 and lags about 1-2 months." }, "dateTo": { "title": "Sold on or before", "type": "string", "description": "YYYY-MM-DD. Leave empty for up to the latest data." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "other" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / maisonette", "Other" ] } }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Optional." }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Optional." }, "newBuild": { "title": "New build", "enum": [ "any", "new", "old" ], "type": "string", "description": "Filter on new-build sales.", "default": "any" }, "tenure": { "title": "Tenure", "enum": [ "any", "freehold", "leasehold" ], "type": "string", "description": "Filter on freehold or leasehold.", "default": "any" }, "includeAdditionalTransactions": { "title": "Include 'additional' transactions", "type": "boolean", "description": "Category B sales: repossessions, buy-to-lets bought by companies, transfers to non-private individuals. Off by default, as in Land Registry's own market statistics.", "default": false }, "maxSalesPerArea": { "title": "Max sales per area", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap on rows per area. If the cap is hit, the summary is flagged resultCapped; narrow the dates to get every sale.", "default": 500 }, "outputSales": { "title": "Output individual sales", "type": "boolean", "description": "One row per sale (billed per row).", "default": true }, "outputSummary": { "title": "Output area summary", "type": "boolean", "description": "One row per area with count, median, mean, quartiles, by-type and by-month medians.", "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 } } } } } } } } } }