{ "openapi": "3.0.1", "info": { "title": "Gumtree Listings Scraper", "description": "Gumtree Scraper SD - Gumtree Scraper is a classifieds data tool that extracts Gumtree UK search results and ad pages: title, price, location, postcode, seller type, posting time, images, attributes such as make, model and mileage, featured flag. No login.", "version": "1.0", "x-build-id": "OtaxMgTOhLv8ihNkj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~gumtree-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-gumtree-listings-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/neuro-scraper~gumtree-listings-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-gumtree-listings-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/neuro-scraper~gumtree-listings-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-gumtree-listings-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What you would type in the Gumtree search box, one per line. Example: bike", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Where to search: uk (whole country), a town or area such as manchester or london, or a postcode such as M1 1AE.", "default": "uk" }, "category": { "title": "Category", "type": "string", "description": "Gumtree category slug: all, cars, motorbikes-scooters, vans, for-sale, bicycles, flats-houses, jobs, pets, business-services, community ... (the last part of a category page's address, e.g. bicycles in gumtree.com/for-sale/sports-leisure-travel/bicycles). Price limits only apply with a specific category. With no search term, a category or location other than all / uk lists the newest ads there.", "default": "all" }, "startUrls": { "title": "Gumtree URLs (optional)", "type": "array", "description": "gumtree.com search or category result URLs copied from the browser (their filters are kept), e.g. https://www.gumtree.com/search?search_category=cars&search_location=manchester, and/or ad URLs such as https://www.gumtree.com/p///<adId>. Detected automatically. gumtree.com.au (Australia) is a different site and is not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum number of ads to return in total. Result pages are read one after another until this number is reached or Gumtree has no next page.", "default": 20 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "Safety limit on result pages read per search term or URL. Gumtree itself serves at most 50 pages (about 30 ads each) per search.", "default": 50 }, "sort": { "title": "Sort order (optional)", "enum": [ "relevance", "date", "price_lowest_first", "price_highest_first", "distance" ], "type": "string", "description": "Order of the results for search terms. Empty = Gumtree's default (most relevant for a keyword, newest when browsing a category). Featured ads always stay on top of each page." }, "distance": { "title": "Distance around the location (optional)", "enum": [ "1", "3", "5", "10", "15", "30", "50", "75", "100", "1000" ], "type": "string", "description": "Widen the search to this many miles around the location (Gumtree's \"+ N miles\" filter). Empty = the location's own area." }, "minPrice": { "title": "Minimum price in £ (optional)", "minimum": 0, "type": "integer", "description": "Only ads priced at or above this. Gumtree applies it when a specific category is set (e.g. bicycles); with category all it ignored it in our tests - the log says so when that happens." }, "maxPrice": { "title": "Maximum price in £ (optional)", "minimum": 0, "type": "integer", "description": "Only ads priced at or below this. Same rule as the minimum price." }, "includeDetails": { "title": "Open each ad page for full details", "type": "boolean", "description": "Adds the full description, all attributes, category path, seller name, rating, years on Gumtree, ad count and last-active time, and the ad creation time. Costs 1 extra request per result, so runs take longer. Seller phone numbers need a Gumtree login and are never collected.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Gumtree shows a JavaScript bot check to an IP address after a few quick keyword searches (3-9 search pages within minutes in our tests; category pages were far less affected). UK residential proxy is the default: each time the check appears the Actor continues on a new IP.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "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 } } } } } } } } } }