{ "openapi": "3.0.1", "info": { "title": "OnTheMarket Scraper | Fast & Reliable", "description": "Scrape UK property listings from OnTheMarket (rentals, for-sale, and new homes) into clean, structured outputs. Get prices, addresses, property type, beds/baths, photos, features, agent details, and coordinates. Great for market research, price tracking, inventory monitoring and lead gen.", "version": "1.0", "x-build-id": "jjlZRmtAA5Ma9S8gf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~onthemarket-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-onthemarket-scraper", "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/fatihtahta~onthemarket-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-onthemarket-scraper", "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/fatihtahta~onthemarket-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-onthemarket-scraper", "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": { "type": { "title": "Listing Type", "enum": [ "rentals", "for-sale", "new-homes" ], "type": "string", "description": "Choose the type of listings you want to search for.", "default": "rentals" }, "queries": { "title": "πŸ” Search Locations", "type": "array", "description": "Enter one or more location queries such as a city, postcode, or neighbourhood. Use this if you don’t have URLs yet.", "items": { "type": "string" } }, "radius": { "title": "πŸ“ Search Radius", "enum": [ "this-area-only", "quarter-mile", "half-mile", "1-mile", "2-miles", "3-miles", "4-miles", "5-miles", "7-5-miles", "10-miles", "15-miles", "20-miles", "30-miles", "40-miles" ], "type": "string", "description": "Limit results to a radius around the searched location.", "default": "this-area-only" }, "minPrice": { "title": "πŸ’· Minimum Price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this value." }, "maxPrice": { "title": "πŸ’· Maximum Price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this value." }, "minBedrooms": { "title": "πŸ›οΈ Minimum Number of Bedrooms (0 to 10 β€” 0 for studio)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Set the minimum bedrooms to include in results." }, "maxBedrooms": { "title": "πŸ›οΈ Maximum Number of Bedrooms (0 to 10)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Set the maximum bedrooms to include in results." }, "rentalLength": { "title": "πŸ“† Rental Length (for rental searches only)", "enum": [ "short-term", "long-term" ], "type": "string", "description": "Limit rentals to short-term or long-term lets." }, "propertyTypes": { "title": "🏠 Property Types", "uniqueItems": true, "type": "array", "description": "Select one or more property types to include.", "items": { "type": "string", "enum": [ "bungalows", "detached", "farms-land", "flats-apartments", "mobile-park-homes", "semi-detached", "terraced" ], "enumTitles": [ "🌿 Bungalows – Single-storey residential homes", "🏑 Detached Houses – Single-family residential homes", "🚜 Farms & Land – Agricultural property & vacant land", "🏒 Flats & Apartments – Homes in multi-unit buildings", "🚐 Mobile Park Homes – Prefabricated homes in parks", "🏠 Semi-Detached Houses – Homes sharing one wall", "🏘️ Terraced Houses – Row houses with shared walls" ] } }, "addedToSite": { "title": "πŸ•’ Added to Site", "enum": [ "24-hours", "3-days", "7-days" ], "type": "string", "description": "Only include listings added recently." }, "startUrls": { "title": "πŸ”— Start URLs (Search results, category pages, or individual listings)", "type": "array", "description": "Paste one or more OnTheMarket URLs to scrape directly. Use search results, category pages, or individual listing pages to control exactly what is collected.", "items": { "type": "string" } }, "limit": { "title": "πŸ“¦ Maximum Listings to Save (per query)", "minimum": 10, "type": "integer", "description": "Stop after this many listings per query. Use a smaller number for quick sampling or a larger number for deeper coverage.", "default": 50000 }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy Configuration (recommended for stability)", "type": "object", "description": "Optional connection settings for reliability at scale.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }