{ "openapi": "3.0.1", "info": { "title": "OnTheMarket Scraper", "description": "[💰 $1.7 / 1K] Extract UK property listings from OnTheMarket — for sale, to rent, and new homes. Search by location or paste URLs to get price, address, bedrooms, bathrooms, features, photos, agent contacts, and map coordinates.", "version": "1.0", "x-build-id": "78PJ8RuaTo6lDKfzI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~onthemarket-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-onthemarket-com-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/solidcode~onthemarket-com-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-onthemarket-com-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/solidcode~onthemarket-com-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-onthemarket-com-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": { "listingType": { "title": "Listing Type", "enum": [ "for-sale", "to-rent", "new-homes" ], "type": "string", "description": "What kind of listings to find: properties for sale, properties to rent, or new-build homes. Only applies to Search Locations below — ignored when using Start URLs (the URL decides its own type)." }, "searchLocations": { "title": "Search Locations", "type": "array", "description": "Towns, cities, postcodes, or areas to search, e.g. \"London\", \"Manchester\", or \"SW1A 1AA\". One search runs per location. Leave empty if you are using Start URLs.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste OnTheMarket URLs directly — search results, category pages, or individual listing pages. Any filters in the URL are applied automatically. When provided, these override Search Locations and the Search Filters below.", "items": { "type": "string" } }, "radius": { "title": "Search Radius", "enum": [ "this-area-only", "0.25", "0.5", "1", "3", "5", "10", "15", "20", "30", "40" ], "type": "string", "description": "Expand each search to include surrounding areas. Only applies to Search Locations." }, "minPrice": { "title": "Minimum Price (£)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this price. For rentals this is the monthly amount. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum Price (£)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this price. For rentals this is the monthly amount. Leave empty for no maximum." }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include listings with at least this many bedrooms. Leave empty for any." }, "maxBedrooms": { "title": "Maximum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include listings with at most this many bedrooms. Leave empty for any." }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Limit results to one or more property types. Leave empty to include all types.", "items": { "type": "string", "enum": [ "houses", "flat", "detached", "semi-detached", "terraced", "bungalows", "town-house", "cottage", "character-property", "mews", "land", "farms-land", "mobile-park-homes" ], "enumTitles": [ "Houses", "Flats / Apartments", "Detached", "Semi-detached", "Terraced", "Bungalows", "Town houses", "Cottages", "Character properties", "Mews", "Land", "Farms / Land", "Mobile / park homes" ] } }, "addedToSite": { "title": "Added to Site", "enum": [ "anytime", "24-hours", "3-days", "7-days" ], "type": "string", "description": "Only include listings added to OnTheMarket within this time window." }, "rentalLength": { "title": "Tenancy Length", "enum": [ "any", "short-term", "long-term" ], "type": "string", "description": "For To Rent searches only — filter by short-term or long-term tenancies. Ignored for For Sale and New Homes." }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect across all searches and URLs. Set to 0 for unlimited. OnTheMarket returns up to ~1,000 listings per individual search — narrow your filters (price, bedrooms, property type) or split a large area into smaller locations to go deeper. Tip: start with 50-200 to test, then increase.", "default": 200 } } }, "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 } } } } } } } } } }