{ "openapi": "3.0.1", "info": { "title": "Imovelweb Scraper | $1.5 / 1k | Fast & Reliable", "description": "Extract structured Brazil property listings from Imovelweb 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.0", "x-build-id": "09RCUPF9A8sag9hx9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~imovelweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~imovelweb-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~imovelweb-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": "Choose a Deal Type", "enum": [ "sale", "rent", "auction", "temporary", "newly_built" ], "type": "string", "description": "Select whether you want listings for sale, rent, auction, temporary stay, or newly built developments.", "default": "sale" }, "location": { "title": "Optionally Enter a Location (city or neighbourhood (bairro))", "type": "string", "description": "Optional. Search within a city, neighborhood, district, avenue, street, or another place in Brazil. Leave this empty to search more broadly with the other filters. For example: Sao Paulo, Pinheiros, or Avenida Paulista." }, "property_type": { "title": "Select Property Categories", "uniqueItems": true, "type": "array", "description": "Pick one or more main property categories, or leave this empty to search across all property types.", "items": { "type": "string", "enum": [ "apartment", "house", "land", "commercial", "rural" ], "enumTitles": [ "Apartment | Apartamento", "House | Casa", "Land | Terreno", "Commercial | Comercial", "Rural | Rural" ] } }, "property_subtype": { "title": "Refine by Property Subtype", "uniqueItems": true, "type": "array", "description": "Narrow the results to more specific property formats such as Cobertura, Flat, Sobrado, Loja, or other subtype options.", "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": [ "Standard apartment | Padrao", "Studio apartment | Studio", "Kitnet | Kitnet", "Penthouse | Cobertura", "Flat | Flat", "Garden apartment | Garden", "Loft | Loft", "Duplex | Duplex", "Standard house | Casa padrao", "Gated community house | Casa em condominio", "Townhouse | Sobrado", "Village house | Casa de vila", "Condominium land | Loteamento / Condominio", "Office | Conjunto Comercial / Sala", "Commercial point | Ponto Comercial", "Storefront | Loja / Salao", "Garage box | Box / Garagem", "Commercial property | Casa Comercial", "Warehouse | Galpao / Deposito / Barracao", "Hotel / Inn | Hotel / Pousada", "Whole building | Predio Inteiro", "Country house | Chacara", "Farm | Fazenda" ] } }, "min_bedroom": { "title": "Set a Minimum Bedroom Count", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "Show only properties with at least this many bedrooms." }, "max_bedroom": { "title": "Set a Maximum Bedroom Count", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "Limit results to properties with no more than this many bedrooms." }, "min_bathroom": { "title": "Set a Minimum Bathroom Count", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "Show only properties with at least this many bathrooms." }, "min_parking": { "title": "Set a Minimum Parking Count", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Show only properties with at least this many parking spaces." }, "min_price": { "title": "Set a Minimum Price", "minimum": 0, "type": "integer", "description": "Exclude listings priced below this amount in BRL. For example, 200000." }, "max_price": { "title": "Set a Maximum Price", "minimum": 0, "type": "integer", "description": "Exclude listings priced above this amount in BRL. For example, 4000000." }, "min_sqm": { "title": "Set a Minimum Total Area (m2)", "minimum": 0, "type": "integer", "description": "Show only properties with at least this much total area in square meters." }, "max_sqm": { "title": "Set a Maximum Total Area (m2)", "minimum": 0, "type": "integer", "description": "Limit results to properties with no more than this much total area in square meters." }, "min_usable_sqm": { "title": "Set a Minimum Usable Area (m2)", "minimum": 0, "type": "integer", "description": "Show only properties with at least this much usable area in square meters." }, "max_usable_sqm": { "title": "Set a Maximum Usable Area (m2)", "minimum": 0, "type": "integer", "description": "Limit results to properties with no more than this much usable area in square meters." }, "common_feature_ids": { "title": "Choose Shared Building Features", "uniqueItems": true, "type": "array", "description": "Filter for shared amenities such as a pool, elevator, playground, 24-hour concierge, or other condominium-level features.", "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 | Acesso para deficientes", "Central heating | Aquecimento central", "Service area | Area de servico", "Green area | Area verde", "Playroom | Brinquedoteca", "Security cameras | Cameras de seguranca", "Soccer field | Campo de futebol", "Golf course | Campo de golfe", "Barbecue grill | Churrasqueira", "Elevator | Elevador", "Generator | Gerador", "Jogging track | Pista de cooper", "Playground | Playground", "Electronic gate | Portao eletronico", "24-hour concierge | Portaria 24 horas", "Near metro | Proximo ao metro", "Tennis court | Quadra de tenis", "Furnished | Mobiliado", "Balcony | Varanda", "Pool | Piscina" ] } }, "private_feature_ids": { "title": "Choose Private Property Features", "uniqueItems": true, "type": "array", "description": "Filter for features inside the property or exclusive to it, such as air conditioning, a fireplace, a garden, suites, or pet-friendly access.", "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 | Ar condicionado", "Bar | Bar", "Closet | Closet", "Open kitchen | Cozinha americana", "Staff quarters | Dependencia de empregados", "Home office | Escritorio / Home-office", "Exchange accepted | Aceita / Estuda permuta", "Oceanfront | Frente para o mar", "Hot tub | Hidromassagem", "Garden | Jardim", "Fireplace | Lareira", "Suites | Suites", "Not in rental pool | No pool de locacao", "Pets allowed | Permite animais", "Backyard | Quintal", "Alarm system | Sistema de alarme" ] } }, "near_transit": { "title": "Show Only Listings Near Metro or Transit 🚇", "type": "boolean", "description": "Turn this on to keep only listings marked as close to a metro station or public transit.", "default": false }, "max_antiquity": { "title": "Set the Maximum 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": "Limit results to properties that fall within this age range, including options such as under 5 years or under 20 years." }, "publication_days": { "title": "Limit by Publication Recency", "enum": [ "today", "since_yesterday", "up_to_7_days", "up_to_15_days", "up_to_30_days", "up_to_45_days" ], "type": "string", "description": "Show only listings published within the selected number of days." }, "publisher_type": { "title": "Choose a Listing Source", "enum": [ "ALL", "COMPANY", "PARTICULAR" ], "type": "string", "description": "Filter listings by advertiser type, such as all sellers, real estate agencies, or direct owners." }, "multimedia_types": { "title": "Require Listing Media", "uniqueItems": true, "type": "array", "description": "Keep only listings that include specific media such as a 360 tour, video, or floor plan.", "items": { "type": "string", "enum": [ "tour_360", "videos", "floor_plans" ], "enumTitles": [ "360 tour | Tour 360", "Videos | Videos", "Floor plans | Plantas" ] } }, "limit": { "title": "Set a Maximum Number of Results", "minimum": 1, "type": "integer", "description": "Enter how many listings you want to save. Leave this empty to collect every matching result the actor can reach." } } }, "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 } } } } } } } } } }