{
  "openapi": "3.0.1",
  "info": {
    "title": "Zillow Scraper: Every Listing Past 1,000, Zestimate, Details",
    "description": "Scrape every Zillow listing of a city, ZIP code, county or map area (for sale, for rent, sold), past the 1,000-per-search limit, with Zillow's announced count next to the returned count. Home pages by zpid or URL, new-listing and price-change watch.",
    "version": "0.1",
    "x-build-id": "GPzayKE5q6Rs3V23v"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alexmorain~zillow-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alexmorain-zillow-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/alexmorain~zillow-scraper/runs": {
      "post": {
        "operationId": "runs-sync-alexmorain-zillow-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/alexmorain~zillow-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-alexmorain-zillow-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": {
          "locations": {
            "title": "Places",
            "type": "array",
            "description": "City, ZIP code, county or neighborhood, as you would type it on Zillow: <code>Austin, TX</code>, <code>78701</code>, <code>Travis County, TX</code>, <code>Hyde Park, Austin, TX</code>. Zillow's own outline of the place is used, so a city search returns the city, not the box around it. US places only.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Zillow search URLs",
            "type": "array",
            "description": "Search pages copied from zillow.com. When the URL carries <code>searchQueryState</code> (any search where you moved the map or set filters), its map, region and filters are used as they are. A plain page such as <code>https://www.zillow.com/austin-tx/rentals/</code> gives its region and rent / sold type; filters written in the path (<code>/3-_beds/</code>) are not read, use the fields below.",
            "items": {
              "type": "string"
            }
          },
          "area": {
            "title": "Map area",
            "type": "object",
            "description": "A drawn rectangle: <code>{\"north\": 30.50, \"south\": 30.15, \"east\": -97.55, \"west\": -97.95}</code>. Use it for an area no place name covers; the whole rectangle is read."
          },
          "zpidsOrUrls": {
            "title": "Homes by zpid or URL",
            "type": "array",
            "description": "Homes to read one by one: a zpid such as <code>64625418</code> or a URL such as <code>https://www.zillow.com/homedetails/.../64625418_zpid/</code>. Each one returns the full home page and is charged as a Detailed listing. Meant for pipelines that already hold a list of zpids.",
            "items": {
              "type": "string"
            }
          },
          "listingType": {
            "title": "Listing type",
            "enum": [
              "forSale",
              "forRent",
              "sold"
            ],
            "type": "string",
            "description": "Applies to places and map areas. A search URL keeps its own type (for sale, for rent or sold).",
            "default": "forSale"
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "In US dollars. The price for sale and sold homes, the monthly rent for rentals."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 1,
            "type": "integer",
            "description": "In US dollars. The price for sale and sold homes, the monthly rent for rentals."
          },
          "minBeds": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "0 for no minimum."
          },
          "maxBeds": {
            "title": "Maximum bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Set both to 0 for studios only."
          },
          "minBaths": {
            "title": "Minimum bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Bathrooms, halves count as .5. 0 for no minimum."
          },
          "homeTypes": {
            "title": "Home types",
            "type": "array",
            "description": "Leave empty for all types. For rent, Zillow serves houses, townhouses and apartments / condos (the two are linked); lots, manufactured homes and multi-family are for sale and sold only.",
            "items": {
              "type": "string",
              "enum": [
                "house",
                "townhouse",
                "condo",
                "apartment",
                "multiFamily",
                "lot",
                "manufactured"
              ],
              "enumTitles": [
                "House",
                "Townhouse",
                "Condo",
                "Apartment",
                "Multi-family",
                "Lot / land",
                "Manufactured"
              ]
            }
          },
          "daysOnZillow": {
            "title": "Listed or sold within",
            "enum": [
              "1",
              "7",
              "14",
              "30",
              "90",
              "6m",
              "12m",
              "24m",
              "36m"
            ],
            "type": "string",
            "description": "Only listings that appeared on Zillow (or, for sold homes, sold) within this window. Leave empty for no limit."
          },
          "fullCoverage": {
            "title": "Full coverage",
            "type": "boolean",
            "description": "Zillow shows at most 984 listings per search, whatever the announced count (Austin announces 16,850). On, the map is split into smaller and smaller cells until each one fits, so every listing is returned and the SUMMARY record shows announced against returned. Off, you get Zillow's 984 and a note on how many are missing.",
            "default": true
          },
          "includeDetails": {
            "title": "Read each home page",
            "type": "boolean",
            "description": "Adds description, year built, price history when Zillow shows it, all photos, HOA fee, parking, agent and MLS details to each listing (Detailed listing event, higher price). Apartment buildings have no home page and stay plain listings.",
            "default": false
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Stops after this many listings in total. Empty or 0 = every listing of the area: tens of thousands for a large city, so set a limit or a maximum charge per run when you test."
          },
          "monitorMode": {
            "title": "Monitoring",
            "enum": [
              "off",
              "newOnly",
              "newAndPriceChanges"
            ],
            "type": "string",
            "description": "<b>New listings only</b> returns only listings not returned by an earlier run with the same input (and monitor name). <b>New and price changes</b> also returns listings whose price moved, with <code>previousPrice</code> and <code>priceChange</code> (up / down). Unchanged listings are neither returned nor charged. The first run returns everything. State is kept in a store named <code>zillow-scraper-monitor</code> in your account.",
            "default": "off"
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Optional. Runs with the same name and the same input share one memory; change it to start a separate watch on the same search."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Optional. A JSON summary is POSTed here when the run ends with at least one listing. Slack and Discord incoming webhooks work. Redirects are not followed (except 307 / 308)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}