{ "openapi": "3.0.1", "info": { "title": "OpenRent Scraper [Only $0.5/1KšŸ’°] | UK Rentals | Property Data", "description": "Scrape OpenRent UK rental listings ā€” rent PCM/PW, deposit, EPC, landlord response and photos. Cheapest on the Store: $0.0005 per listing detail, $0.00015 per search card.", "version": "0.9", "x-build-id": "D2JDNw4PIoxmpr3R2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~openrent-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-openrent-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/ahmed_jasarevic~openrent-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-openrent-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/ahmed_jasarevic~openrent-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-openrent-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "OpenRent search URLs (https://www.openrent.co.uk/properties-to-rent/), property detail URLs (https://www.openrent.co.uk/property-to-rent///) or listing sitemap URLs. Search pages are paginated and their listings are expanded into full detail records; detail URLs are parsed directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locations": { "title": "Locations", "type": "string", "description": "Comma-separated location names or postcodes to build search URLs from, e.g. \"manchester, birmingham, BS1 4QA\". A URL slug is generated for each. Ignored if Start URLs are supplied." }, "propertyType": { "title": "Property type filter", "type": "string", "description": "Optional OpenRent path filter appended to generated location search URLs." }, "includeSitemapUrls": { "title": "Also crawl listing sitemaps", "type": "boolean", "description": "Adds https://www.openrent.co.uk/sitemap-listings-1.xml and -2.xml (50,000 listing URLs in total) as start URLs. Useful for broad national coverage of already-listed properties.", "default": false }, "sitemapCount": { "title": "Number of listing sitemaps", "type": "integer", "description": "How many of the listing sitemaps to read (1 or 2).", "default": 2 }, "maxItems": { "title": "Max listings", "type": "integer", "description": "Maximum number of full property detail records to produce, and the only item limit ā€” the crawler pages through search results (?skip=N, 20 per page) until this many listings are collected or the results run out. Free accounts are capped at 10 regardless of this value.", "default": 50 }, "maxRequestsPerStartUrl": { "title": "Max detail requests per start URL", "type": "integer", "description": "Safety cap on how many detail pages are fetched from a single search URL.", "default": 60 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "On (default): visits every property page and outputs one complete listing per row, billed as a 'Listing detail'. Off: never opens the property pages and outputs only the lightweight search-result cards (title, rent pcm/pw, badges, thumbnail, distance), billed as a 'Search card' at a lower price. Landlord, EPC, transport and full photo data are missing when off.", "default": true }, "maxCrawlDepth": { "title": "Max crawl depth", "type": "integer", "description": "Crawlee crawl depth. 0 = only the start URLs, 1 = also search results, 2 = also detail pages.", "default": 2 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "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 } } } } } } } } } }