{ "openapi": "3.0.1", "info": { "title": "UK Property Sales - HM Land Registry Price Paid", "description": "Every residential property sale in England & Wales since 1995 (about 30 million transactions, OGL v3): price, transfer date, postcode and address, property type, new-build and tenure flags, Price Paid category. Search by postcode, town, price, date or type; aggregate with average prices.", "version": "0.0", "x-build-id": "Y26KOty4vedYxvXyc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-price-paid/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-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/j0401~uk-price-paid/runs": { "post": { "operationId": "runs-sync-j0401-uk-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/j0401~uk-price-paid/run-sync": { "post": { "operationId": "run-sync-j0401-uk-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": { "mode": { "title": "Mode", "enum": [ "", "search", "aggregate" ], "type": "string", "description": "search = transactions matching your filters. aggregate = one row per group with count and average price. Leave blank to auto-route: filters -> search, no filters -> aggregate." }, "postcode": { "title": "Postcode prefix", "type": "string", "description": "Full or partial postcode, e.g. \"SW1A 1AA\", \"SW1A\", \"SW1\", \"SW\" (area) or \"S\" (all S areas). Only postcodes present in England & Wales resolve." }, "town": { "title": "Town / city", "type": "string", "description": "Exact town/city as published by HM Land Registry, case-insensitive (e.g. \"LONDON\", \"LEEDS\", \"BRISTOL\")." }, "county": { "title": "County", "type": "string", "description": "Exact county as published, e.g. \"GREATER LONDON\", \"KENT\", \"WEST YORKSHIRE\"." }, "district": { "title": "District", "type": "string", "description": "Exact district/unitary authority as published, e.g. \"CAMDEN\", \"LEEDS\", \"CITY OF BRISTOL\"." }, "street": { "title": "Street contains", "type": "string", "description": "Case-insensitive substring of the street name, e.g. \"HIGH STREET\"." }, "transactionId": { "title": "Transaction ID", "type": "string", "description": "Exact Price Paid transaction GUID. Unindexed: scans all shards and can take several minutes." }, "propertyType": { "title": "Property type", "enum": [ "", "D", "S", "T", "F", "O" ], "type": "string", "description": "D = detached, S = semi-detached, T = terraced, F = flat/maisonette, O = other. Blank = all." }, "tenure": { "title": "Tenure", "enum": [ "", "F", "L", "U" ], "type": "string", "description": "F = freehold, L = leasehold, U = unknown. Blank = all." }, "newBuild": { "title": "New build", "enum": [ "", "Y", "N" ], "type": "string", "description": "Y = newly built property, N = established property. Blank = all." }, "ppdCategory": { "title": "Price Paid category", "enum": [ "", "A", "B" ], "type": "string", "description": "A = standard full-market-value sale; B = additional price paid entries (repossessions, buy-to-let / portfolio transfers, power-of-sale sales, etc.). Blank = all." }, "priceFrom": { "title": "Price at least (GBP)", "type": "number", "description": "Minimum sale price in pounds, e.g. 500000." }, "priceTo": { "title": "Price at most (GBP)", "type": "number", "description": "Maximum sale price in pounds, e.g. 2000000." }, "dateFrom": { "title": "Transferred from", "type": "string", "description": "Earliest transfer date (YYYY-MM-DD), inclusive." }, "dateTo": { "title": "Transferred to", "type": "string", "description": "Latest transfer date (YYYY-MM-DD), inclusive." }, "aggregate": { "title": "Aggregate instead of records", "type": "boolean", "description": "When on, returns one summary record per group with count and average price, instead of individual transactions.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "", "year", "propertyType", "tenure", "newBuild", "ppdCategory", "county", "district" ], "type": "string", "description": "year -> transfers by year; propertyType; tenure; newBuild; ppdCategory -> standard vs additional; county; district. Blank defaults to year." }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of search records pushed (0 = the default ceiling of 50, maximum 5000). Aggregate returns every group.", "default": 50 } } }, "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 } } } } } } } } } }