{ "openapi": "3.0.1", "info": { "title": "Rightmove Natural Language Property Search", "description": "🎉 FREE until 18 July 2026. Search Rightmove in plain English — AI parses your wishlist, searches UK listings, and returns scored, ranked matches with explanations of why each property fits. No API key needed.", "version": "0.1", "x-build-id": "oWqoebCbeGamIuSdb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stueyboy~rightmove-natural-language-property-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stueyboy-rightmove-natural-language-property-search", "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/stueyboy~rightmove-natural-language-property-search/runs": { "post": { "operationId": "runs-sync-stueyboy-rightmove-natural-language-property-search", "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/stueyboy~rightmove-natural-language-property-search/run-sync": { "post": { "operationId": "run-sync-stueyboy-rightmove-natural-language-property-search", "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": [ "query" ], "properties": { "query": { "title": "Natural Language Search Query", "type": "string", "description": "Describe what you're looking for in natural language. E.g. '2-bed Victorian flat in Hackney with balcony, near Overground, max £550k'" }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "Buy or rent?", "default": "BUY" }, "maxProperties": { "title": "Max Search Results", "minimum": 5, "maximum": 200, "type": "integer", "description": "Maximum property cards to fetch from search results.", "default": 20 }, "maxDetailPages": { "title": "Max Properties to Score", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum properties to fetch full details for and AI-score. Free until 18 July 2026; then $0.025 per AI-scored property (waived if you provide your own llmApiKey).", "default": 10 }, "minScore": { "title": "Minimum Match Score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only return properties scoring above this threshold (0-100).", "default": 50 }, "sortType": { "title": "Sort Order (1=cheapest, 2=priciest, 6=recent)", "minimum": 1, "maximum": 6, "type": "integer", "description": "1 = lowest price first, 2 = highest price first, 6 = most recent first", "default": 2 }, "useLlmScoring": { "title": "AI Scoring", "type": "boolean", "description": "AI-powered property matching with scores and match explanations. Works out of the box — no API key needed. FREE until 18 July 2026, then $0.025 per scored property. Turn off for basic search results only.", "default": true }, "llmApiKey": { "title": "Your Own LLM API Key (optional)", "type": "string", "description": "Optional: bring your own key (DeepSeek, OpenAI, or any OpenAI-compatible endpoint) and the $0.025 per-property scoring charge is waived — you pay your provider directly instead." }, "llmProvider": { "title": "LLM Provider", "enum": [ "deepseek", "openai", "custom" ], "type": "string", "description": "Which LLM provider to use. DeepSeek is cheapest, OpenAI works with existing keys, or set 'custom' for any compatible endpoint.", "default": "deepseek" }, "llmModel": { "title": "LLM Model (optional override)", "type": "string", "description": "Override the default model for your provider. Leave empty to use defaults (deepseek-chat / gpt-4o-mini)." }, "llmBaseUrl": { "title": "LLM Base URL (for custom provider)", "type": "string", "description": "OpenAI-compatible API base URL, e.g. https://api.example.com/v1. Only needed when llmProvider is 'custom'." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Rightmove blocks datacenter IPs — Apify residential proxies (RESIDENTIAL group, GB) are strongly recommended for reliable results." } } }, "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 } } } } } } } } } }