{ "openapi": "3.0.1", "info": { "title": "Gumtree Scraper — UK Listings, Prices & New Ads Alerts", "description": "Gumtree UK listings for any search: title, price, town, date, seller type, photo and a description snippet. Run it again or on a schedule to get only the new listings and the price drops since the last run. Keywords or gumtree.com URLs. No login.", "version": "0.1", "x-build-id": "u2YPFzbRPMcP2tNQm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northbell~gumtree-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northbell-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/northbell~gumtree-scraper/runs": { "post": { "operationId": "runs-sync-northbell-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/northbell~gumtree-scraper/run-sync": { "post": { "operationId": "run-sync-northbell-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": [ "searches" ], "properties": { "searches": { "title": "Searches", "type": "array", "description": "One search per line: a keyword (iphone 15, mountain bike, sofa) or a gumtree.com search or category link copied from your browser. A link keeps its own filters and sort order (if it has none, 'Sort by' below is added); the other settings apply to keywords.", "items": { "type": "string" } }, "location": { "title": "Location (optional)", "type": "string", "description": "A UK town, city or region as it appears in gumtree.com addresses: london, manchester, glasgow, leeds, edinburgh. Empty = the whole UK. Applies to keyword searches. A name Gumtree does not know gives an error row instead of UK-wide results." }, "distance": { "title": "Extra distance around the location", "enum": [ "any", "1", "3", "5", "10", "15", "30", "50", "75", "100" ], "type": "string", "description": "Widen the search by this many miles beyond the location. Needs a location. Applies to keyword searches.", "default": "any" }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Only listings priced at or above this many pounds. Leave empty for no minimum. Applies to keyword searches. Listings without a price are kept. Gumtree applies a price limit itself only in some categories (not in Property, for example); where it does not, the Actor drops the listings outside your range after reading them, so you can get fewer rows than Max listings per search (see the Notes in the README)." }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Only listings priced at or below this many pounds. Leave empty for no maximum. Applies to keyword searches. Listings without a price are kept. Gumtree applies a price limit itself only in some categories (not in Property, for example); where it does not, the Actor drops the listings outside your range after reading them, so you can get fewer rows than Max listings per search (see the Notes in the README)." }, "category": { "title": "Category", "enum": [ "all", "for-sale", "cars-vans-motorbikes", "flats-houses", "jobs", "business-services", "community", "pets" ], "type": "string", "description": "Limit a keyword search to one top-level Gumtree category. For a narrower category (for example Mobile Phones) open it on gumtree.com and paste the link into Searches instead.", "default": "all" }, "sortBy": { "title": "Sort by", "enum": [ "newest", "relevance", "price_lowest_first", "price_highest_first" ], "type": "string", "description": "Order of the results. Newest first is the right choice when you run the Actor on a schedule to catch new listings.", "default": "newest" }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many listings to read per search (about 25 to 30 per page, Gumtree shows at most 50 pages). Promoted ads count too. Listings the Actor drops because they are outside your price range count as read. With Only new on, this is how far down the list the Actor looks.", "default": 100 }, "onlyNew": { "title": "Only new listings and price changes", "type": "boolean", "description": "Return only listings this search has not shown before, plus listings whose price changed since the last run. The first run of a search returns everything (there is nothing to compare with yet). You pay only for the rows returned.", "default": false }, "includePromoted": { "title": "Include promoted ads", "type": "boolean", "description": "Gumtree puts a few paid 'promoted' ads at the top of every page, outside the sort order and sometimes outside the area you chose. Untick to leave them out. Promoted ads outside your price range are always left out.", "default": 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 } } } } } } } } } }