{ "openapi": "3.0.1", "info": { "title": "UK Property Deal Finder — BTL & Auction ROI, Cashflow, Payback", "description": "Ranked UK & German property investment deals: every listing scored for ROI, monthly cashflow, payback and best strategy (buy-to-let vs serviced accommodation) against real local rent comps. Includes live UK auction lots and an AI photo-condition read. Filter by area, budget, ROI and condition.", "version": "0.0", "x-build-id": "uawY8wUwblDsqjjVd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~uk-property-deal-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-uk-property-deal-finder", "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/memo23~uk-property-deal-finder/runs": { "post": { "operationId": "runs-sync-memo23-uk-property-deal-finder", "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/memo23~uk-property-deal-finder/run-sync": { "post": { "operationId": "run-sync-memo23-uk-property-deal-finder", "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": { "area": { "title": "Area", "type": "string", "description": "UK outcode (`M14`, `LS6`, `BS3`) or a whole postcode area (`M` = every Manchester outcode, `SW`, `LS`). German deals use a PLZ-3 Leitregion (`101` Berlin-Mitte, `802` München). Leave empty for everywhere." }, "market": { "title": "Market", "enum": [ "uk", "de", "" ], "type": "string", "description": "UK covers Rightmove listings plus UK auction lots (GBP). Germany covers ImmobilienScout24 (EUR).", "default": "uk" }, "listingSource": { "title": "Listing source", "enum": [ "", "portal", "auction" ], "type": "string", "description": "Auction lots price off a GUIDE, which is a marketing bracket rather than a sale price — lots routinely sell well above it, so an auction ROI is a ceiling, not an expectation. Portal listings are ordinary asking prices.", "default": "" }, "minRoiPct": { "title": "Minimum ROI (%)", "minimum": 0, "type": "integer", "description": "Annual cash-on-cash return. 8 means only deals returning 8%+ on the cash you put in." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Maximum asking / guide price, in the market's currency." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Defaults to 40,000 to filter out shared-ownership shares, plots and parking spaces." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Smallest number of bedrooms to include." }, "maxPaybackMonths": { "title": "Maximum payback (months)", "minimum": 0, "type": "integer", "description": "How long until the cash invested comes back out of cashflow." }, "strategy": { "title": "Strategy", "enum": [ "", "btl", "r2sa" ], "type": "string", "description": "Buy-to-let is a long let to a tenant. Serviced accommodation is short-let / nightly. Leave on Best to let each deal pick whichever returns more.", "default": "" }, "condition": { "title": "Property condition (from listing photos)", "enum": [ "", "refurbished", "cosmetic", "project" ], "type": "string", "description": "An AI vision pass over the listing photos: Refurbished = let-ready, Cosmetic = sound but dated, Project = major works (the BRRR / refurb shortlist). This is a shortlisting signal to decide what is worth viewing — it is NOT a refurb-cost estimate, because damp, wiring and roofs do not show up in photos. Only matches deals already triaged.", "default": "" }, "minRentConfidence": { "title": "Rent-figure confidence", "enum": [ "", "directional", "confident" ], "type": "string", "description": "How the rent behind the ROI was derived. Confident = median of 8+ real rental listings at the same outcode AND bedroom count. Directional = 3+ real comps. Estimate-backed deals can show inflated ROI, so tighten this when the numbers need to be trustworthy.", "default": "" }, "includeFlagged": { "title": "Include flagged deals", "type": "boolean", "description": "Off by default. Flagged deals are auction guide-price bait, shared-ownership shares, retirement/age-restricted units, and listings whose modelled return is implausible. Turn on only if you want to inspect them.", "default": false }, "maxItems": { "title": "Maximum deals", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many deals to return, ranked best-ROI-first. Free plans are capped at 25.", "default": 100 }, "includeSummary": { "title": "Add a coverage summary row", "type": "boolean", "description": "Appends one `rowType: \"summary\"` row: total deals, areas covered, average ROI by strategy and the best-returning areas. Useful for checking whether an empty result means 'no deals like that' or 'this area is not covered yet'.", "default": false } } }, "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 } } } } } } } } } }