{ "openapi": "3.0.1", "info": { "title": "UK Property Sale Comps", "description": "Retrieve bounded HM Land Registry residential sales for permitted residential-price-information use only.", "version": "0.1", "x-build-id": "BXoKGd1KQpKgzArnS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~uk-property-sale-comps/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-uk-property-sale-comps", "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/zinin~uk-property-sale-comps/runs": { "post": { "operationId": "runs-sync-zinin-uk-property-sale-comps", "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/zinin~uk-property-sale-comps/run-sync": { "post": { "operationId": "run-sync-zinin-uk-property-sale-comps", "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": [ "postcodes", "soldFrom", "soldTo", "propertyTypes", "newBuild", "maxResults", "includePaonSaon" ], "properties": { "postcodes": { "title": "Full England/Wales postcodes", "minItems": 1, "maxItems": 5, "uniqueItems": true, "type": "array", "description": "One to five exact full England/Wales postcodes. Only these literals enter a fixed SPARQL template; no URL, query, proxy, browser, or LLM can be selected.", "items": { "type": "string", "minLength": 5, "maxLength": 8, "pattern": "^[A-Za-z0-9 ]+$" }, "default": [ "PL6 8RU" ] }, "soldFrom": { "title": "Sold from", "pattern": "^(?:(?!0000)(?:[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|02-(?:0[1-9]|1[0-9]|2[0-8])))|(?:[0-9]{2}(?:0[48]|[2468][048]|[13579][26])|(?:0[48]|[2468][048]|[13579][26])00)-02-29)$", "type": "string", "description": "First sale date, inclusive, as a real Gregorian YYYY-MM-DD date.", "default": "2022-01-01" }, "soldTo": { "title": "Sold to", "pattern": "^(?:(?!0000)(?:[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|02-(?:0[1-9]|1[0-9]|2[0-8])))|(?:[0-9]{2}(?:0[48]|[2468][048]|[13579][26])|(?:0[48]|[2468][048]|[13579][26])00)-02-29)$", "type": "string", "description": "Last sale date, inclusive, as a real Gregorian YYYY-MM-DD date.", "default": "2026-08-31" }, "propertyTypes": { "title": "Property types", "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Optional closed property-type subset. Empty means all documented types.", "items": { "type": "string", "enum": [ "DETACHED", "SEMI_DETACHED", "TERRACED", "FLAT_MAISONETTE", "OTHER" ] }, "default": [] }, "newBuild": { "title": "New-build filter", "enum": [ "ANY", "YES", "NO" ], "type": "string", "description": "Include any sales, new builds only, or non-new-build sales only.", "default": "ANY" }, "maxResults": { "title": "Maximum comparable sales", "minimum": 1, "maximum": 100, "type": "integer", "description": "Deliver at most one to 100 complete factual sale rows after every source response validates. Under pay-per-event pricing, each safely persisted row maps to one result-found event.", "default": 25 }, "includePaonSaon": { "title": "Include property object names", "type": "boolean", "description": "Include PAON/SAON object-name facts when present. This never authorizes direct marketing, contact enrichment, identity inference, lead generation, or eligibility decisions.", "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 } } } } } } } } } }