{
  "openapi": "3.0.1",
  "info": {
    "title": "Zillow Scraper",
    "description": "Scrape Zillow listings by city, ZIP, or neighborhood. Pull homes for sale, for rent, and recently sold with prices, beds, baths, photos, and Zestimates, plus full detail: price and tax history, schools, lot facts, and agent contacts. No 1,000-result cap. Export to CSV, JSON, or Excel for comps.",
    "version": "1.0",
    "x-build-id": "X1OobNCmZc1gyzzkl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~zillow-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-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/silentflow~zillow-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-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/silentflow~zillow-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-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": {
          "location": {
            "title": "Location",
            "type": "string",
            "description": "City, neighborhood, ZIP code, or address to search. Ignored when Locations, Start URLs or Addresses are set."
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Search several locations in one run. When set, this overrides Location.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Paste Zillow links instead of typing a place. A search page link keeps the map area, filters and market you had on Zillow, for example <code>https://www.zillow.com/austin-tx/rentals/</code>. A property page link returns that home as one complete listing. When set, Location and Locations are ignored.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "addresses": {
            "title": "Addresses or Zillow IDs",
            "type": "array",
            "description": "Look up specific homes, on or off the market: one street address or Zillow property ID (zpid) per line. Each home comes back as one row, all of them whatever Max items. When set, Location and Locations are ignored.",
            "items": {
              "type": "string"
            }
          },
          "operation": {
            "title": "Operation",
            "enum": [
              "buy",
              "rent",
              "sold"
            ],
            "type": "string",
            "description": "Which market to search. A Start URL that names its own market (for rent, sold) uses that market instead.",
            "default": "buy"
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of listings the searches return. Homes listed in Addresses or as property links are always all returned.",
            "default": 100
          },
          "minPrice": {
            "title": "Min price",
            "type": "integer",
            "description": "Minimum price (per month for rent). 0 for any.",
            "default": 0
          },
          "maxPrice": {
            "title": "Max price",
            "type": "integer",
            "description": "Maximum price (per month for rent). 0 for any.",
            "default": 0
          },
          "minBeds": {
            "title": "Min bedrooms",
            "type": "integer",
            "description": "Minimum number of bedrooms.",
            "default": 0
          },
          "maxBeds": {
            "title": "Max bedrooms",
            "type": "integer",
            "description": "Maximum number of bedrooms. 0 for any.",
            "default": 0
          },
          "minBaths": {
            "title": "Min bathrooms",
            "type": "number",
            "description": "Minimum number of bathrooms.",
            "default": 0
          },
          "homeTypes": {
            "title": "Home types",
            "type": "array",
            "description": "Restrict to specific property types. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "houses",
                "townhomes",
                "multifamily",
                "condos",
                "land",
                "apartments",
                "manufactured"
              ],
              "enumTitles": [
                "Houses",
                "Townhomes",
                "Multi-family",
                "Condos/co-ops",
                "Lots/Land",
                "Apartments",
                "Manufactured"
              ]
            }
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "newest",
              "relevance",
              "lowPrice",
              "highPrice",
              "bedrooms",
              "bathrooms",
              "sqft",
              "lotSize",
              "yearBuilt"
            ],
            "type": "string",
            "description": "Result ordering.",
            "default": "newest"
          },
          "extractionMethod": {
            "title": "Items extraction method",
            "enum": [
              "PAGINATION_WITH_ZOOM_IN",
              "PAGINATION",
              "MAP_MARKERS"
            ],
            "type": "string",
            "description": "Whole area (default) zooms into the map until every listing is collected, so a city or county comes back in full, past the 820 results Zillow shows per search. The other two are quick samples.",
            "default": "PAGINATION_WITH_ZOOM_IN"
          },
          "fetchDetails": {
            "title": "Fetch details",
            "type": "boolean",
            "description": "Adds each home's description, year built, HOA fee, parking, last sale price and date, listing agent name, phone and email, MLS number, full price history, tax history and assigned schools. Slower.",
            "default": false
          },
          "locationType": {
            "title": "Location type",
            "enum": [
              "",
              "city",
              "neighborhood",
              "zipcode",
              "county",
              "state"
            ],
            "type": "string",
            "description": "Leave on Auto-detect unless a location name is ambiguous. Applies to typed places; Start URLs resolve on their own.",
            "default": ""
          },
          "debugMode": {
            "title": "Debug mode",
            "type": "boolean",
            "description": "Verbose logging for troubleshooting.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}