{ "openapi": "3.0.1", "info": { "title": "Gumtree Property Scraper", "description": "Scrape public Gumtree UK property, room and flatshare listings from filtered search URLs. Extract rents, locations, descriptions, images, seller details and property attributes for datasets, APIs, monitoring and AI-agent workflows.", "version": "1.0", "x-build-id": "mPgfCcViVw1AxPhTQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vivid-softwares~gumtree-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vivid-softwares-gumtree-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/vivid-softwares~gumtree-scraper/runs": { "post": { "operationId": "runs-sync-vivid-softwares-gumtree-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/vivid-softwares~gumtree-scraper/run-sync": { "post": { "operationId": "run-sync-vivid-softwares-gumtree-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Gumtree property search or category pages, in any property category: for sale, to rent, to share, home swap, commercial, parking & garages, international, holiday rentals or property wanted. Both forms work, e.g. https://www.gumtree.com/flats-houses/property-for-sale/uk/esher and https://www.gumtree.com/search?search_category=property-to-rent&search_location=london. Every results page is scraped; listings from outside your search are left out.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "How many results pages to scrape for each start URL. Leave at 0 to scrape every page. Pagination always stops where Gumtree switches to \"Results from outside your search\", and those listings are never included.", "default": 0 }, "includeListingDetails": { "title": "Open each listing page (full description and seller name)", "type": "boolean", "description": "On: every listing's own page is opened for the full description and the seller's name. Off: much faster (about one request per results page instead of one per listing). Everything else still comes from the search results, including price, photos, posted date, attributes and whether the seller's phone number is available; description is then Gumtree's first ~250 characters and seller_name is N/A.", "default": true }, "includePhoneNumbers": { "title": "Include seller phone numbers", "type": "boolean", "description": "Put the seller's phone number in phone_number when the listing has one (on Gumtree it sits behind the Reveal button). Off: phone_number only says whether a number is available. Phone numbers are personal data - make sure your use complies with UK GDPR and Gumtree's terms.", "default": false }, "maxConcurrency": { "title": "Listing pages opened at once", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many listing pages are fetched in parallel when 'Open each listing page' is on. Higher is faster but puts more load on Gumtree.", "default": 10 }, "includeDuplicates": { "title": "Include Duplicates", "type": "boolean", "description": "Whether to include duplicate listings in the output. When false, listings seen in previous runs are automatically skipped.", "default": false }, "convertPwToPm": { "title": "Convert Weekly to Monthly Prices", "type": "boolean", "description": "Whether to convert weekly prices (pw) to monthly prices (pm) by multiplying by 4.33. This helps normalize pricing across different listing formats.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the scraper to avoid IP blocking", "default": {} } } }, "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 } } } } } } } } } }