{ "openapi": "3.0.1", "info": { "title": "Zumper Scraper - US Rentals & Zillow Sale Listings", "description": "Collect US Zumper rentals and Zillow sale listings with prices, beds, baths, addresses, photos and available contact details. Export structured rows and pay per delivered row plus a start fee.", "version": "0.2", "x-build-id": "h2FSZYb1Xe5SmRmLm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~us-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-us-real-estate-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/lentic_clockss~us-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-us-real-estate-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/lentic_clockss~us-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-us-real-estate-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 and state to search, e.g. 'Tucson, AZ' or 'Phoenix, AZ'. Fill in this or Start URLs. If both are empty, the run collects a few example listings for Tucson, AZ." }, "startUrls": { "title": "Start URLs (detail mode)", "type": "array", "description": "Listing detail URLs from zillow.com or zumper.com to scrape directly. When filled, search is skipped and Location is ignored.", "items": { "type": "string" } }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum listing rows for the location or for each start URL. Zillow and Zumper share one location's allowance. The whole run also stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs.", "default": 70 }, "sites": { "title": "Sites to search", "type": "array", "description": "Sites to scrape. Zillow supports For Sale and Recently Sold; Zumper supports For Rent. When both are selected, the listing type automatically chooses the compatible site.", "items": { "type": "string", "enum": [ "zillow", "zumper" ], "enumTitles": [ "Zillow (for sale, recently sold)", "Zumper (for rent)" ] }, "default": [ "zumper" ] }, "listingType": { "title": "Listing type", "enum": [ "any", "sale", "rent", "sold" ], "type": "string", "description": "Filter by listing type. 'For Sale' and 'Recently Sold' use Zillow; 'For Rent' uses Zumper. If no selected site offers this type, the filter is skipped.", "default": "rent" }, "propertyType": { "title": "Property type", "enum": [ "any", "house", "condo", "townhouse", "apartment", "land" ], "type": "string", "description": "Filter by property type. Leave as Any for all types.", "default": "any" }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD (optional)." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD (optional)." }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "When true, enriches search results with detail page data (phones, agent, brokerage). Default: true.", "default": true }, "enrichDetails": { "title": "Enrich with details", "type": "boolean", "description": "Alias for scrapeDetails. When true, fetches detail pages for lead fields. Default: true.", "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 } } } } } } } } } }