{
  "openapi": "3.0.1",
  "info": {
    "title": "Zoopla Property Scraper",
    "description": "Scrape Zoopla.co.uk listings, full property details, sold-price history, sale & rent estimates, EV charging, agents, and autocomplete. Search by location / UK postcode / lat-lng / Zoopla URL with the full filter set (price, beds, sqft, tenure, new builds, chain-free, auction, furnished).",
    "version": "1.0",
    "x-build-id": "ebwfL260exiNh3wMR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/one-api~zoopla-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-one-api-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/one-api~zoopla-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-one-api-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/one-api~zoopla-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-one-api-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": {
          "property_inputs": {
            "title": "Listing ID, Zoopla URL, or full UK address (one per line)",
            "type": "array",
            "description": "Auto-detects each entry: digits → listingId, http(s) URL → Zoopla listing URL, anything else → UK address (must include full postcode, e.g. `NW3 2HN`). Each row = 1 property detail call.",
            "items": {
              "type": "string"
            }
          },
          "search_inputs": {
            "title": "Location, UK postcode, lat/lng radius, or Zoopla search URL (one per line)",
            "type": "array",
            "description": "Auto-detects each entry. Examples:\n• `NW3` (UK postcode outward code — preferred over full postcodes)\n• `Hampstead, London` or `Oxford, Oxfordshire` (free-text location)\n• `51.5074,-0.1278,1` (lat,lng,radius_miles)\n• `https://www.zoopla.co.uk/for-sale/property/london/` (search URL)\n\nFilters below apply to every search. Each LISTING is pushed as one dataset item.",
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Search Type",
            "enum": [
              "For_Sale",
              "To_Rent",
              "Sold"
            ],
            "type": "string",
            "description": "For_Sale (default) | To_Rent | Sold. UK convention uses `To_Rent`.",
            "default": "For_Sale"
          },
          "propertyType": {
            "title": "Property Types",
            "type": "string",
            "description": "Comma-separated UK property types. Empty for all. Allowed: `flat, house, bungalow, terraced, semi_detached, detached, land, park_home, farm`",
            "default": ""
          },
          "priceRange": {
            "title": "Price Range (£)",
            "type": "string",
            "description": "`min:500000`, `max:1500000`, or `min:500000,max:1500000`",
            "default": ""
          },
          "bedsRange": {
            "title": "Beds Range",
            "type": "string",
            "description": "`min:2`, `max:5`, `min:2,max:5` (studio = `min:0`)",
            "default": ""
          },
          "bathsRange": {
            "title": "Baths Range",
            "type": "string",
            "description": "`min:1`, `max:3`, `min:1,max:3`",
            "default": ""
          },
          "sizeSqftRange": {
            "title": "Floor Area (sqft)",
            "type": "string",
            "description": "`min:600`, `max:2000`, `min:600,max:2000`",
            "default": ""
          },
          "tenure": {
            "title": "Tenure",
            "enum": [
              "",
              "freehold",
              "leasehold",
              "share_of_freehold"
            ],
            "type": "string",
            "description": "UK-specific. Empty = any tenure.",
            "default": ""
          },
          "sortOrder": {
            "title": "Sort Order",
            "enum": [
              "Newest",
              "Price_High_to_Low",
              "Price_Low_to_High",
              "Most_Reduced"
            ],
            "type": "string",
            "description": "How to sort search results. Default: Newest.",
            "default": "Newest"
          },
          "pages": {
            "title": "Pages to fetch per search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Each page = up to 25 listings (Zoopla's fixed page size).",
            "default": 1
          },
          "newHomes": {
            "title": "New-Build filter",
            "enum": [
              "",
              "only",
              "false"
            ],
            "type": "string",
            "description": "`only` (only new builds) | `false` (exclude) | empty (include both, Zoopla default).",
            "default": ""
          },
          "chainFree": {
            "title": "Chain Free Only",
            "type": "boolean",
            "description": "Only listings advertised as chain-free (no onward chain).",
            "default": false
          },
          "retirement": {
            "title": "Retirement / Over-55 Only",
            "type": "boolean",
            "description": "Only retirement / over-55 properties.",
            "default": false
          },
          "sharedOwnership": {
            "title": "Shared Ownership Only",
            "type": "boolean",
            "description": "Only shared-ownership listings (buy a share, rent the rest from a housing association).",
            "default": false
          },
          "auction": {
            "title": "Auction Only",
            "type": "boolean",
            "description": "Only auction listings.",
            "default": false
          },
          "includeSold": {
            "title": "Include Sold-STC / Under Offer",
            "type": "boolean",
            "description": "When `searchType` = `For_Sale`, also include sold-STC / under-offer alongside live listings.",
            "default": false
          },
          "furnished": {
            "title": "Furnished State (rent only)",
            "enum": [
              "",
              "furnished",
              "unfurnished",
              "part_furnished"
            ],
            "type": "string",
            "description": "Used when `searchType` = `To_Rent`. Empty = any.",
            "default": ""
          },
          "petsAllowed": {
            "title": "Pets Allowed (rent only)",
            "type": "boolean",
            "description": "Only pet-friendly rentals. Used with `searchType` = `To_Rent`.",
            "default": false
          },
          "billsIncluded": {
            "title": "Bills Included (rent only)",
            "type": "boolean",
            "description": "Only rentals with bills included in rent.",
            "default": false
          },
          "sharedLiving": {
            "title": "Shared Accommodation (rent only)",
            "type": "boolean",
            "description": "Only shared accommodation / flatshare listings.",
            "default": false
          },
          "studentHousing": {
            "title": "Student Accommodation (rent only)",
            "type": "boolean",
            "description": "Only student accommodation listings.",
            "default": false
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Free-text amenities (e.g. `garden,parking,period features`).",
            "default": ""
          },
          "autocomplete_inputs": {
            "title": "Autocomplete query (one per line)",
            "type": "array",
            "description": "Zoopla search-box suggestions: neighbourhoods, towns, postcodes, counties.",
            "items": {
              "type": "string"
            }
          },
          "soldprices_inputs": {
            "title": "Sold-prices geo selectors (one per line)",
            "type": "array",
            "description": "Browse Zoopla's Land Registry sold-price database. Auto-detects each row:\n• `london`, `london/elm-row/nw3-1aa` → geoId (slug from /autocomplete)\n• `51.5074,-0.1278` → exact lat,lon\n• `51.56,-0.15,51.54,-0.18` → bbox (ne_lat,ne_lon,sw_lat,sw_lon)\n• Anything else → tried as `postcode` (less reliable; Zoopla often returns 0)",
            "items": {
              "type": "string"
            }
          },
          "ev_inputs": {
            "title": "EV charging — listingId or `lat,lon` (one per line)",
            "type": "array",
            "description": "Find charging stations near a property. Digits → listingId (we resolve coords); `lat,lon` → direct.",
            "items": {
              "type": "string"
            }
          },
          "estimates_inputs": {
            "title": "Address (with full UK postcode) or UPRN (one per line)",
            "type": "array",
            "description": "Zoopla's automated valuation. UK address with full postcode, OR a UPRN (Unique Property Reference Number, all-digits).",
            "items": {
              "type": "string"
            }
          },
          "history_inputs": {
            "title": "Address (with full UK postcode) or UPRN (one per line)",
            "type": "array",
            "description": "Historic listings + Land Registry sales for one property.",
            "items": {
              "type": "string"
            }
          },
          "agent_search_inputs": {
            "title": "Agent location slug (one per line)",
            "type": "array",
            "description": "Find estate-agent branches by single-token UK location slug. Examples: `oxford`, `london`, `nw3`, `se17`, `manchester`. Multi-word slugs (`oxford-oxfordshire`) return an error.",
            "items": {
              "type": "string"
            }
          },
          "agent_inputs": {
            "title": "Agent branchId (one per line)",
            "type": "array",
            "description": "branchId from any /search/* result (`branch.id`) or /agent/search response. Returns branch info plus a sample of for-sale + to-rent listings. To pull the FULL listings page, set the `agent_listings_section` toggle below.",
            "items": {
              "type": "string"
            }
          },
          "agent_listings_section": {
            "title": "Also fetch agent's full listings (for-sale + to-rent)",
            "type": "boolean",
            "description": "When checked, each branchId in the section above also runs /agent/forsaleproperties and /agent/forrentproperties (paginated by `pages`).",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}