{ "openapi": "3.0.1", "info": { "title": "Zumper Scraper — US Apartments & Houses for Rent", "description": "Scrape Zumper rental listings by US city, Zumper search URL, or ZIP-adjacent area: rent price range, beds, baths, square feet, address, geo, building name, images, and listing URL. Auto-paginates past Zumper's 200-per-view cap via map-tiling. HTTP-only, fast, no login. PPE. MCP-ready.", "version": "1.0", "x-build-id": "FaJWHCWuqOHUchqoK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~zumper-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-zumper-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/khadinakbar~zumper-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-zumper-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/khadinakbar~zumper-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-zumper-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 (US city)", "type": "string", "description": "A US city to pull rental listings for, as \"City, ST\" or \"City, State\" (e.g. 'Austin, TX'). A Zumper city slug like 'austin-tx' also works. Leave empty if you provide Start URLs instead. This is NOT a street address or ZIP code — it targets a whole city." }, "startUrls": { "title": "Zumper search URLs", "type": "array", "description": "One or more Zumper search-page URLs to scrape (e.g. 'https://www.zumper.com/apartments-for-rent/austin-tx' or '/houses-for-rent/miami-fl'). Each resolves to a city and is merged with the Location field. Use this to batch several cities in one run. NOT individual property URLs.", "items": { "type": "string" } }, "maxResults": { "title": "Max listings", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of listings to return across all locations, used to cap cost. Defaults to 200; range 1–20000. Big cities can exceed this, so raise it to go deeper (map-tiling paginates automatically). Billing is capped at this number.", "default": 200 }, "minPrice": { "title": "Min rent (USD/mo)", "minimum": 0, "type": "integer", "description": "Keep only listings whose rent range reaches at least this monthly amount in USD (e.g. 1500). Applied to each listing's price range after fetch. Leave empty for no minimum. NOT an exact-match filter — a listing passes if any of its floorplans could match." }, "maxPrice": { "title": "Max rent (USD/mo)", "minimum": 0, "type": "integer", "description": "Keep only listings whose rent range starts at or below this monthly amount in USD (e.g. 3000). Applied to each listing's price range after fetch. Leave empty for no maximum. Combine with Min rent for a band." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Keep only listings offering at least this many bedrooms (e.g. 2). Studios count as 0. Leave empty for any size. Matches on the listing's maximum available bedroom count." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Keep only listings offering at most this many bedrooms (e.g. 3). Leave empty for any size. Combine with Min bedrooms to target a specific unit size." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Zumper's API responds from datacenter IPs, so the default Apify datacenter US proxy is fine and cheapest. Override only if you hit intermittent blocks. Residential is rarely needed.", "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 } } }, "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 } } } } } } } } } }