{ "openapi": "3.0.1", "info": { "title": "Imovelweb Scraper", "description": "Scrape property listings from Imovelweb.com.br — Brazil's leading real estate portal. Extract prices, rooms, area, location, features, seller contacts, and images for sale, rent, and auction listings.", "version": "1.4", "x-build-id": "vTKDMO6ufbGbSJbMf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~imovelweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-imovelweb-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/parsebird~imovelweb-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-imovelweb-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/parsebird~imovelweb-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-imovelweb-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": "Deal type", "enum": [ "sale", "rent", "auction", "temporary", "newly_built" ], "type": "string", "description": "Overall listing intent to search for.", "default": "sale" }, "location": { "title": "Location", "type": "string", "description": "Place to search in Brazil — a city, neighborhood, district, avenue, or street. For best accuracy on cities, include the state, e.g. 'Sao Paulo, SP'.", "default": "Sao Paulo" }, "property_type": { "title": "Property type", "type": "array", "description": "Broad property categories to include. Leave empty to search all types.", "items": { "type": "string", "enum": [ "apartment", "house", "land", "commercial", "rural" ], "enumTitles": [ "Apartment", "House", "Land", "Commercial", "Rural" ] }, "default": [] }, "property_subtype": { "title": "Property subtype", "type": "array", "description": "More specific property formats to keep. Leave empty to include all subtypes.", "items": { "type": "string", "enum": [ "apartment_standard", "studio", "kitnet", "penthouse", "flat", "garden", "loft", "duplex", "house_standard", "gated_house", "townhouse", "villa_house", "condominium_land", "office", "commercial_point", "store", "garage_box", "commercial_house", "warehouse", "hotel", "building", "country_house", "farm" ], "enumTitles": [ "Apartment (standard)", "Studio", "Kitnet", "Penthouse", "Flat", "Garden apartment", "Loft", "Duplex", "House (standard)", "Gated house", "Townhouse", "Villa house", "Condominium land", "Office", "Commercial point", "Store", "Garage / box", "Commercial house", "Warehouse", "Hotel", "Building", "Country house", "Farm" ] }, "default": [] }, "min_bedroom": { "title": "Min bedrooms", "enum": [ "", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum bedroom count.", "default": "" }, "max_bedroom": { "title": "Max bedrooms", "enum": [ "", "1", "2", "3", "4", "5" ], "type": "string", "description": "Maximum bedroom count.", "default": "" }, "min_bathroom": { "title": "Min bathrooms", "enum": [ "", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum bathroom count.", "default": "" }, "min_parking": { "title": "Min parking spaces", "enum": [ "", "1", "2", "3", "4" ], "type": "string", "description": "Minimum number of parking spaces.", "default": "" }, "min_price": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum listing price in BRL. Leave empty for no minimum." }, "max_price": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum listing price in BRL. Leave empty for no maximum." }, "min_sqm": { "title": "Min total area (m²)", "minimum": 0, "type": "integer", "description": "Minimum total area in square meters." }, "max_sqm": { "title": "Max total area (m²)", "minimum": 0, "type": "integer", "description": "Maximum total area in square meters." }, "min_usable_sqm": { "title": "Min usable area (m²)", "minimum": 0, "type": "integer", "description": "Minimum usable (private) area in square meters." }, "max_usable_sqm": { "title": "Max usable area (m²)", "minimum": 0, "type": "integer", "description": "Maximum usable (private) area in square meters." }, "common_feature_ids": { "title": "Building / condominium features", "type": "array", "description": "Shared building or condominium features to require.", "items": { "type": "string", "enum": [ "accessible_access", "central_heating", "service_area", "green_area", "playroom", "security_cameras", "soccer_field", "golf_course", "barbecue_grill", "elevator", "generator", "jogging_track", "playground", "electronic_gate", "concierge_24_hours", "near_metro", "tennis_court", "furnished", "balcony", "pool" ], "enumTitles": [ "Accessible access", "Central heating", "Service area", "Green area", "Playroom", "Security cameras", "Soccer field", "Golf course", "Barbecue grill", "Elevator", "Generator", "Jogging track", "Playground", "Electronic gate", "24-hour concierge", "Near metro", "Tennis court", "Furnished", "Balcony", "Pool" ] }, "default": [] }, "private_feature_ids": { "title": "Private / in-unit features", "type": "array", "description": "Private or in-unit features to require.", "items": { "type": "string", "enum": [ "air_conditioning", "bar", "closet", "open_kitchen", "staff_quarters", "home_office", "exchange_accepted", "oceanfront", "hot_tub", "garden", "fireplace", "suites", "not_in_rental_pool", "pets_allowed", "backyard", "alarm_system" ], "enumTitles": [ "Air conditioning", "Bar", "Closet", "Open kitchen", "Staff quarters", "Home office", "Exchange accepted", "Oceanfront", "Hot tub", "Garden", "Fireplace", "Suites", "Not in rental pool", "Pets allowed", "Backyard", "Alarm system" ] }, "default": [] }, "near_transit": { "title": "Near public transit", "type": "boolean", "description": "Keep only listings marked as near a metro station or public transit.", "default": false }, "max_antiquity": { "title": "Max property age", "enum": [ "", "under_construction", "coming_soon", "up_to_5_years", "up_to_10_years", "up_to_20_years", "up_to_50_years", "more_than_50_years" ], "type": "string", "description": "Maximum property age range.", "default": "" }, "publication_days": { "title": "Published within", "enum": [ "", "today", "since_yesterday", "up_to_7_days", "up_to_15_days", "up_to_30_days", "up_to_45_days" ], "type": "string", "description": "Recency filter for when the listing was published.", "default": "" }, "publisher_type": { "title": "Advertiser type", "enum": [ "ALL", "COMPANY", "PARTICULAR" ], "type": "string", "description": "Restrict results by advertiser type.", "default": "ALL" }, "multimedia_types": { "title": "Required media", "type": "array", "description": "Require listings to include specific media.", "items": { "type": "string", "enum": [ "tour_360", "videos", "floor_plans" ], "enumTitles": [ "360° tour", "Videos", "Floor plans" ] }, "default": [] }, "limit": { "title": "Limit", "minimum": 1, "type": "integer", "description": "Maximum number of listings to save. Leave empty to collect all matching results the Actor can reach.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Imovelweb.com.br is protected by bot-detection. Brazil-based residential proxies are strongly recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "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 } } } } } } } } } }