📝 Documentação de Parâmetros de Entrada ## Visão Geral Este documento detalha todos os parâmetros de entrada disponíveis para o OLX Brasil - Scraper de Imóveis. Configure os filtros de acordo com suas necessidades para extrair dados precisos do mercado imobiliário brasileiro. --- ## 🏠 Tipo de Imóvel Campo: tipoImovel Tipo: String (seleção única) Obrigatório: ✅ Sim ### Descrição Define a categoria principal de imóveis a ser pesquisada no OLX Brasil. ### Valores Aceitos | Valor | Descrição | URL Base | | ---------------------- | ---------------------------------- | ------------------------------------- | | venda | Casas e apartamentos à venda | /imoveis/venda | | aluguel | Casas e apartamentos para aluguel | /imoveis/aluguel | | temporada | Imóveis para aluguel por temporada | /imoveis/temporada | | terrenos | Sítios e fazendas | /imoveis/terrenos-sitios-e-fazendas | | comercio-e-industria | Imóveis comerciais e industriais | /imoveis/comercio-e-industria | | lancamentos | Lançamentos e imóveis novos | /imoveis/lancamentos | ### Exemplos de Uso json // Buscar imóveis à venda { "tipoImovel": "venda" } json // Buscar imóveis para aluguel { "tipoImovel": "aluguel" } --- ## 📍 Localização (UF) Campo: localizacao Tipo: String (seleção única) Obrigatório: ❌ Não Padrão: Todos os estados ### Descrição Filtra anúncios por estado brasileiro (Unidade Federativa). Se não especificado, busca em todo o Brasil. ### Estados Disponíveis | Região | Estados | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | Norte | AC (Acre), AM (Amazonas), AP (Amapá), PA (Pará), RO (Rondônia), RR (Roraima), TO (Tocantins) | | Nordeste | AL (Alagoas), BA (Bahia), CE (Ceará), MA (Maranhão), PB (Paraíba), PE (Pernambuco), PI (Piauí), RN (Rio Grande do Norte), SE (Sergipe) | | Centro-Oeste | DF (Distrito Federal), GO (Goiás), MT (Mato Grosso), MS (Mato Grosso do Sul) | | Sudeste | ES (Espírito Santo), MG (Minas Gerais), RJ (Rio de Janeiro), SP (São Paulo) | | Sul | PR (Paraná), RS (Rio Grande do Sul), SC (Santa Catarina) | ### Exemplos de Uso json // Imóveis em São Paulo { "tipoImovel": "venda", "localizacao": "sp" } json // Imóveis no Rio de Janeiro { "tipoImovel": "aluguel", "localizacao": "rj" } --- ## 💰 Filtro de Preço ### Preço Mínimo Campo: precoMinimo Tipo: Integer Obrigatório: ❌ Não Unidade: Reais (R$) Define o valor mínimo do imóvel. Apenas anúncios com preço igual ou superior serão retornados. ### Preço Máximo Campo: precoMaximo Tipo: Integer Obrigatório: ❌ Não Unidade: Reais (R$) Define o valor máximo do imóvel. Apenas anúncios com preço igual ou inferior serão retornados. ### Exemplos de Uso json // Imóveis entre R$ 300.000 e R$ 500.000 { "tipoImovel": "venda", "precoMinimo": 300000, "precoMaximo": 500000 } json // Aluguéis até R$ 2.000 { "tipoImovel": "aluguel", "precoMaximo": 2000 } json // Imóveis acima de R$ 1.000.000 { "tipoImovel": "venda", "precoMinimo": 1000000 } ### 💡 Dica Para melhor precisão, use valores sem centavos. O OLX trabalha com valores inteiros. --- ## 🛏️ Filtro de Quartos ### Quartos Mínimo Campo: quartosMinimo Tipo: Integer Obrigatório: ❌ Não Define a quantidade mínima de quartos/dormitórios. ### Quartos Máximo Campo: quartosMaximo Tipo: Integer Obrigatório: ❌ Não Define a quantidade máxima de quartos/dormitórios. ### Exemplos de Uso json // Apartamentos com 2 a 3 quartos { "tipoImovel": "venda", "quartosMinimo": 2, "quartosMaximo": 3 } json // Casas com pelo menos 4 quartos { "tipoImovel": "aluguel", "quartosMinimo": 4 } ### ⚠️ Importante - Valores válidos: 1 a 5+ - Se apenas o mínimo for definido, retorna imóveis com aquela quantidade ou mais - Se apenas o máximo for definido, retorna imóveis com aquela quantidade ou menos --- ## 🚿 Filtro de Banheiros ### Banheiros Mínimo Campo: banheirosMinimo Tipo: Integer Obrigatório: ❌ Não Define a quantidade mínima de banheiros. ### Banheiros Máximo Campo: banheirosMaximo Tipo: Integer Obrigatório: ❌ Não Define a quantidade máxima de banheiros. ### Exemplos de Uso json // Imóveis com 2 ou mais banheiros { "tipoImovel": "venda", "banheirosMinimo": 2 } json // Imóveis com 1 a 2 banheiros { "tipoImovel": "aluguel", "banheirosMinimo": 1, "banheirosMaximo": 2 } --- ## 📏 Filtro de Área ### Área Mínima Campo: areaMinima Tipo: Integer Obrigatório: ❌ Não Unidade: m² (metros quadrados) Define o tamanho mínimo do imóvel em metros quadrados. ### Área Máxima Campo: areaMaxima Tipo: Integer Obrigatório: ❌ Não Unidade: m² (metros quadrados) Define o tamanho máximo do imóvel em metros quadrados. ### Exemplos de Uso json // Apartamentos entre 50m² e 100m² { "tipoImovel": "venda", "areaMinima": 50, "areaMaxima": 100 } json // Casas acima de 200m² { "tipoImovel": "venda", "areaMinima": 200 } json // Imóveis comerciais até 500m² { "tipoImovel": "comercio-e-industria", "areaMaxima": 500 } --- ## 🔢 Quantidade de Anúncios Campo: quantidadeAnuncios Tipo: Integer Obrigatório: ❌ Não Padrão: 1000 Máximo: 100000 ### Descrição Define o número máximo de anúncios a serem extraídos na execução. ### Valores Recomendados | Caso de Uso | Quantidade Recomendada | | ---------------------- | ---------------------- | | Teste rápido | 50 - 100 | | Análise regional | 1.000 - 5.000 | | Estudo de mercado | 10.000 - 50.000 | | Base de dados completa | 100.000 | ### Exemplos de Uso json // Teste com poucos anúncios { "tipoImovel": "venda", "quantidadeAnuncios": 100 } json // Extração completa { "tipoImovel": "venda", "localizacao": "sp", "quantidadeAnuncios": 50000 } ### ⏱️ Tempo de Execução Estimado | Anúncios | Tempo Estimado | | -------- | -------------- | | 100 | ~2 minutos | | 1.000 | ~20 minutos | | 10.000 | ~3 horas | | 100.000 | ~30 horas | --- ## 📋 Exemplos Completos ### Exemplo 1: Busca Básica json { "tipoImovel": "aluguel", "quantidadeAnuncios": 1000 } ### Exemplo 2: Filtro por Localização e Preço json { "tipoImovel": "venda", "localizacao": "sp", "precoMinimo": 400000, "precoMaximo": 800000, "quantidadeAnuncios": 5000 } ### Exemplo 3: Busca Avançada Completa json { "tipoImovel": "venda", "localizacao": "rj", "precoMinimo": 300000, "precoMaximo": 600000, "quartosMinimo": 2, "quartosMaximo": 3, "banheirosMinimo": 1, "banheirosMaximo": 2, "areaMinima": 60, "areaMaxima": 100, "quantidadeAnuncios": 10000 } ### Exemplo 4: Imóveis de Alto Padrão json { "tipoImovel": "venda", "localizacao": "sp", "precoMinimo": 2000000, "quartosMinimo": 4, "banheirosMinimo": 3, "areaMinima": 200, "quantidadeAnuncios": 2000 } ### Exemplo 5: Apartamentos Compactos para Aluguel json { "tipoImovel": "aluguel", "localizacao": "sp", "precoMaximo": 2500, "quartosMaximo": 2, "areaMaxima": 60, "quantidadeAnuncios": 3000 } --- ## 🔗 Parâmetros de URL Gerados Os filtros são convertidos automaticamente em parâmetros de URL do OLX: | Filtro | Parâmetro URL | Exemplo | | ------------ | ------------- | ----------------- | | Preço Mínimo | ps= | ps=300000 | | Preço Máximo | pe= | pe=800000 | | Quartos | ros= | ros=2,3 (range) | | Banheiros | bas= | bas=1,2 (range) | | Área Mínima | ss= | ss=50 | | Área Máxima | se= | se=100 | | Filtro Ativo | sf= | sf=1 (sempre) | ### Exemplo de URL Gerada https://www.olx.com.br/imoveis/venda/estado-sp?sf=1&ps=300000&pe=800000&ros=2&ros=3&bas=1&bas=2&ss=50&se=100 --- ## ✅ Validações Automáticas O scraper realiza as seguintes validações: 1. Tipo de Imóvel: Campo obrigatório 2. Valores Numéricos: Devem ser inteiros positivos 3. Ranges: Valores mínimos devem ser menores que os máximos 4. UF: Deve estar na lista de estados brasileiros válidos 5. Quantidade: Limitada ao máximo de 100.000 --- ## 🆘 Suporte Precisa de ajuda? Entre em contato: - 📧 Email: israelnunesoriente@gmail.com - 💬 Discord: Apify Community - 🐛 Issues: GitHub Issues --- ← Voltar para README