Pular para o conteúdo
Docs
API Conhecer a Zariv

O objeto imóvel

Todos os campos que a API devolve para cada imóvel, o que é omitido por privacidade e como interpretar cada um.

As rotas de imóveis e de vitrines devolvem o imóvel neste formato. Campos sem valor não aparecem, exceto as quantidades (quartos, suites, banheiros, vagas_garagem) e as listas, que vêm sempre.

#Exemplo

Um imóvel
{
  "id": "3f2b6c1e-5a1d-4b7e-9d0a-6a8f1c2e7b10",
  "codigo": "AP-102",
  "slug": "apartamento-3-quartos-centro-cacoal",
  "titulo": "Apartamento de 3 quartos no Centro",
  "situacao": "disponivel",
  "descricao": "Apartamento amplo, com sacada e vista livre.",
  "tipo_imovel": "apartamento",
  "finalidade": "venda",
  "valor_venda": 420000,
  "valor_condominio": 480,
  "aceita_financiamento": true,
  "aceita_permuta": false,
  "aceita_fgts": true,
  "bairro": "Centro",
  "cidade": "Cacoal",
  "estado": "RO",
  "area_util": 92,
  "quartos": 3,
  "suites": 1,
  "banheiros": 2,
  "vagas_garagem": 1,
  "tags_caracteristicas": [
    "Sacada",
    "Elevador",
    "Portaria 24h"
  ],
  "fotos": [
    {
      "url": "https://exemplo.zariv.com.br/fotos/ap-102-1.jpg",
      "principal": true
    }
  ],
  "destaque_site": true,
  "corretor": {
    "nome": "Maria Souza",
    "creci": "1234-F",
    "telefone": "69999990000"
  }
}

#Campos

CampoTipoDescrição
idstring (uuid)Identificador do imóvel.
codigostringCódigo do imóvel na imobiliária.
slugstringTexto para o endereço amigável da página do imóvel. Pode não existir.
titulostringTítulo do anúncio.
situacaostringdisponivel, em_negociacao, vendido ou alugado.
descricaostringDescrição completa.
tipo_imovelstringTipo do imóvel (lista abaixo).
finalidadestringvenda, locacao, venda_locacao ou temporada.
valor_vendanúmeroValor de venda, em reais. Ausente quando não informado ("consulte").
valor_locacaonúmeroValor mensal do aluguel, em reais.
valor_condominionúmeroCondomínio mensal.
valor_iptunúmeroIPTU.
aceita_financiamentobooleanoAceita financiamento.
aceita_permutabooleanoAceita permuta.
aceita_fgtsbooleanoAceita FGTS.
cep, bairro, cidade, estado, zonastringLocalização. bairro não vem quando o cadastro diz "não possui" ou algo equivalente.
logradouro, numero, complementostringEndereço completo. Não vêm quando a imobiliária marcou o imóvel para ocultar o número no site.
condominio_edificio_nomestringNome do condomínio ou edifício.
latitude, longitudenúmeroCoordenadas para mapa.
area_total, area_util, area_construida, area_terrenonúmeroÁreas em metros quadrados.
quartos, suites, banheiros, vagas_garageminteiroQuantidades. Sempre presentes (0 quando não há).
tipo_vaga, ano_construcao, andar, total_andares_edificio, posicao_sol, mobiliadováriosDetalhes do imóvel, quando preenchidos.
tags_caracteristicasstring[]Características marcadas (piscina, churrasqueira, etc.). Sempre uma lista, mesmo vazia.
fotosobjeto[]Fotos em ordem. Cada uma tem url, legenda (opcional) e principal (booleano).
tour_virtual_urlstringLink do tour virtual, quando houver.
destaque_sitebooleanoMarcado como destaque.
corretorobjetoCorretor responsável: nome, creci, telefone e foto_url. Ausente quando o imóvel não tem corretor definido.

#Tipos de imóvel

apartamento · casa · casa_condominio · cobertura · terreno · comercial · sala_comercial · galpao · chacara_sitio · chacara · sitio · fazenda · haras · terreno_rural · flat · studio · duplex_triplex · outro

#O que a API nunca devolve

A lista de campos é fechada: só sai o que está descrito nesta página. Informações internas não são expostas, nem mesmo se novos campos forem criados no sistema no futuro. Nunca saem pela API:

  • dados do proprietário
  • comissão, honorários e condições internas de negociação
  • exclusividade, matrícula e dados de cartório
  • observações internas e histórico do imóvel
  • chaves do imóvel e onde ficam

#Dicas de exibição

  • Preço: mostre valor_venda e/ou valor_locacao conforme a finalidade. Imóvel sem valor significa “consulte”.
  • Foto de capa: use a foto com principal: true; se nenhuma estiver marcada, use a primeira da lista.
  • Endereço: quando a imobiliária oculta o número, logradouro, numero e complemento não vêm. Mostre só bairro e cidade, e use latitude e longitude com cuidado em mapas.
  • Situação: destaque “Vendido” ou “Alugado” quando a situacao indicar, em vez de esconder a página.
  • Contato: se corretor não existir, use o contato geral da imobiliária (dados da imobiliária).