{ "openapi": "3.0.1", "info": { "title": "ZAP Imóveis Scraper | Fast & Reliable", "description": "Extract structured Brazil property listings from ZAP Imoveis with pricing, locations, seller details, media assets, and contact data. Built for enterprise-grade Brazil real estate intelligence, listing monitoring, lead enrichment and automated analytics pipelines.", "version": "0.1", "x-build-id": "Ik2P73otwZelKtGhN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~zap-imoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-zap-imoveis-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~zap-imoveis-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-zap-imoveis-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~zap-imoveis-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-zap-imoveis-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": { "deal_type": { "title": "Choose Sale or Rental Listings", "enum": [ "sale", "rent" ], "type": "string", "description": "Select whether this run should collect properties offered for sale or properties offered for rent.", "default": "sale" }, "location": { "title": "Enter a Brazilian Search Location", "type": "string", "description": "Enter a city, neighborhood, district, avenue, street, or similar place name in Brazil. Examples: `Sao Paulo`, `Rio de Janeiro`, `Pinheiros`, or `Estrada de Pau-Ferro`." }, "property_type": { "title": "Select Property Types", "uniqueItems": true, "type": "array", "description": "Choose one or more property types to include. Leave empty to collect listings across all available property categories for the selected location and transaction type.", "items": { "type": "string", "enum": [ "apartment", "studio", "kitnet", "house", "gated_house", "villa_house", "penthouse", "flat", "loft", "residential_land", "townhouse", "farm", "store", "office", "commercial_house", "hotel", "corporate_floor", "building", "commercial_land", "storage", "garage" ], "enumTitles": [ "🏠 Apartamento | Apartment", "🏠 Studio | Studio", "🏠 Kitnet | Studio apartment", "🏠 Casa | House", "🏠 Casa de Condomínio | Gated community house", "🏠 Casa de Vila | Villa house", "🏠 Cobertura | Penthouse", "🏠 Flat | Serviced apartment", "🏠 Loft | Loft", "🏠 Terreno / Lote / Condomínio | Land / Plot / Condominium lot", "🏠 Sobrados | Townhouse", "🏠 Fazenda / Sítio / Chácara | Farm / Country house", "🏢 Loja / Salão / Ponto Comercial | Store / Shop / Commercial space", "🏢 Conjunto Comercial / Sala | Commercial office / Room", "🏢 Casa Comercial | Commercial house", "🏢 Hotel / Motel / Pousada | Hotel / Motel / Guesthouse", "🏢 Andar / Laje Corporativa | Corporate floor / Office floor", "🏢 Prédio Inteiro | Entire building", "🏢 Terrenos / Lotes Comerciais | Commercial land / Plots", "🏢 Galpão / Depósito / Armazém | Warehouse / Storage / Depot", "🏢 Garagem | Garage" ] } }, "property_features": { "title": "Select Required Property Features", "uniqueItems": true, "type": "array", "description": "Choose features that listings should include, such as air conditioning, furniture, balcony, or pet permission. Leave empty when these amenities should not narrow the result set.", "items": { "type": "string", "enum": [ "pets_allowed", "heating", "air_conditioning", "service_area", "built_in_wardrobe", "built_in_wardrobe_in_the_bedroom", "kitchen_cabinet", "bathroom_cabinet", "blindex_box", "closet", "internet_connection", "american_kitchen", "deposit", "office", "intercom", "large_window", "fireplace", "furnished", "backyard", "cable_tv", "balcony", "gourmet_balcony" ], "enumTitles": [ "Pets allowed", "Heating", "Air conditioning", "Service area", "Built-in wardrobe", "Built-in wardrobe in the bedroom", "Kitchen cabinet", "Bathroom cabinet", "Blindex box", "Closet", "Internet connection", "American kitchen", "Deposit", "Office", "Intercom", "Large window", "Fireplace", "Furnished", "Backyard", "Cable TV", "Balcony", "Gourmet balcony" ] } }, "leisure_and_sports": { "title": "Select Leisure and Sports Amenities", "uniqueItems": true, "type": "array", "description": "Choose amenities such as a pool, gym, playground, sports court, party hall, or garden. Leave empty to avoid excluding listings based on leisure facilities.", "items": { "type": "string", "enum": [ "academy", "barbecue_grill", "cinema", "gourmet_space", "green_space_park", "garden", "swimming_pool", "jogging_track", "playground", "squash_court", "tennis_court", "multi_sports_court", "party_hall", "games_room" ], "enumTitles": [ "Academy", "Barbecue grill", "Cinema", "Gourmet space", "Green space / Park", "Garden", "Swimming pool", "Jogging track", "Playground", "Squash court", "Tennis court", "Multi-sports court", "Party hall", "Games room" ] } }, "condo_amenities": { "title": "Select Building and Condo Amenities", "uniqueItems": true, "type": "array", "description": "Choose shared amenities such as elevator, garage, laundry, coworking, sauna, spa, or bicycle parking. Leave empty when building facilities should not restrict collection.", "items": { "type": "string", "enum": [ "accessibility_for_disabled_people", "bicycle_parking", "coworking", "kitchen", "elevator", "garage", "electric_generator", "laundry", "sauna", "spa" ], "enumTitles": [ "Accessibility for disabled people", "Bicycle parking", "Coworking", "Kitchen", "Elevator", "Garage", "Electric generator", "Laundry", "Sauna", "Spa" ] } }, "security_amenities": { "title": "Select Security Amenities", "uniqueItems": true, "type": "array", "description": "Choose security features such as gated community, electronic gate, alarm system, security circuit, concierge service, or watchman. Leave empty to keep security features optional.", "items": { "type": "string", "enum": [ "security_circuit", "gated_community", "electronic_gate", "twenty_four_hour_concierge_service", "alarm_system", "watchman" ], "enumTitles": [ "Security circuit", "Gated community", "Electronic gate", "24-hour concierge service", "Alarm system", "Watchman" ] } }, "min_bedroom": { "title": "Set Minimum Bedrooms", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the minimum bedroom count a listing should have. For example, `2+` includes properties with 2 or more bedrooms." }, "min_bathroom": { "title": "Set Minimum Bathrooms", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the minimum bathroom count a listing should have. For example, `2+` includes properties with 2 or more bathrooms." }, "min_parking": { "title": "Set Minimum Parking Spaces", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the minimum number of parking spaces a listing should have. For example, `1+` includes properties with 1 or more spaces." }, "min_price": { "title": "Set Minimum Price", "minimum": 0, "type": "integer", "description": "Enter the lowest listing price to include, using whole Brazilian real amounts. For example, `400000` keeps listings priced at 400,000 BRL and above." }, "max_price": { "title": "Set Maximum Price", "minimum": 0, "type": "integer", "description": "Enter the highest listing price to include, using whole Brazilian real amounts. For example, `3000000` keeps listings priced at 3,000,000 BRL and below." }, "min_sqm": { "title": "Set Minimum Usable Area", "minimum": 0, "type": "integer", "description": "Enter the smallest usable area to include in square meters. For example, `35` keeps listings with 35 square meters or more." }, "max_sqm": { "title": "Set Maximum Usable Area", "minimum": 0, "type": "integer", "description": "Enter the largest usable area to include in square meters. For example, `100` keeps listings with 100 square meters or less." }, "near_transit": { "title": "Show Only Listings Near Transit", "type": "boolean", "description": "Enable this to keep only listings marked as close to metro, train, or other public transit access.", "default": false }, "below_market_price": { "title": "Show Only Below-Market Deals", "type": "boolean", "description": "Enable this to keep only listings that ZAP Imoveis labels as below-market price.", "default": false }, "limit": { "title": "Set a Maximum Number of Results", "minimum": 1, "type": "integer", "description": "Enter the maximum number of listings to save. Leave empty when you do not want to apply an explicit result cap to the configured search." }, "maximize_coverage": { "title": "Collect Beyond the Visible Cap", "type": "boolean", "description": "Keep this enabled for large searches that may exceed the visible result cap. Turn it off for faster exploratory runs where a smaller sample of matching listings is enough.", "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 } } }, "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 } } } } } } } } } }