{
  "openapi": "3.0.1",
  "info": {
    "title": "Real-Time Zillow Data API",
    "description": "Fast and reliable real-estate data API for the U.S. and Canada - search properties by address or coordinates, full property details, estimated market valuations, agent search and listings, and more in real-time.",
    "version": "1.0",
    "x-build-id": "MKronmnUP2n2vYwod"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/openweb-ninja~real-time-zillow-data/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-openweb-ninja-real-time-zillow-data",
        "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/openweb-ninja~real-time-zillow-data/runs": {
      "post": {
        "operationId": "runs-sync-openweb-ninja-real-time-zillow-data",
        "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/openweb-ninja~real-time-zillow-data/run-sync": {
      "post": {
        "operationId": "run-sync-openweb-ninja-real-time-zillow-data",
        "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",
        "required": [
          "endpoint"
        ],
        "properties": {
          "endpoint": {
            "title": "Endpoint",
            "enum": [
              "/search",
              "/search-coordinates",
              "/search-polygon",
              "/property-details",
              "/property-details-address",
              "/zestimate",
              "/agent-search",
              "/agent-properties-for-rent",
              "/agent-properties-for-sale",
              "/agent-properties-sold"
            ],
            "type": "string",
            "description": "Which endpoint of the API to call. Each endpoint uses the parameters listed in its section below; parameters of other endpoints are ignored.",
            "default": "/search"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "<br><br><em>Used by: Search, Agent Search. Required for Search, Agent Search.</em>",
            "default": "Los Angeles, CA"
          },
          "page": {
            "title": "Page",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon, Agent Search, Agent Properties (For Rent), Agent Properties (For Sale), Agent Properties (Sold).</em>"
          },
          "home_status": {
            "title": "Home status",
            "enum": [
              "FOR_SALE",
              "FOR_RENT",
              "RECENTLY_SOLD"
            ],
            "type": "string",
            "description": "Filters properties based on their status.<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": "FOR_SALE"
          },
          "home_type": {
            "title": "Home type",
            "type": "string",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "space_type": {
            "title": "Space type",
            "type": "string",
            "description": "Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: <code>ENTIRE_PLACE</code>, <code>ROOM</code>.<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "sort": {
            "title": "Sort",
            "type": "string",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_price": {
            "title": "Min price",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_price": {
            "title": "Max price",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_monthly_payment": {
            "title": "Min monthly payment",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_monthly_payment": {
            "title": "Max monthly payment",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_bedrooms": {
            "title": "Min bedrooms",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_bedrooms": {
            "title": "Max bedrooms",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_bathrooms": {
            "title": "Min bathrooms",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_bathrooms": {
            "title": "Max bathrooms",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_sqft": {
            "title": "Min sqft",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_sqft": {
            "title": "Max sqft",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "min_lot_size": {
            "title": "Min lot size",
            "type": "integer",
            "description": "Sets the minimum lot size for properties (in square feet).<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "max_lot_size": {
            "title": "Max lot size",
            "type": "integer",
            "description": "Sets the minimum lot size for properties (in square feet).<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "listing_type": {
            "title": "Listing type",
            "type": "string",
            "description": "Listing type of the property. (<code>BY_OWNER_OTHER</code> is for off market properties).<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "for_sale_by_agent": {
            "title": "For sale by agent",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "for_sale_by_owner": {
            "title": "For sale by owner",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "for_sale_is_new_construction": {
            "title": "For sale is new construction",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "for_sale_is_foreclosure": {
            "title": "For sale is foreclosure",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "for_sale_is_auction": {
            "title": "For sale is auction",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "for_sale_is_foreclosed": {
            "title": "For sale is foreclosed",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": false
          },
          "for_sale_is_preforeclosure": {
            "title": "For sale is preforeclosure",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": false
          },
          "max_hoa_fee": {
            "title": "Max hoa fee",
            "type": "integer",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>"
          },
          "includes_homes_no_hoa_data": {
            "title": "Includes homes no hoa data",
            "type": "boolean",
            "description": "<br><br><em>Used by: Search, Search by Coordinates, Search by Polygon.</em>",
            "default": true
          },
          "long": {
            "title": "Long",
            "type": "integer",
            "description": "<br><br><em>Used by: Search by Coordinates. Required for Search by Coordinates.</em>"
          },
          "lat": {
            "title": "Lat",
            "type": "integer",
            "description": "<br><br><em>Used by: Search by Coordinates. Required for Search by Coordinates.</em>"
          },
          "diameter": {
            "title": "Diameter",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "<br><br><em>Used by: Search by Coordinates.</em>"
          },
          "polygon": {
            "title": "Polygon",
            "type": "string",
            "description": "<br><br><em>Used by: Search by Polygon. Required for Search by Polygon.</em>"
          },
          "zpid": {
            "title": "Zpid",
            "type": "string",
            "description": "<br><br><em>Used by: Property Details, Property Zestimate. Required for Property Zestimate.</em>"
          },
          "url": {
            "title": "Url",
            "type": "string",
            "description": "<br><br><em>Used by: Property Details, Property Zestimate.</em>"
          },
          "address": {
            "title": "Address",
            "type": "string",
            "description": "<br><br><em>Used by: Property by Address. Required for Property by Address.</em>"
          },
          "name": {
            "title": "Name",
            "type": "string",
            "description": "<br><br><em>Used by: Agent Search.</em>"
          },
          "encodedZuid": {
            "title": "EncodedZuid",
            "type": "string",
            "description": "<br><br><em>Used by: Agent Properties (For Rent), Agent Properties (For Sale), Agent Properties (Sold). Required for Agent Properties (For Rent), Agent Properties (For Sale), Agent Properties (Sold).</em>"
          },
          "include_team": {
            "title": "Include team",
            "type": "boolean",
            "description": "<br><br><em>Used by: Agent Properties (For Rent), Agent Properties (For Sale).</em>",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}