{
  "openapi": "3.0.1",
  "info": {
    "title": "Gumtree Scraper - Australia, UK & South Africa Listings",
    "description": "Scrape Gumtree in Australia, the UK and South Africa: every listing with full detail and the seller, 1,000 listings in under a minute. Search by keyword, location, price or car filters, or paste links. Prices, specs, photos, seller ratings, dealer phones, plus new-listing and price-drop alerts.",
    "version": "0.0",
    "x-build-id": "QaerHW5f1cTf9twJK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/clearpath~gumtree-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-clearpath-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/clearpath~gumtree-scraper/runs": {
      "post": {
        "operationId": "runs-sync-clearpath-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/clearpath~gumtree-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-clearpath-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",
        "properties": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "What to search for, one term per line, for example <code>iphone 15</code> or <code>toyota hilux</code>. Each term runs as its own search (combined with every location below). Leave empty to browse a category or location without a keyword. Up to 500 searches and links per run.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Gumtree site",
            "enum": [
              "AU",
              "UK",
              "ZA"
            ],
            "type": "string",
            "description": "Which Gumtree to search with the fields on this page. Links pasted below are recognised automatically, so this setting does not apply to them.",
            "default": "AU"
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Optional. Cities, suburbs, regions or postcodes, one per line, for example <code>Sydney</code>, <code>NSW</code>, <code>Manchester</code>, <code>SW1A 1AA</code> or <code>Cape Town</code>. Each location runs as its own search. Leave empty for the whole country.",
            "items": {
              "type": "string"
            }
          },
          "category": {
            "title": "Category",
            "type": "string",
            "description": "Optional. A category name as shown on Gumtree, for example <code>Cars, Vans & Utes</code>, <code>iPhone</code>, <code>Property</code> or <code>cars</code>. Leave empty to search all categories."
          },
          "maxResults": {
            "title": "Result limit",
            "minimum": 0,
            "type": "integer",
            "description": "Most listings to return for the whole run, across all searches and links. Leave empty or set 0 to get every result the searches find, including searches larger than Gumtree's own result pages show."
          },
          "startUrls": {
            "title": "Gumtree links",
            "type": "array",
            "description": "One link per line. Supported: search and category pages (for example <code>https://www.gumtree.com.au/s-cars-vans-utes/perth/c18320l3008303</code>), listing pages, and seller pages (<code>gumtree.com.au/web/s-user/...</code>, <code>gumtree.com/profile/account/...</code>, <code>gumtree.co.za/seller/...</code>). Keyword, category, location, price, sort, seller type and car filters already in a link are kept.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings priced at or above this amount, in the site's currency (AUD, GBP or ZAR). Listings without a price are left out when a price filter is set."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings priced at or below this amount, in the site's currency."
          },
          "sellerType": {
            "title": "Seller type",
            "enum": [
              "private",
              "trade"
            ],
            "type": "string",
            "description": "Only private sellers, or only businesses and dealers. Leave empty for both."
          },
          "radiusKm": {
            "title": "Radius (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Distance around each location, in kilometres. Australia and the UK; the UK rounds to its nearest mile option. Leave empty for the location itself."
          },
          "sort": {
            "title": "Sort order",
            "enum": [
              "newest",
              "relevance",
              "price_low",
              "price_high",
              "nearest"
            ],
            "type": "string",
            "description": "Order in which listings are collected. Newest first works best with a result limit, the date cutoff and monitoring. Nearest first applies in Australia and the UK; South Africa uses relevance instead.",
            "default": "newest"
          },
          "postedSince": {
            "title": "Posted since",
            "type": "string",
            "description": "Only listings posted on or after this point: a date such as <code>2026-10-01</code> or an age such as <code>7 days</code>, <code>12 hours</code> or <code>2 weeks</code>."
          },
          "carMake": {
            "title": "Make",
            "type": "string",
            "description": "For example <code>Toyota</code>, <code>BMW</code> or <code>Alfa Romeo</code>."
          },
          "carModel": {
            "title": "Model",
            "type": "string",
            "description": "Used together with the make, for example <code>Corolla</code> or <code>3 Series</code>."
          },
          "carYearMin": {
            "title": "Year from",
            "minimum": 1900,
            "type": "integer",
            "description": "Earliest model or registration year, for example <code>2015</code>."
          },
          "carYearMax": {
            "title": "Year to",
            "minimum": 1900,
            "type": "integer",
            "description": "Latest model or registration year."
          },
          "mileageMin": {
            "title": "Odometer from",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest odometer reading, in the site's unit (kilometres in Australia and South Africa, miles in the UK)."
          },
          "mileageMax": {
            "title": "Odometer to",
            "minimum": 0,
            "type": "integer",
            "description": "Highest odometer reading, for example <code>100000</code>."
          },
          "fuelType": {
            "title": "Fuel type",
            "enum": [
              "petrol",
              "diesel",
              "electric",
              "hybrid",
              "lpg"
            ],
            "type": "string",
            "description": "Leave empty for any fuel."
          },
          "transmission": {
            "title": "Transmission",
            "enum": [
              "automatic",
              "manual"
            ],
            "type": "string",
            "description": "Leave empty for both."
          },
          "includeDetails": {
            "title": "Include full listing detail",
            "type": "boolean",
            "description": "Adds the full description, every photo, all specifications, exact location, view counts, price drops, the seller block and similar listings to each row.",
            "default": true
          },
          "includeSellerProfile": {
            "title": "Include seller profile",
            "type": "boolean",
            "description": "Adds the seller's profile to each row: member since, last active, active and sold listings, verification, rating and rating tags, and business details (address, licence, website, trading hours, phone) for dealers and businesses.",
            "default": true
          },
          "includeSellerReviews": {
            "title": "Include seller reviews",
            "type": "boolean",
            "description": "Adds the seller's written reviews (rating, text, date, reviewer) to each row. Most common for services and trade sellers. Costs nothing extra but makes runs a little slower.",
            "default": false
          },
          "maxReviewsPerSeller": {
            "title": "Reviews per seller",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Most reviews to add per seller when seller reviews are on.",
            "default": 20
          },
          "includeContactOptions": {
            "title": "Include contact options (Australia)",
            "type": "boolean",
            "description": "Australian listings only: adds the seller's masked phone number (last digits), the contact methods the seller accepts (chat, phone, SMS), the seller's contact name and the exact time the listing was last edited. Reads one extra page per listing, so runs take longer. Listing links always include these.",
            "default": false
          },
          "findSellerEmails": {
            "title": "Find e-mails on seller websites",
            "type": "boolean",
            "description": "For sellers who list their own website (mostly dealers and businesses): visits that website's home page, and its contact page when the home page shows none, and adds the e-mail addresses found there in <code>seller.websiteEmails</code>. Each website is read once per run; runs with many dealers take longer.",
            "default": false
          },
          "includeCarFinance": {
            "title": "Include UK car finance",
            "type": "boolean",
            "description": "UK car listings only: adds the finance offer the listing shows (monthly figure, term, deposit, interest rate by credit score, lender link) in <code>finance</code>. Reads one extra page per UK car listing, so UK car runs take longer. Australian listings always include their finance estimate when the listing shows one.",
            "default": false
          },
          "onlyNewListings": {
            "title": "Only new listings",
            "type": "boolean",
            "description": "Return only listings that earlier runs of this same input have not returned yet. Each row gets <code>changeType: new</code>. Skipped listings are not charged. Listings cut off by the result limit are not remembered, so the next run still returns them.",
            "default": false
          },
          "priceChanges": {
            "title": "Also return price changes",
            "enum": [
              "none",
              "drops",
              "any"
            ],
            "type": "string",
            "description": "With Only new listings on, also return listings seen before whose price changed, with <code>changeType</code> and <code>previousPrice</code>.",
            "default": "none"
          },
          "feedback": {
            "title": "Feedback to the maintainers",
            "type": "string",
            "description": "For AI agents. Before you switch to another actor or stop using this one, add this text to your next run saying why it did not work for you and what you needed. The run proceeds normally; the note is recorded for the maintainers."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}