{ "openapi": "3.0.1", "info": { "title": "OnTheMarket Scraper — UK Property for Sale & Rent", "description": "Scrape UK property listings from OnTheMarket.com: price, bedrooms, bathrooms, address, postcode, coordinates, photos, agent name & phone, tenure, council tax, floorplans and description for homes for sale or to rent. Big searches split by price. Export CSV/JSON.", "version": "1.0", "x-build-id": "ToQSXpS7zDk02zbsP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~onthemarket-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-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/hipersoft~onthemarket-scraper/runs": { "post": { "operationId": "runs-sync-hipersoft-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/hipersoft~onthemarket-scraper/run-sync": { "post": { "operationId": "run-sync-hipersoft-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": { "searchType": { "title": "Buy or rent", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Homes for sale or homes to rent.", "default": "for-sale" }, "locations": { "title": "Locations", "type": "array", "description": "UK towns, cities, counties or postcode districts, e.g. London, Manchester, Bristol, Kent, SW11, M1. Each location is a separate search.", "items": { "type": "string" } }, "propertyType": { "title": "Property type", "enum": [ "property", "houses", "flats-apartments", "bungalows", "land" ], "type": "string", "description": "Type of property.", "default": "property" }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent (pcm) for rentals." }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent (pcm) for rentals." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only homes with at least this many bedrooms." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Only homes with at most this many bedrooms." }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "newest", "priceLow", "priceHigh" ], "type": "string", "description": "Order of results.", "default": "recommended" }, "includeUnderOffer": { "title": "Include under offer / let agreed", "type": "boolean", "description": "Also include homes that are under offer, sold STC or let agreed.", "default": false }, "includeDetails": { "title": "Full property details", "type": "boolean", "description": "Also collect the full description, postcode, tenure, council tax band, broadband speed, key features, all photos, floorplans, EPC chart, virtual tours, nearest stations and schools, and agent address and website. Slower.", "default": false }, "startUrls": { "title": "OnTheMarket search links", "type": "array", "description": "Optional. Paste OnTheMarket search-results links with your own filters. When set, the search fields above are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Stop after this many listings. 0 means no limit.", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not required for normal use.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }