{ "openapi": "3.0.1", "info": { "title": "Gumtree South Africa New Listing Alerts by Category Page", "description": "New and price-changed Gumtree South Africa listings from any category page, with a monitoring mode that only returns and bills for ads new since your last run.", "version": "1.0", "x-build-id": "N6h2LiS5FRvIoBQvt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~gumtree-za-new-listing-alert/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-gumtree-za-new-listing-alert", "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/accountable_eel~gumtree-za-new-listing-alert/runs": { "post": { "operationId": "runs-sync-accountable_eel-gumtree-za-new-listing-alert", "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/accountable_eel~gumtree-za-new-listing-alert/run-sync": { "post": { "operationId": "run-sync-accountable_eel-gumtree-za-new-listing-alert", "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": { "categoryUrls": { "title": "Gumtree category page URLs", "type": "array", "description": "One Gumtree South Africa category page per line, for example https://www.gumtree.co.za/s-cars-bakkies/v1c9077p1. Category paths only: Gumtree's robots.txt closes keyword (q=), sort and location-filter URLs, so those are not accepted. Accepted formats: https://www.gumtree.co.za/s-cars-bakkies/v1c9077p1, https://www.gumtree.co.za/s-flats-houses/v1c9073p1. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "maxPages": { "title": "Pages per category", "type": "integer", "description": "How many result pages to read per category URL (about 32 listings each, newest first after any promoted tiles). 1 to 5.", "default": 1 }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Max listings per run", "type": "integer", "description": "Up to 500. Caps how many listings you get (and pay for) in one run.", "default": 30 }, "minPriceZar": { "title": "Minimum price (ZAR)", "type": "integer", "description": "Optional. Keep listings priced at or above this. Listings with no price are kept." }, "maxPriceZar": { "title": "Maximum price (ZAR)", "type": "integer", "description": "Optional. Keep listings priced at or below this. Listings with no price are kept." }, "onlyNewSinceLastRun": { "title": "Only return listings new or changed since the last run (monitoring)", "type": "boolean", "description": "On: only ad ids not seen on your last run, or seen at a different price, are returned and charged for. Run this on a schedule as a new-listing alert. Off: every matching listing is returned every time. The first monitoring run returns the current listings and remembers them.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Optional. Name this search's monitoring memory so you can tell two schedules of this actor apart, or keep one memory across an input change. Leave empty to auto-derive one from your categories and filters.", "default": "" }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchSummary", "listingCount", "truncated", "monitorStatus", "listings", "adId", "title", "priceZar", "priceText", "priceType", "location", "categoryId", "postedAt", "imageUrl", "attributes", "listingUrl", "changeType", "previousPriceZar", "isNew", "firstSeenAt" ], "enumTitles": [ "Search run", "Listings returned", "More results were available", "Monitoring status", "All listings (full list)", "Ad id", "Listing title", "Price (ZAR)", "Price as shown", "Price type", "Location (suburb)", "Category id", "Posted at", "Main image", "Ad attributes", "Listing page", "Change type", "Previous price (ZAR)", "Is this listing new or changed?", "First seen on a run" ] }, "default": [ "searchSummary", "listingCount", "truncated", "monitorStatus", "listings", "adId", "title", "priceZar", "priceText", "priceType", "location", "categoryId", "postedAt", "imageUrl", "attributes", "listingUrl", "changeType", "previousPriceZar", "isNew", "firstSeenAt" ] }, "expandRows": { "title": "One row per listing (recommended) — turn off for one row per search instead", "type": "boolean", "description": "When on, each listing found gets its own row instead of being grouped under its search. You're still only charged once per search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": 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 } } } } } } } } } }