{ "openapi": "3.0.1", "info": { "title": "OnTheMarket Scraper — UK Properties for Sale & Rent, No Phones", "description": "UK property listings from OnTheMarket, for sale or to rent: price, bedrooms, type, tenure, address with coordinates, key features, added or reduced, and the agent. Details on request. No phones.", "version": "0.1", "x-build-id": "iRNohNicKHb4KKYaq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~onthemarket-properties/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-onthemarket-properties", "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/highbrow_fame~onthemarket-properties/runs": { "post": { "operationId": "runs-sync-highbrow_fame-onthemarket-properties", "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/highbrow_fame~onthemarket-properties/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-onthemarket-properties", "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": { "searchUrls": { "title": "Search links", "type": "array", "description": "Set up a search on onthemarket.com with all the filters you want and paste the address of the results page. For sale, to rent or new homes. One per line.", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Or search here without a link: towns, cities, districts or postcodes (Manchester, Canary Wharf, SW1A, M20). Add the county after a comma when a name is ambiguous (Newport, Gwent). The filters below apply.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional: only listings that mention all of these (garden, parking, garage).", "items": { "type": "string" } }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 1020, "type": "integer", "description": "OnTheMarket shows up to 1,020 listings (34 pages) per search.", "default": 200 }, "channel": { "title": "For sale or to rent", "enum": [ "buy", "rent", "new-homes" ], "type": "string", "description": "For the places above.", "default": "buy" }, "minPrice": { "title": "Min price (GBP)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "maxPrice": { "title": "Max price (GBP)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional. 0 = studios only." }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Optional.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "bungalows", "flats-apartments", "farms-land", "mobile-park-homes" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Bungalow", "Flats / apartments", "Farms / land", "Park homes" ] } }, "radius": { "title": "Radius", "enum": [ "0.25", "0.5", "1.0", "2.0", "3.0", "4.0", "5.0", "7.5", "10.0", "15.0", "20.0", "30.0", "40.0" ], "type": "string", "description": "Optional: include this many miles around the place." }, "addedWithin": { "title": "Added within", "enum": [ "24-hours", "3-days", "7-days" ], "type": "string", "description": "Optional: only listings added recently." }, "includeSold": { "title": "Include under offer / let agreed", "type": "boolean", "description": "Also list properties already under offer, sold STC or let.", "default": false }, "sortBy": { "title": "Sort", "enum": [ "recommended", "newest", "price-high", "price-low" ], "type": "string", "description": "For the places above.", "default": "recommended" }, "includeDetails": { "title": "Open every listing for its details", "type": "boolean", "description": "Adds the full description and features, council tax band, EPC rating, floor area, postcode, nearest stations, and for rentals the availability date, furnishing and deposit. One more page per listing, so slower.", "default": false }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches to work on at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only to try again after a network error: the first try goes out directly.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }