{ "openapi": "3.0.1", "info": { "title": "Zillow.com Realtime Scraper", "description": "Scrapes any data-set from Zillow.com in realtime", "version": "0.0", "x-build-id": "HXeq2UwmrkPDJG4db" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammad_usama~apify-zillow/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammad_usama-apify-zillow", "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/muhammad_usama~apify-zillow/runs": { "post": { "operationId": "runs-sync-muhammad_usama-apify-zillow", "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/muhammad_usama~apify-zillow/run-sync": { "post": { "operationId": "run-sync-muhammad_usama-apify-zillow", "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": [ "endpointKey" ], "properties": { "endpointKey": { "title": "Select Endpoint", "enum": [ "search:bylocation", "search:byurl", "search:bymlsid", "search:bypolygon", "search:bycoordinates", "search:bymapbounds", "search:autocomplete", "property-details:byzpid", "property-details:byurl", "property-details:byaddress", "property-info:comparable-homes", "property-info:similar-homes", "property-info:nearby-homes", "property-info:climate", "property-info:price-history", "property-info:tax-history", "property-info:schools-info", "property-info:photos", "property-info:walk-transit-bike", "property-info:apartment-details", "graph-charts:zestimate-history", "graph-charts:rent-zestimate-history", "graph-charts:zestimate-percent-change", "graph-charts:listing-price", "graph-charts:tax-assessment-history", "graph-charts:tax-paid-history", "agents:bylocation", "agents:agent-info", "agents:agent-reviews", "agents:for-sale-properties", "agents:for-rent-properties", "agents:sold-properties", "analysis:housing-market", "analysis:rental-market", "lenders:search-bylocation", "lenders:search-byname", "lenders:details-byscreenName", "lenders:reviews-bylenderId", "builders:search-bylocation", "builders:search-byname", "builders:details", "builders:community-cards", "builders:reviews", "other-professionals:search-bylocation", "other-professionals:search-byname", "other-professionals:details-byusername", "other-professionals:reviews-byzuid", "mortgage-rates:current" ], "type": "string", "description": "Choose the endpoint to fetch data." }, "locations": { "title": "Locations", "type": "array", "description": "Used when endpoint requires locations", "items": { "type": "string" } }, "mlsids": { "title": "MLS IDs", "type": "array", "description": "Required for search:bymlsid", "items": { "type": "string" } }, "polygons": { "title": "Polygons", "type": "array", "description": "Required for search:bypolygon", "items": { "type": "string" } }, "coordinates": { "title": "Coordinates", "type": "array", "description": "Required for search:bycoordinates (lat,lng)", "items": { "type": "string" } }, "bounds": { "title": "Map Bounds", "type": "array", "description": "Required for search:bymapbounds (north,south,east,west)", "items": { "type": "string" } }, "queries": { "title": "Autocomplete Queries", "type": "array", "description": "Used when endpoint requires search queries", "items": { "type": "string" } }, "zpids": { "title": "ZPIDs", "type": "array", "description": "Used when endpoint requires ZPIDs", "items": { "type": "string" } }, "urls": { "title": "URLs", "type": "array", "description": "Used when endpoint requires URLs", "items": { "type": "string" } }, "addresses": { "title": "Addresses", "type": "array", "description": "Used when endpoint requires addresses", "items": { "type": "string" } }, "agentNames": { "title": "Agent Names", "type": "array", "description": "Used for agent-related endpoints", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Used for market analysis endpoints", "items": { "type": "string" } }, "names": { "title": "Names", "type": "array", "description": "Used for lender, builder, or other professional endpoints", "items": { "type": "string" } }, "screenNames": { "title": "Screen Names", "type": "array", "description": "Used for lender details by screen name", "items": { "type": "string" } }, "lenderIds": { "title": "Lender IDs", "type": "array", "description": "Used for lender reviews by ID", "items": { "type": "string" } }, "builderIds": { "title": "Builder IDs", "type": "array", "description": "Used for builder details, reviews, and community cards", "items": { "type": "string" } }, "usernames": { "title": "Usernames", "type": "array", "description": "Used for other professional details by username", "items": { "type": "string" } }, "zuids": { "title": "ZUIDs", "type": "array", "description": "Used for other professional reviews by ZUID", "items": { "type": "string" } }, "page": { "title": "Page Number", "type": "string", "description": "Optional" }, "pageSize": { "title": "Page Size", "type": "string", "description": "Optional" }, "listType": { "title": "Listing Type", "type": "array", "description": "Optional", "items": { "type": "string", "enum": [ "for-sale", "for-rent", "sold" ] } }, "baths": { "title": "Bathrooms", "type": "string", "description": "Optional" }, "beds": { "title": "Bedrooms", "type": "string", "description": "Optional" }, "minPrice": { "title": "Min Price", "type": "string", "description": "Optional" }, "maxPrice": { "title": "Max Price", "type": "string", "description": "Optional" }, "minSqft": { "title": "Min Sqft", "type": "string", "description": "Optional" }, "maxSqft": { "title": "Max Sqft", "type": "string", "description": "Optional" }, "minLot": { "title": "Min Lot Size", "type": "string", "description": "Optional" }, "maxLot": { "title": "Max Lot Size", "type": "string", "description": "Optional" }, "minBuilt": { "title": "Min Year Built", "type": "string", "description": "Optional" }, "maxBuilt": { "title": "Max Year Built", "type": "string", "description": "Optional" }, "maxHOA": { "title": "Max HOA Fee", "type": "string", "description": "Optional" }, "parkingSpots": { "title": "Parking Spots", "type": "string", "description": "Optional" }, "daysOnZillow": { "title": "Days on Zillow", "type": "string", "description": "Optional" }, "isBasementFinished": { "title": "Finished Basement", "type": "boolean", "description": "Optional" }, "isBasementUnfinished": { "title": "Unfinished Basement", "type": "boolean", "description": "Optional" }, "isCityView": { "title": "City View", "type": "boolean", "description": "Optional" }, "isMountainView": { "title": "Mountain View", "type": "boolean", "description": "Optional" }, "isParkView": { "title": "Park View", "type": "boolean", "description": "Optional" }, "isWaterView": { "title": "Water View", "type": "boolean", "description": "Optional" }, "is3dHome": { "title": "3D Home Available", "type": "boolean", "description": "Optional" }, "hasPool": { "title": "Pool", "type": "boolean", "description": "Optional" }, "hasGarage": { "title": "Garage", "type": "boolean", "description": "Optional" }, "isTownhouse": { "title": "Townhouse", "type": "boolean", "description": "Optional" }, "isLotLand": { "title": "Lot / Land", "type": "boolean", "description": "Optional" }, "isManufactured": { "title": "Manufactured Home", "type": "boolean", "description": "Optional" }, "isApartmentOrCondo": { "title": "Apartment or Condo", "type": "boolean", "description": "Optional" }, "isApartment": { "title": "Apartment", "type": "boolean", "description": "Optional" }, "isCondo": { "title": "Condo", "type": "boolean", "description": "Optional" }, "isSingleFamily": { "title": "Single Family", "type": "boolean", "description": "Optional" }, "isMultiFamily": { "title": "Multi Family", "type": "boolean", "description": "Optional" }, "isOpenHousesOnly": { "title": "Open Houses Only", "type": "boolean", "description": "Optional" }, "isAuction": { "title": "Auction", "type": "boolean", "description": "Optional" }, "isComingSoon": { "title": "Coming Soon", "type": "boolean", "description": "Optional" }, "isForSaleForeclosure": { "title": "For Sale Foreclosure", "type": "boolean", "description": "Optional" }, "singleStory": { "title": "Single Story", "type": "boolean", "description": "Optional" }, "programs": { "title": "Programs", "type": "array", "description": "Optional", "items": { "type": "string", "enum": [ "ARM3", "ARM5", "ARM7", "Fixed10Year", "Fixed15Year", "Fixed20Year", "Fixed30Year" ] } }, "refinance": { "title": "Refinance", "type": "boolean", "description": "Used for mortgage rates endpoint" }, "state": { "title": "State", "type": "string", "description": "Used for mortgage rates endpoint" }, "zpidcode": { "title": "ZPID Code", "type": "string", "description": "Used for mortgage rates endpoint" }, "durationDays": { "title": "Duration Days", "type": "string", "description": "Used for mortgage rates endpoint" }, "creditScoreBucket": { "title": "Credit Score", "type": "array", "description": "Optional", "items": { "type": "string", "enum": [ "High", "VeryHigh" ] } }, "loanToValueBucket": { "title": "Loan Value", "type": "array", "description": "Optional", "items": { "type": "string", "enum": [ "Normal", "High", "VeryHigh" ] } }, "loanType": { "title": "Loan type", "type": "array", "description": "Optional", "items": { "type": "string", "enum": [ "Conventional", "FHA", "VA", "USDA", "Jumbo" ] } } } }, "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 } } } } } } } } } }