{
  "openapi": "3.0.1",
  "info": {
    "title": "Zillow API + Market KPIs (Bridge Interactive Alternative)",
    "description": "🏡 The Zillow API replacement — no key, no rate limits, no spreadsheet math. Paste any Zillow URL → listings + Zestimate + total inventory + investor KPIs (gross yield, cap rate, cash flow, price/Zestimate, days-on-market). Bridge Interactive alternative. Bulk URL & CSV input. $0.003/property.",
    "version": "1.0",
    "x-build-id": "bmI1uPeFhtd1bRx5O"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~zillow-scraper-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-zillow-scraper-api",
        "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~zillow-scraper-api/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-zillow-scraper-api",
        "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~zillow-scraper-api/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-zillow-scraper-api",
        "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": [
              "url",
              "address",
              "mls",
              "polygon",
              "coordinates",
              "mapbounds",
              "offmarket"
            ],
            "type": "string",
            "description": "Pick how you want to search Zillow. Each mode reads its own dedicated input fields below — fields outside the chosen mode are ignored.\n\n• **url** — paste a Zillow search URL (default; cheapest)\n• **address** — search by free-text address or city\n• **mls** — look up by MLS listing ID\n• **polygon** — draw a polygon on a map (PAID)\n• **coordinates** — center point + radius\n• **mapbounds** — north/south/east/west bounding box (PAID)\n• **offmarket** — find off-market properties by address or ZIP (PAID)",
            "default": "url"
          },
          "searchUrl": {
            "title": "🔗 Zillow Search URL  (used when Search Mode = url)",
            "pattern": "^https?://(www\\.)?zillow\\.com/.+",
            "type": "string",
            "description": "Paste a Zillow search URL, e.g. https://www.zillow.com/austin-tx/. ⚡ Auto-paginates to satisfy 'Max results per query'. 📈 Market KPIs computed automatically. Optionally append /N_p/ to start from a specific page. Ignored if 'Bulk URLs' or 'CSV upload' is provided."
          },
          "searchUrls": {
            "title": "📋 Bulk URLs  (PAID, url mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of Zillow search URLs. PAID tier only. Click 'Bulk edit' to paste URLs (one per line) or upload a .txt file.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "urlsCsv": {
            "title": "📁 CSV Upload  (PAID, url mode)",
            "type": "array",
            "description": "Upload a CSV file containing Zillow search URLs (one per line, optional header). PAID tier only.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "addressQuery": {
            "title": "🏠 Address  (used when Search Mode = address)",
            "type": "string",
            "description": "Free-text address, neighborhood, or city. Examples: '123 Main St, Austin TX 78704', 'Williamsburg, Brooklyn'."
          },
          "addressQueries": {
            "title": "📋 Bulk Addresses  (PAID, address mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of address strings. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "mlsId": {
            "title": "🆔 MLS ID  (used when Search Mode = mls)",
            "type": "string",
            "description": "A single Multiple Listing Service ID, e.g. '6789432'."
          },
          "mlsIds": {
            "title": "📋 Bulk MLS IDs  (PAID, mls mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of MLS IDs. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "polygonCoords": {
            "title": "📐 Polygon Coordinates  (PAID, polygon mode)",
            "type": "array",
            "description": "Array of at least 3 [longitude, latitude] pairs forming a polygon ring. Example: [[-97.74,30.27],[-97.71,30.27],[-97.71,30.30],[-97.74,30.30]]. PAID tier only."
          },
          "centerLat": {
            "title": "🌐 Center Latitude  (used when Search Mode = coordinates)",
            "type": "string",
            "description": "Decimal latitude of the search center, e.g. '30.2672'."
          },
          "centerLng": {
            "title": "🌐 Center Longitude  (used when Search Mode = coordinates)",
            "type": "string",
            "description": "Decimal longitude of the search center, e.g. '-97.7431'."
          },
          "radiusMiles": {
            "title": "📏 Radius (miles)  (used when Search Mode = coordinates)",
            "type": "string",
            "description": "Search radius in miles, between 0 and 50."
          },
          "north": {
            "title": "🧭 North Latitude  (PAID, mapbounds mode)",
            "type": "string",
            "description": "Northern boundary latitude."
          },
          "south": {
            "title": "🧭 South Latitude  (PAID, mapbounds mode)",
            "type": "string",
            "description": "Southern boundary latitude."
          },
          "east": {
            "title": "🧭 East Longitude  (PAID, mapbounds mode)",
            "type": "string",
            "description": "Eastern boundary longitude."
          },
          "west": {
            "title": "🧭 West Longitude  (PAID, mapbounds mode)",
            "type": "string",
            "description": "Western boundary longitude."
          },
          "offmarketZip": {
            "title": "📮 Off-market ZIP  (PAID, offmarket mode)",
            "type": "string",
            "description": "ZIP code to scan for off-market inventory. Only ZIP is supported by the upstream endpoint."
          },
          "listingStatus": {
            "title": "🏷 Listing Status  (required for non-URL modes)",
            "enum": [
              "For_Sale",
              "For_Rent",
              "Sold"
            ],
            "type": "string",
            "description": "Required by Zillow's upstream API for address, MLS, polygon, coordinates, mapbounds modes. Defaults to For_Sale. Ignored in URL mode (the URL itself encodes status) and offmarket mode.",
            "default": "For_Sale"
          },
          "maxResultsPerQuery": {
            "title": "📊 Max results per query",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "📊 Hard cap on properties returned per query. We auto-paginate until this cap is reached or the search is fully drained. Default is 40 — chosen so a default click-Run always finishes in exactly ONE upstream API request (URL mode returns ~41/page, geo modes return up to 200/page). Increase to scrape more pages. The total available count is reported in 'Search Totals' regardless of this cap. FREE tier is always capped at 25.",
            "default": 40
          },
          "startPage": {
            "title": "📄 Start Page",
            "minimum": 1,
            "type": "integer",
            "description": "📄 Page number to start pagination from. Default 1 (first page). Useful for resuming long searches or skipping already-processed pages. In url mode, if a URL ends with /N_p/ that suffix is honored when this field is left at 1.",
            "default": 1
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}