{ "openapi": "3.0.1", "info": { "title": "Zillow Rentals Scraper: Rent Listings by City or ZIP | $1/1K", "description": "$1 per 1,000 results, platform usage included. Public for rent listings from Zillow for any US city, ZIP code, neighborhood or Zillow search link: monthly rent, beds, baths, size, floor plan rents for apartment communities, move in date, address, map position and listing link.", "version": "0.1", "x-build-id": "TeYapHEnLQucxm5mO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one_dollar_store~zillow-rentals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one_dollar_store-zillow-rentals-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/one_dollar_store~zillow-rentals-scraper/runs": { "post": { "operationId": "runs-sync-one_dollar_store-zillow-rentals-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/one_dollar_store~zillow-rentals-scraper/run-sync": { "post": { "operationId": "run-sync-one_dollar_store-zillow-rentals-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": "Cities, ZIP codes or neighborhoods", "type": "array", "description": "Places to search, one per line, written the way you would type them into Zillow, for example \"Denver, CO\", \"10001\" or \"Capitol Hill, Seattle, WA\".", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search links", "type": "array", "description": "Optional. Paste the link from your browser's address bar after setting up a rental search on zillow.com. The area and filters in the link are kept; the filters below are added on top when you set them.", "items": { "type": "string" } }, "rentalType": { "title": "Rental type", "enum": [ "any", "houses", "townhomes", "apartments" ], "type": "string", "description": "Zillow groups rentals three ways. Apartments includes condos and apartment communities.", "default": "any" }, "minRent": { "title": "Lowest monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Leave empty for no lower limit." }, "maxRent": { "title": "Highest monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Leave empty for no upper limit." }, "minBeds": { "title": "Bedrooms, at least", "minimum": 0, "maximum": 10, "type": "integer", "description": "Leave empty to include studios." }, "minBaths": { "title": "Bathrooms, at least", "minimum": 0, "maximum": 10, "type": "integer", "description": "Leave empty for any number." }, "maxItems": { "title": "Maximum results", "minimum": 10, "maximum": 100000, "type": "integer", "description": "The run stops after this many rentals in total, across all places. Zillow shows about the first 1,000 rentals of any one search, so split a big city into ZIP codes to get more. Minimum 10.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Zillow shows a bot check to most data center addresses, so US residential proxy is the default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }