{ "openapi": "3.0.1", "info": { "title": "Lopes Scraper - Imóveis Brasil", "description": "Scrape lopes.com.br: resale, rent and new developments with prices, location, specs, photos and office data. Condominium and developer profiles. No login, no proxy.", "version": "0.1", "x-build-id": "vdFk4Qjhvar6Pzm7P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/recordsdata~lopes-br-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-recordsdata-lopes-br-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/recordsdata~lopes-br-scraper/runs": { "post": { "operationId": "runs-sync-recordsdata-lopes-br-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/recordsdata~lopes-br-scraper/run-sync": { "post": { "operationId": "run-sync-recordsdata-lopes-br-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": { "mode": { "title": "What to collect", "enum": [ "search", "urls", "sitemap", "condominiums", "developers" ], "type": "string", "description": "search = listings from a location with filters. urls = the Lopes URLs and codes you list below. sitemap = walk the public catalog (all listings, filtered by operation and keywords). condominiums = condominium profiles. developers = developers (incorporadoras) with their launches. If you fill startUrls or skus while mode is search, the actor reads those instead.", "default": "search" }, "startUrls": { "title": "Lopes URLs", "type": "array", "description": "lopes.com.br pages to read: search results (/busca/venda/br/sp/sao-paulo/moema/tipo/apartamento), a listing (/imovel/REO...), a launch (/lancamento/REM...), a condominium (/condominios/.../REC...) or a developer (/empreendimentos/slug). Search URLs also honour /tipo/, /comodidade/com- and /pagina/ segments.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "skus": { "title": "Listing codes", "type": "array", "description": "Lopes codes to fetch directly: REO123456 (resale or rent), REM12345 (new development) or REC12345 (condominium). One per line.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stops after this many rows (all record types together). Free plans are limited to 10 items per run.", "default": 50 }, "operation": { "title": "Operation", "enum": [ "sale", "rent", "launch" ], "type": "string", "description": "Buy, rent or new developments. In sitemap mode this also filters the catalog.", "default": "sale" }, "state": { "title": "State", "enum": [ "sp", "rj", "mg", "rs", "pr", "sc", "ba", "pe", "ce", "df", "go", "es", "am", "al", "pb", "rn", "mt", "ms", "pa", "pi", "se", "ma", "ac", "ap", "ro", "rr" ], "type": "string", "description": "Brazilian state (two-letter code). Required for search mode; also narrows the condominium catalog.", "default": "sp" }, "city": { "title": "City", "type": "string", "description": "City name or slug, for example sao-paulo or \"São Paulo\". Leave empty for the whole state.", "default": "" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Neighborhood name or slug, for example moema. Needs a city. Matches the neighborhood printed on each listing.", "default": "" }, "strictLocation": { "title": "Keep only the chosen place", "type": "boolean", "description": "On: drop listings from neighbouring cities and neighborhoods that the site mixes into results. Off: return everything the site returns for the search.", "default": true }, "maxPagesPerSearch": { "title": "Maximum result pages per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safety limit on pages read for one search (20 to 100 listings per page). Raise it for very large areas.", "default": 50 }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these types (any of them). Empty means all types.", "items": { "type": "string", "enum": [ "apartamento", "cobertura", "studio", "duplex", "triplex", "garden", "loft", "penthouse", "kitnet", "flat", "casa", "sobrado", "casa-condominio", "casa-terrea", "casa-de-vila", "villagio", "terreno", "loteamento", "salas", "lajes-corporativas", "predio-inteiro", "loja", "mall", "salao-comercial", "galpao", "barracao", "hotel", "area-de-terra", "chacara", "sitio", "fazenda", "vaga" ], "enumTitles": [ "Apartment (Apartamento)", "Penthouse (Cobertura)", "Studio", "Duplex", "Triplex", "Garden", "Loft", "Penthouse", "Kitnet", "Flat", "House (Casa)", "Two-storey house (Sobrado)", "House in a gated condominium (Condominio)", "Single-storey house (Casa terrea)", "Village house (Casa de vila)", "Villagio", "Land plot (Terreno)", "Subdivision lot (Loteamento)", "Office rooms (Salas)", "Corporate floors (Lajes corporativas)", "Whole building (Predio inteiro)", "Shop (Loja)", "Mall unit", "Commercial hall (Salao comercial)", "Warehouse (Galpao)", "Shed (Barracao)", "Hotel", "Rural land (Area de terra)", "Small farm (Chacara)", "Country property (Sitio)", "Farm (Fazenda)", "Parking space (Vaga)" ] }, "default": [] }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Lowest sale price, or lowest monthly rent for rentals. 0 means no limit.", "default": 0 }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Highest sale price, or highest monthly rent for rentals. 0 means no limit.", "default": 0 }, "minArea": { "title": "Minimum area (m2)", "minimum": 0, "type": "integer", "description": "Smallest area in square meters. 0 means no limit.", "default": 0 }, "maxArea": { "title": "Maximum area (m2)", "minimum": 0, "type": "integer", "description": "Largest area in square meters. 0 means no limit.", "default": 0 }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Number of bedrooms (any of the selected). 4 means 4 or more.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "1", "2", "3", "4 or more" ] }, "default": [] }, "suites": { "title": "Suites", "type": "array", "description": "Number of suites (any of the selected). 4 means 4 or more.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "1", "2", "3", "4 or more" ] }, "default": [] }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Number of bathrooms (any of the selected). 4 means 4 or more.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "1", "2", "3", "4 or more" ] }, "default": [] }, "parkingSpaces": { "title": "Parking spaces", "type": "array", "description": "Number of parking spaces (any of the selected). 4 means 4 or more.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "1", "2", "3", "4 or more" ] }, "default": [] }, "features": { "title": "Amenities", "type": "array", "description": "Listings that have any of the selected amenities (pool, gym, balcony...).", "items": { "type": "string", "enum": [ "abastecimento-para-carro-eletrico", "academia-de-ginastica", "aceita-pet", "acesso-a-internet", "acesso-biometrico", "acesso-para-deficientes-fisicos", "adega-champagnerie", "aquecedor-central", "arborismo", "arborizacao-de-ruas", "ar-condicionado", "area-de-lazer", "area-verde", "armario-embutido", "arvorismo", "atelie", "auditorio", "automacao-residencial", "bar", "bicicletario", "bicicletas-compartilhadas", "brinquedoteca", "cafeteria", "calcada-gramada", "campo-de-futebol", "carro-eletrico-no-condominio", "car-wash", "casa-do-caseiro", "centro-comercial", "centro-de-conveniencia", "cerca-eletrica", "child-care", "churrasqueira", "cinema", "claraboias", "closet", "clube", "concierge", "copa", "coworking", "cozinha-americana", "cozinha-mobiliada", "cross-training", "deck", "delivery", "dependencia-de-empregados", "deposito", "despensa", "detector-de-incendio", "duplex", "elevador", "energia-solar", "espaco-gourmet", "espaco-influencer", "espaco-zen", "estacionamento-rotativo", "fibra-otica", "fitness", "forno-para-pizza", "fraldario", "frente-para-o-mar", "garage-band-danceteria", "garagem", "gas-encanado", "gazebo", "gazebo-refrigerado", "gerador", "green-buildings", "hall", "home-office", "horta", "ilha-gourmet", "interfone-com-camera", "interfone-via-app", "lan-house", "lareira", "lavabo", "lavanderia", "living", "lobby", "lounge", "massagem", "mega-lounge", "mini-mercado", "ofuro", "orquidario", "pay-per-use", "pergolado", "pet-care", "pet-place", "piscina", "piscina-adulto-coberta", "piscina-adulto-descoberta", "piscina-coberta", "piscina-com-borda-infinita", "piscina-com-hidromassagem", "piscina-com-raia", "piscina-descoberta", "piscina-infantil-coberta", "piscina-infantil-descoberta", "pista-de-skate", "playground", "poco-artesiano", "pomar", "pool-lounge", "portaria", "port-cochere", "praca", "predio-24-horas", "quadra", "quadra-de-areia", "quadra-de-squash", "quadra-de-tenis", "quadra-gramada", "quadra-poliesportiva", "quintal", "reconhecimento-facial", "redario", "rede-de-agua", "rede-de-energia-eletrica", "restaurante", "rooftop", "rua-asfaltada", "sala-de-cinema", "sala-de-convencao", "sala-de-convivencia", "sala-de-leitura", "sala-de-massagem", "sala-de-reunioes", "sala-de-yoga-pilates", "salao-de-beleza", "salao-de-festas", "salao-de-festas-adulto", "salao-de-festas-infantil", "salao-de-jogos", "salao-de-jogos-adulto", "salao-de-jogos-infantil", "salao-de-jogos-juvenil", "salao-de-recreacao", "sauna", "seguranca", "servicos", "sistema-de-incendio", "solarium", "sotao", "spa", "terraco", "tomada-usb", "trilha-pista-de-caminhada", "vaga-de-visitante", "varanda-gourmet", "vestiario", "vestiario-para-funcionarios" ], "enumTitles": [ "Abastecimento para carro elétrico", "Academia de ginástica", "Aceita Pet", "Acesso à internet", "Acesso biométrico", "Acesso para deficientes físicos", "Adega / champagnerie", "Aquecedor central", "Arborismo", "Arborização de ruas", "Ar-condicionado", "Área de Lazer", "Área verde", "Armário Embutido", "Arvorismo", "Ateliê", "Auditório", "Automação residencial", "Bar", "Bicicletário", "Bicicletas compartilhadas", "Brinquedoteca", "Cafeteria", "Calçada gramada", "Campo de futebol", "Carro elétrico no condomínio", "Car wash", "Casa do caseiro", "Centro comercial", "Centro de Conveniência", "Cerca elétrica", "Child care", "Churrasqueira", "Cinema", "Claraboias", "Closet", "Clube", "Concierge", "Copa", "Coworking", "Cozinha Americana", "Cozinha Mobiliada", "Cross training", "Deck", "Delivery", "Dependência de Empregados", "Depósito", "Despensa", "Detector de Incêndio", "Duplex", "Elevador", "Energia solar", "Espaço gourmet", "Espaço influencer", "Espaço zen", "Estacionamento rotativo", "Fibra ótica", "Fitness", "Forno para pizza", "Fraldario", "Frente para o Mar", "Garage band / danceteria", "Garagem", "Gás Encanado", "Gazebo", "Gazebo refrigerado", "Gerador", "Green buildings", "Hall", "Home office", "Horta", "Ilha gourmet", "Interfone com câmera", "Interfone via app", "Lan house", "Lareira", "Lavabo", "Lavanderia", "Living", "Lobby", "Lounge", "Massagem", "Mega lounge", "mini mercado", "Ofurô", "Orquidário", "Pay-per-use", "Pergolado", "Pet care", "Pet Place", "Piscina", "Piscina adulto coberta", "Piscina adulto descoberta", "Piscina coberta", "Piscina com borda infinita", "Piscina com hidromassagem", "Piscina com raia", "Piscina descoberta", "Piscina infantil coberta", "Piscina infantil descoberta", "Pista de skate", "Playground", "Poço artesiano", "Pomar", "Pool lounge", "Portaria", "Port cochère", "Praça", "Prédio 24 horas", "Quadra", "Quadra de areia", "Quadra de squash", "Quadra de tênis", "Quadra gramada", "Quadra poliesportiva", "Quintal", "Reconhecimento facial", "Redário", "Rede de água", "Rede de energia elétrica", "Restaurante", "Rooftop", "Rua asfaltada", "Sala de Cinema", "Sala de convenção", "Sala de convivência", "Sala de leitura", "Sala de Massagem", "Sala de reuniões", "Sala de yoga / pilates", "Salão de beleza", "Salão de festas", "Salão de festas adulto", "Salão de festas infantil", "Salão de jogos", "Salão de jogos adulto", "Salão de jogos infantil", "Salão de jogos juvenil", "Salão de recreação", "Sauna", "Segurança", "Serviços", "Sistema de Incêndio", "Solarium", "Sótão", "Spa", "Terraço", "Tomada usb", "Trilha / pista de caminhada", "Vaga de visitante", "Varanda Gourmet", "Vestiário", "Vestiário para funcionários" ] }, "default": [] }, "companyId": { "title": "Lopes office id", "type": "string", "description": "Only listings handled by one Lopes office. Take the id from the agencyId column of an earlier run.", "default": "" }, "sitemapKeywords": { "title": "Catalog keywords", "type": "array", "description": "Sitemap mode only. Every keyword must appear in the listing address slug, for example sao-paulo and moema. Property types and bedrooms above also filter the catalog.", "default": [], "items": { "type": "string" } }, "developerSlugs": { "title": "Developers", "type": "array", "description": "Developers mode only. Developer slugs such as carvalho-hosken. Empty reads all 115 developers.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Fetch full details", "type": "boolean", "description": "On: one extra request per listing for the full gallery, amenities, nearby places, fees and description (billed as the detailed listing). Off: search-card data only (cheaper, 5 photos). In sitemap mode, off returns light catalog rows.", "default": true }, "includeContactDetails": { "title": "Include office phone", "type": "boolean", "description": "Adds the business WhatsApp number of Lopes-owned offices (agencyPhone). Brokers and private people are never output.", "default": false }, "includeLaunches": { "title": "Include developer launches", "type": "boolean", "description": "Developers mode only: add the list of launches of each developer to its row.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many detail requests run at the same time. The actor also spaces requests politely.", "default": 4 }, "onlyNew": { "title": "Only new or changed listings", "type": "boolean", "description": "Skips listings delivered by an earlier run of the same search (a listing comes back when its price changes). Nothing skipped is charged.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Optional label to keep several monitors with identical filters apart.", "default": "" }, "resetSeen": { "title": "Forget what was delivered", "type": "boolean", "description": "Clears the memory of this search before the run, so everything counts as new.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }