{ "openapi": "3.0.1", "info": { "title": "Zumper Scraper with Contacts | Fast & Reliable", "description": "Extract Zumper rental listings at scale with rich property detail, contact data, ratings, fees, amenities, and flexible market filters. Built for enterprise-grade US rental intelligence, lead enrichment, market monitoring, and automated analytics pipelines.", "version": "0.0", "x-build-id": "ydLyVrGPhwFzjB39G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~zumper-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~zumper-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~zumper-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": [ "location" ], "properties": { "location": { "title": "Choose Search Locations", "type": "array", "description": "Enter one or more locations. Examples: Austin, TX; 10001; Chelsea, New York, NY; Brooklyn, NY; Downtown Austin; West Hollywood, CA. Each location is searched separately.", "items": { "type": "string" } }, "min_price": { "title": "Set Minimum Monthly Rent", "minimum": 0, "type": "integer", "description": "Only save listings with monthly rent at or above this amount." }, "max_price": { "title": "Set Maximum Monthly Rent", "minimum": 0, "type": "integer", "description": "Only save listings with monthly rent at or below this amount." }, "price_category": { "title": "Choose Price Category", "enum": [ "cheap", "luxury" ], "type": "string", "description": "Optionally focus the search on Zumper listings marked as affordable or luxury." }, "min_area": { "title": "Set Minimum Square Feet", "minimum": 0, "type": "integer", "description": "Only save listings with at least this much floor area." }, "min_bedroom": { "title": "Set Minimum Bedrooms", "enum": [ "studio", "1", "2", "3", "4+" ], "type": "string", "description": "Only save listings with at least this bedroom count." }, "max_bedroom": { "title": "Set Maximum Bedrooms", "enum": [ "studio", "1", "2", "3", "4+" ], "type": "string", "description": "Only save listings with no more than this bedroom count." }, "min_bathroom": { "title": "Set Minimum Bathrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Only save listings with at least this bathroom count." }, "max_bathroom": { "title": "Set Maximum Bathrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Only save listings with no more than this bathroom count." }, "property_type": { "title": "Choose Property Types", "uniqueItems": true, "type": "array", "description": "Select one or more property types to include. Leave empty to keep all supported property types in scope.", "items": { "type": "string", "enum": [ "apartment", "condo", "house", "room", "townhouse", "other" ], "enumTitles": [ "Apartment", "Condo", "House", "Room", "Townhouse", "Other" ] } }, "pets_allowed": { "title": "Choose Allowed Pets", "uniqueItems": true, "type": "array", "description": "Only save listings that allow the selected pet types.", "items": { "type": "string", "enum": [ "dogs", "cats" ], "enumTitles": [ "Dogs", "Cats" ] } }, "laundry": { "title": "Choose Laundry Options", "uniqueItems": true, "type": "array", "description": "Only save listings that match the selected laundry setup.", "items": { "type": "string", "enum": [ "in_building", "in_unit" ], "enumTitles": [ "In building", "In unit" ] } }, "listing_features": { "title": "Choose Listing Features", "uniqueItems": true, "type": "array", "description": "Only save listings that match selected listing-level signals such as photos, tours, new construction, or same-day posting.", "items": { "type": "string", "enum": [ "3d_tour_or_video_tour", "has_photos", "live_virtual_walkthrough", "new_construction", "posted_today" ], "enumTitles": [ "3D tour or video tour", "Has photos", "Live virtual walkthrough", "New construction", "Posted today" ] } }, "amenities": { "title": "Choose Amenities", "uniqueItems": true, "type": "array", "description": "Only save listings that include the selected apartment or building amenities.", "items": { "type": "string", "enum": [ "air_conditioning", "assigned_parking", "central_heat", "dishwasher", "garage_parking", "hardwood_floor", "pool", "balcony", "business_center", "carpet", "ceiling_fan", "concierge_service", "controlled_access", "deck", "door_person", "dry_cleaning_service", "elevator", "ev_charging", "fireplace", "furnished", "garden", "gym", "high_ceilings", "leed_certified", "on_site_management", "outdoor_space", "package_service", "residents_lounge", "roof_deck", "storage", "tv", "walk_in_closet", "wheelchair_accessible", "wi_fi" ], "enumTitles": [ "Air conditioning", "Assigned parking", "Central heat", "Dishwasher", "Garage parking", "Hardwood floor", "Pool", "Balcony", "Business center", "Carpet", "Ceiling fan", "Concierge service", "Controlled access", "Deck", "Door person", "Dry cleaning service", "Elevator", "EV charging", "Fireplace", "Furnished", "Garden", "Gym", "High ceilings", "LEED certified", "On site management", "Outdoor space", "Package service", "Residents lounge", "Roof deck", "Storage", "TV", "Walk-in closet", "Wheelchair accessible", "Wi-fi" ] } }, "lease_length": { "title": "Choose Lease Length", "enum": [ "short_term", "long_term" ], "type": "string", "description": "Only save listings that match the selected lease length." }, "publication_date": { "title": "Choose Listing Age", "enum": [ "last_24_hours", "last_7_days", "last_2_weeks", "last_1_month" ], "type": "string", "description": "Only include listings first published within the selected timeframe." }, "deals": { "title": "Choose Deal Signals", "uniqueItems": true, "type": "array", "description": "Only save listings that match the selected deal or savings signals.", "items": { "type": "string", "enum": [ "rent_special", "no_security_deposit", "price_drop", "sweet_deal", "utilities_included" ], "enumTitles": [ "Rent special", "No security deposit", "Price drop", "Sweet deal", "Utilities included" ] } }, "highly_rated": { "title": "Require Highly Rated Listings", "type": "boolean", "description": "Turn this on to save only listings with a rating of at least 4 where rating data is available.", "default": false }, "zumper_expert_rating": { "title": "Set Minimum Zumper Rating", "enum": [ "9+", "7+", "5+" ], "type": "string", "description": "Only save listings with a Zumper expert rating at or above the selected threshold." }, "lifestyle": { "title": "Choose Lifestyle Tags", "uniqueItems": true, "type": "array", "description": "Only save listings that match the selected lifestyle tags.", "items": { "type": "string", "enum": [ "eco_living", "pet_owners", "social_life", "wellness", "work_from_home" ], "enumTitles": [ "Eco-living", "Pet owners", "Social life", "Wellness", "Work-from-home" ] } }, "specialty_housing": { "title": "Choose Specialty Housing", "uniqueItems": true, "type": "array", "description": "Only save listings that match the selected specialty housing categories.", "items": { "type": "string", "enum": [ "55_plus_community", "student_housing", "income_restricted" ], "enumTitles": [ "55+ communities", "Student housing", "Income restricted" ] } }, "sort_by": { "title": "Choose Sort Order", "enum": [ "most_relevant", "newest_first", "price_low_to_high", "price_high_to_low", "rating_low_to_high", "rating_high_to_low" ], "type": "string", "description": "Select the order used for matching Zumper rental listings.", "default": "most_relevant" }, "enrich_data": { "title": "Collect Richer Listing and Agent Details", "type": "boolean", "description": "Enable this to collect more complete listing details such as descriptions, media, amenities, policies, and contact information when available. Keep it off for faster validation runs when standard search results are enough.", "default": false }, "limit": { "title": "Set Maximum Results per Location", "minimum": 1, "type": "integer", "description": "Optional cap on how many listings to save for each selected location and filter set. Leave empty to collect as many matching results as available." } } }, "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 } } } } } } } } } }