{ "openapi": "3.0.1", "info": { "title": "Gumtree Scraper — AU, UK, NZ & South Africa", "description": "Search public Gumtree listings across Australia, the UK, and South Africa plus Trade Me New Zealand by URL or keyword. Use for price monitoring and market research; not for accounts or posting ads. Returns normalized listing, price, location, seller, image, and date fields. $0.006/result.", "version": "1.0", "x-build-id": "HSVdpNtZV871AJtSd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~gumtree-scraper-au-uk-nz-za/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-gumtree-scraper-au-uk-nz-za", "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/muhammadafzal~gumtree-scraper-au-uk-nz-za/runs": { "post": { "operationId": "runs-sync-muhammadafzal-gumtree-scraper-au-uk-nz-za", "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/muhammadafzal~gumtree-scraper-au-uk-nz-za/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-gumtree-scraper-au-uk-nz-za", "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": "Search or Listing URLs", "type": "array", "description": "Use this when you already have Gumtree AU/UK/ZA or Trade Me NZ search, category, or listing URLs. Accepts request objects such as {\"url\":\"https://www.gumtree.com/search?q=bicycle\"}. Defaults to an empty list. This is not for seller account, message, or posting-ad URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywords": { "title": "Search Keywords", "type": "array", "description": "Use this when you want the actor to create marketplace searches for you. Enter one phrase per line, for example \"mountain bike\" or \"Ford Ranger\". Defaults to [\"bicycle\"]. This is not a URL field; paste URLs into Search or Listing URLs.", "items": { "type": "string" }, "default": [ "bicycle" ] }, "regions": { "title": "Marketplace Regions", "uniqueItems": true, "type": "array", "description": "Use this to choose where each keyword is searched. Accepted values are uk, au, nz, and za; New Zealand routes to Trade Me because Gumtree NZ is closed. Defaults to [\"uk\"]. This does not override the country encoded in a supplied URL.", "items": { "type": "string", "enum": [ "uk", "au", "nz", "za" ], "enumTitles": [ "United Kingdom — Gumtree", "Australia — Gumtree", "New Zealand — Trade Me", "South Africa — Gumtree" ] }, "default": [ "uk" ] }, "location": { "title": "Location Filter", "type": "string", "description": "Use this to retain listings whose displayed location contains a city, region, or postcode, for example \"London\" or \"Auckland\". Matching is case-insensitive after extraction. Defaults to an empty string, which keeps every location. This is not a radius or latitude/longitude filter.", "default": "" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Use this to exclude listings below a numeric price in each marketplace's local currency, for example 100. Set 0 to disable the minimum. Defaults to 0 and must be non-negative. This is not currency conversion; GBP, AUD, NZD, and ZAR remain separate.", "default": 0 }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Use this to exclude listings above a numeric price in each marketplace's local currency, for example 5000. Set 0 to disable the maximum. Defaults to 0 and must be non-negative. This is not a global converted-price ceiling across currencies.", "default": 0 }, "includeDetails": { "title": "Enrich Listing Details", "type": "boolean", "description": "Enable this to visit each listing page for full descriptions, image galleries, sellers, categories, dates, and attributes. It defaults to false for a fast, reliable search. This does not reveal private, login-only, masked, or unpublished seller data.", "default": false }, "responseFormat": { "title": "Response Detail Level", "enum": [ "concise", "detailed" ], "type": "string", "description": "Use concise for smaller AI-agent responses or detailed for full descriptions, images, and attributes. Accepted values are concise and detailed. Defaults to detailed. This changes record richness, not which listings are discovered.", "default": "detailed" }, "maxResults": { "title": "Maximum Total Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Use this to cap the total billable listings across all URLs, keywords, and regions. Enter 1 to 500; for example 20 costs at most $0.12 in listing events. Defaults to 20. This is not a per-keyword limit; the actor allocates the total fairly across searches.", "default": 20 } } }, "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 } } }, "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 } } } } } } } } } }