{ "openapi": "3.0.1", "info": { "title": "Zumper Scraper — Rentals, Buildings & Rent Data", "description": "Extract rental listings, building details, and rent-market data from Zumper — apartments, houses, condos, and rooms with prices, amenities, photos, floorplan units, and 24-month rent trends.", "version": "0.0", "x-build-id": "unSi5QuPgLclrAdqc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shhh_lab~apify-zumper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shhh_lab-apify-zumper", "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/shhh_lab~apify-zumper/runs": { "post": { "operationId": "runs-sync-shhh_lab-apify-zumper", "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/shhh_lab~apify-zumper/run-sync": { "post": { "operationId": "run-sync-shhh_lab-apify-zumper", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "SEARCH", "DETAIL", "RENT_RESEARCH" ], "type": "string", "description": "What to scrape:\n- **SEARCH** — city listing pages (apartments, houses, condos, rooms) with pagination.\n- **DETAIL** — individual building pages (full description + every floorplan unit). Requires Start URLs.\n- **RENT_RESEARCH** — market rent data (median/average rent, 24-month trends, rent distribution).", "default": "SEARCH" }, "startUrls": { "title": "Start URLs (DETAIL mode)", "type": "array", "description": "Zumper building/listing page URLs to scrape in **DETAIL** mode, e.g. `https://www.zumper.com/apartment-buildings/p1528434/the-highland-east-new-york-new-york-ny`. Ignored in SEARCH and RENT_RESEARCH modes.", "items": { "type": "string" }, "default": [] }, "cities": { "title": "Cities", "type": "array", "description": "City slugs to scrape in SEARCH and RENT_RESEARCH modes. Format: `{city-name-hyphenated}-{state-abbrev-lowercase}` — e.g. `new-york-ny`, `los-angeles-ca`, `chicago-il`, `austin-tx`.", "items": { "type": "string" }, "default": [ "new-york-ny" ] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Property types to scrape in SEARCH mode.", "items": { "type": "string", "enum": [ "apartments", "houses", "condos", "rooms" ], "enumTitles": [ "Apartments", "Houses", "Condos", "Rooms" ] }, "default": [ "apartments" ] }, "maxPages": { "title": "Max pages per city + property type", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of search-result pages to scrape per city + property-type combination (25 listings per page). Zumper reports thousands of matches per city, so this is the main cost control.", "default": 10 }, "includeNeighborhoods": { "title": "Include neighborhoods", "type": "boolean", "description": "Also enumerate and scrape every neighborhood within each city. Greatly increases coverage and request count. Duplicate listings (same unit appearing in the city and a neighborhood view) are pushed only once.", "default": false }, "includeMarketData": { "title": "Include market data", "type": "boolean", "description": "In SEARCH mode, also scrape the rent-research page for each city (median rent, averages, 24-month history and rent distribution by bedroom count).", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of browser pages open in parallel. Higher is faster but uses more memory and is more likely to trigger rate limiting.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended — datacenter IPs are challenged far more aggressively by Zumper's anti-bot layer.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }