{
  "openapi": "3.0.1",
  "info": {
    "title": "Zoopla Scraper — UK Property API · Sale + Rent + Valuations",
    "description": "🇬🇧 Stable, API-backed Zoopla scraper for UK property data — sale + rent listings, valuation estimates (sale & rent), market KPIs (median price, £/sqft, area breakdowns), HTML report. Bulk-location PAID. Independent tool — not affiliated with Zoopla / ZPG.",
    "version": "1.0",
    "x-build-id": "2akBJatldLUn82xwM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~zoopla-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-zoopla-property-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/sian.agency~zoopla-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-zoopla-property-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/sian.agency~zoopla-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-zoopla-property-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": {
          "searchMode": {
            "title": "🧭 Search Mode",
            "enum": [
              "bylocation",
              "byzip",
              "bycoordinates",
              "byurl",
              "bulklocations"
            ],
            "type": "string",
            "description": "How to specify what to scrape.\n\n• **bylocation** — free-text UK location (town, neighbourhood, postcode area)\n• **byzip** — UK postcode (outward code preferred — e.g. NW3, SW1A)\n• **bycoordinates** — latitude + longitude + radius (miles)\n• **byurl** — paste a Zoopla search URL — filters are read from the URL\n• **bulklocations** — array of locations in one run (PAID)",
            "default": "bylocation"
          },
          "listingType": {
            "title": "🏠 Listing Type",
            "enum": [
              "sale",
              "rent",
              "both"
            ],
            "type": "string",
            "description": "Which side of the UK market to scrape.\n\n• **sale** — properties for sale\n• **rent** — properties to rent\n• **both** — runs each query twice — sale + rent (PAID)\n\nNote: ignored when Search Mode = byurl (the URL itself encodes whether it's a for-sale or to-rent search).",
            "default": "sale"
          },
          "location": {
            "title": "📍 Location  (used when Search Mode = bylocation)",
            "type": "string",
            "description": "Free-text UK location — neighbourhood, town, county, region, postcode area, or full address.\n\nExamples: `London`, `Hampstead, London`, `Camden`, `Oxford, Oxfordshire`, `NW3`",
            "default": "Hampstead, London"
          },
          "locations": {
            "title": "📋 Bulk Locations  (PAID, bulklocations mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of UK location strings to sweep in one run. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "postalCode": {
            "title": "📮 Postcode  (used when Search Mode = byzip)",
            "type": "string",
            "description": "UK postcode — **outward code preferred** (the part before the space).\n\nFull postcodes like `NW3 1AA` may return 0 results — outward codes (`NW3`, `SW1A`, `M1`, `EC1A`) resolve to area slugs.\n\nExamples: `NW3`, `SW1A`, `EC1A`, `M1`, `OX1`"
          },
          "latitude": {
            "title": "🗺 Latitude  (used when Search Mode = bycoordinates)",
            "type": "number",
            "description": "Latitude in decimal degrees. London centre ≈ `51.5074`."
          },
          "longitude": {
            "title": "🗺 Longitude  (used when Search Mode = bycoordinates)",
            "type": "number",
            "description": "Longitude in decimal degrees. Negative = west of Greenwich. London centre ≈ `-0.1278`."
          },
          "zooplaUrl": {
            "title": "🔗 Zoopla URL  (used when Search Mode = byurl)",
            "type": "string",
            "description": "Paste any search/filter URL from the Zoopla site.\n\nExamples:\n- `https://www.zoopla.co.uk/for-sale/property/london/?price_min=500000&beds_min=2`\n- `https://www.zoopla.co.uk/to-rent/property/manchester/?price_max=1500&furnished_state=furnished`"
          },
          "radius": {
            "title": "📏 Search radius (miles)",
            "minimum": 0,
            "maximum": 40,
            "type": "number",
            "description": "Search radius around the location/postcode/coordinates, in miles. Allowed: 0, 0.25, 0.5, 1, 3, 5, 10, 20, 40. Default: 1.",
            "default": 1
          },
          "propertyType": {
            "title": "🏘 Property type",
            "type": "string",
            "description": "Comma-separated UK property types. Leave empty to include all.\n\nAllowed: `flat, house, bungalow, terraced, semi_detached, detached, land, park_home, farm`\n\nExamples: `flat`, `house,bungalow`, `terraced,semi_detached`"
          },
          "priceRange": {
            "title": "💷 Price range (GBP)",
            "type": "string",
            "description": "Price range in GBP. Format: `min:N`, `max:N`, or `min:N,max:N`.\n\nFor sale: total price. For rent: monthly rent (pcm).\n\nExamples: `min:500000,max:1500000`, `max:2000`, `min:300000`"
          },
          "bedsRange": {
            "title": "🛏 Bedrooms",
            "type": "string",
            "description": "Bedroom range. Studio = `min:0`. Format: `min:N`, `max:N`, or `min:N,max:N`.\n\nExamples: `min:2`, `min:3,max:3`, `min:2,max:5`"
          },
          "bathsRange": {
            "title": "🛁 Bathrooms",
            "type": "string",
            "description": "Bathroom range. Format: `min:N`, `max:N`, or `min:N,max:N`."
          },
          "sizeSqftRange": {
            "title": "📐 Floor area (sqft)",
            "type": "string",
            "description": "Floor-area range in square feet. Format: `min:N`, `max:N`, or `min:N,max:N`."
          },
          "tenure": {
            "title": "📜 Tenure",
            "enum": [
              "",
              "freehold",
              "leasehold",
              "share_of_freehold"
            ],
            "type": "string",
            "description": "UK property tenure. Leave empty for any.\n\n• **freehold** — own the building and the land\n• **leasehold** — own the property for a fixed term\n• **share_of_freehold** — leasehold + share in the building's freehold company",
            "default": ""
          },
          "newHomes": {
            "title": "🏗 New homes filter",
            "enum": [
              "",
              "false",
              "only"
            ],
            "type": "string",
            "description": "New-build filter.\n\n• **(any)** — Zoopla default (include new builds)\n• **false** — exclude new builds\n• **only** — only new builds",
            "default": ""
          },
          "furnished": {
            "title": "🛋 Furnished state (rent only)",
            "enum": [
              "",
              "furnished",
              "unfurnished",
              "part_furnished"
            ],
            "type": "string",
            "description": "Furnishing state — only used when listingType = rent.",
            "default": ""
          },
          "keywords": {
            "title": "🔑 Free-text keywords",
            "type": "string",
            "description": "Free-text amenity keywords matched against listing descriptions.\n\nExamples: `garden`, `parking`, `period features`, `garden parking`"
          },
          "sortOrder": {
            "title": "🔃 Sort order",
            "enum": [
              "",
              "Newest",
              "Price_High_to_Low",
              "Price_Low_to_High",
              "Most_Reduced"
            ],
            "type": "string",
            "description": "How results are sorted. Default: Newest.",
            "default": ""
          },
          "chainFree": {
            "title": "🔓 Chain-free only (sale)",
            "type": "boolean",
            "description": "Return only chain-free listings (no onward chain — common for new builds, executor sales, repossessions).",
            "default": false
          },
          "includeSold": {
            "title": "📌 Include sold-STC / under-offer (sale)",
            "type": "boolean",
            "description": "Also include sold-STC / under-offer listings alongside live ones.",
            "default": false
          },
          "petsAllowed": {
            "title": "🐾 Pets allowed only (rent)",
            "type": "boolean",
            "description": "Return only pet-friendly rentals.",
            "default": false
          },
          "billsIncluded": {
            "title": "💡 Bills included only (rent)",
            "type": "boolean",
            "description": "Return only rentals with bills included in rent.",
            "default": false
          },
          "includeRented": {
            "title": "🏠 Include let-agreed (rent)",
            "type": "boolean",
            "description": "Also include let-agreed / already-rented listings alongside live ones.",
            "default": false
          },
          "maxResults": {
            "title": "📊 Max results per query",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Hard cap on listings returned per query. Auto-paginates until the cap is reached or the search is fully drained. Default 25 = one API page. FREE tier is always capped at 25 listings per run.",
            "default": 25
          },
          "includeEstimates": {
            "title": "💷 Include valuation estimates (PAID)",
            "type": "boolean",
            "description": "When ON, fetches sale + rent valuation estimates for each listing (1 extra API call per listing). Adds an estimate-enriched charge per successful enrichment. Disabled on FREE tier.\n\nNote: works best when listings have a clear UK postcode in the address. Listings without a resolvable address are silently skipped (no charge).",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}