{ "openapi": "3.0.1", "info": { "title": "Zumper – Rental Listings, Prices & Agent Contacts", "description": "Scrape Zumper.com rental listings: apartments, houses, condos and rooms. Pulls 60+ fields per listing, including monthly rent, beds/baths, square footage, decoded amenities, agent name and phone, ratings, availability and full-resolution photos. Search by location with filters, or paste Zumper URLs.", "version": "1.0", "x-build-id": "58IEvTLiZIVcn3o1q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~zumper-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-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/abotapi~zumper-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-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/abotapi~zumper-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "search = build URLs from the filters below; url = pass through your own Zumper URLs.", "default": "search" }, "locations": { "title": "Locations", "uniqueItems": true, "type": "array", "description": "Search mode only. City, state, neighborhood or ZIP, e.g. \"San Francisco, CA\", \"new-york-ny\", \"Austin, TX\", or \"94110\". Multiple locations supported.", "items": { "type": "string" } }, "propertyCategory": { "title": "Property category", "enum": [ "apartments", "houses", "condos", "rooms" ], "type": "string", "description": "Search mode only. Which rental category to browse.", "default": "apartments" }, "minPrice": { "title": "Minimum rent (USD/mo)", "minimum": 0, "type": "integer", "description": "Search mode only. Keep listings priced at or above this monthly rent." }, "maxPrice": { "title": "Maximum rent (USD/mo)", "minimum": 0, "type": "integer", "description": "Search mode only. Keep listings priced at or below this monthly rent." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Search mode only. 0 = studio." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Search mode only." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Search mode only." }, "petsAllowed": { "title": "Pets allowed", "uniqueItems": true, "type": "array", "description": "Search mode only. Keep only listings that allow the selected pets.", "items": { "type": "string", "enum": [ "dogs", "cats" ], "enumTitles": [ "Dogs", "Cats" ] } }, "sortBy": { "title": "Sort by", "enum": [ "default", "price-asc", "price-desc", "newest", "rating-desc" ], "type": "string", "description": "Search mode only.", "default": "default" }, "urls": { "title": "Zumper URLs", "uniqueItems": true, "type": "array", "description": "URL mode only. Paste Zumper search-results URLs or individual building/listing URLs. Filter fields above are ignored. Search URLs continue from their page number onward.", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "Add full description, amenity groups, pet policy, parking, deposits, fees, lease terms, units / floorplans, full agent contacts and Zumper's category ratings + resident-feedback summary. The results page already returns ~70 fields including price, beds/baths, decoded amenities, agent name, phone, rating and photos, so leaving this off is faster and cheaper.", "default": false }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Results pages walked per location/URL. Leave empty to walk every result page (still bounded by Max listings). Pages stop early once Max listings is reached." }, "maxListings": { "title": "Max listings (total)", "minimum": 0, "type": "integer", "description": "Stop after this many listings across all searches. 0 = unlimited.", "default": 20 }, "resumeFromRunId": { "title": "Resume from a previous run (optional)", "type": "string", "description": "Paste a previous run ID or dataset ID to continue an unbounded walk across separate runs. Listings already collected there (matched by id) are skipped, so this run only saves the new ones. Leave empty for a normal fresh run." }, "proxy": { "title": "Connection", "type": "object", "description": "Runs on any Apify plan. Connections are managed automatically to keep results flowing. You may also supply your own proxy URLs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify Settings, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON; the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }