{ "openapi": "3.0.1", "info": { "title": "OnTheMarket.com Scraper", "description": "Scrape OnTheMarket.com, the UK's agent-exclusive property portal. Price, beds, baths, property type, listing agency, GPS and images. With detail fetching: full description, EPC, key features, tenure, nearest stations and floor plans. Sale & rental. No personal contact data.", "version": "0.0", "x-build-id": "veByOooIZ3UsqsB38" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unfenced-group~onthemarket-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unfenced-group-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/unfenced-group~onthemarket-scraper/runs": { "post": { "operationId": "runs-sync-unfenced-group-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/unfenced-group~onthemarket-scraper/run-sync": { "post": { "operationId": "run-sync-unfenced-group-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": { "transaction": { "title": "Transaction", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Whether to scrape properties for sale or to rent.", "default": "for-sale" }, "propertyType": { "title": "Property type", "enum": [ "property", "houses", "flats", "new-homes", "land" ], "type": "string", "description": "Restrict results to one property type. 'All types' returns everything.", "default": "property" }, "location": { "title": "Location", "type": "string", "description": "City, town or area slug used in the OnTheMarket URL, e.g. 'london', 'manchester', 'birmingham', 'edinburgh', or a postcode district like 'se11'.", "default": "london" }, "addedToSite": { "title": "Added to site", "enum": [ "24-hours", "3-days", "7-days" ], "type": "string", "description": "Only return listings added to OnTheMarket within this window. Leave empty for no recency filter." }, "minPrice": { "title": "Min price (GBP)", "minimum": 0, "type": "integer", "description": "Minimum price in GBP. For rentals this is the monthly (pcm) amount." }, "maxPrice": { "title": "Max price (GBP)", "minimum": 0, "type": "integer", "description": "Maximum price in GBP. For rentals this is the monthly (pcm) amount." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "radius": { "title": "Radius (miles)", "minimum": 0, "type": "integer", "description": "Search radius in miles around the location centre." }, "fetchDetails": { "title": "Fetch listing details", "type": "boolean", "description": "Open each listing's detail page to add full description, EPC rating, key features, tenure, council tax, nearest stations, floor plans, brochures and virtual tours. Increases run time and cost (one extra request per listing).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return.", "default": 100 }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Paste one or more OnTheMarket.com search-result page URLs to scrape directly instead of building a search from the fields above.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } } } }, "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 } } } } } } } } } }