Imóveis

Busque imóveis com filtros, ordenação e paginação, ou abra um imóvel pelo identificador ou pelo endereço amigável.

#Buscar imóveis

GET/imoveis

Lista os imóveis da imobiliária com filtros, ordenação e paginação.

#Parâmetros de consulta

Todos são opcionais.

Parâmetro	Tipo	Descrição
`cidade`	string	Parte do nome da cidade. Não diferencia maiúsculas de minúsculas.
`bairro`	string	Parte do nome do bairro.
`codigo`	string	Parte do código do imóvel (o código que a imobiliária vê no sistema).
`tipo_imovel`	string	Um dos tipos listados abaixo. O valor `rural` reúne chácara, sítio, fazenda, haras e terreno rural.
`finalidade`	string	`venda` ou `locacao`. Imóveis que servem para os dois aparecem nas duas buscas. Qualquer outro valor é ignorado.
`quartos_min`	número	Quantidade mínima de quartos.
`valor_min`	número	Valor mínimo. Vale para o valor da finalidade buscada (aluguel em `locacao`, venda em `venda`; sem finalidade, vale qualquer um dos dois).
`valor_max`	número	Valor máximo, com a mesma regra do valor mínimo.
`destaque`	string	`true` devolve só os imóveis marcados como destaque no site.
`situacao`	string	Por padrão a lista traz só imóveis `disponivel` e `em_negociacao`. Passe `vendido`, `alugado` ou os dois separados por vírgula para montar uma vitrine de imóveis já negociados.
`ordenar`	string	`recentes` (mais novos primeiro), `menor_valor` ou `maior_valor`. Sem este parâmetro, os destaques vêm primeiro e, dentro de cada grupo, os mais novos.
`pagina`	inteiro	Número da página, começando em 1.
`por_pagina`	inteiro	Itens por página. Padrão 20, máximo 50.

#Exemplo

cURL

curl "https://web.zariv.com.br/api/public/v1/imoveis?cidade=Cacoal&finalidade=venda&quartos_min=2&por_pagina=10" \
  -H "Authorization: Bearer $ZARIV_API_KEY"

JavaScript

const resposta = await fetch("https://web.zariv.com.br/api/public/v1/imoveis?cidade=Cacoal&finalidade=venda&quartos_min=2&por_pagina=10", {
  headers: { Authorization: `Bearer ${process.env.ZARIV_API_KEY}` },
});
const dados = await resposta.json();
console.log(dados);

Python

import os, requests

resposta = requests.get(
    "https://web.zariv.com.br/api/public/v1/imoveis?cidade=Cacoal&finalidade=venda&quartos_min=2&por_pagina=10",
    headers={"Authorization": f"Bearer {os.environ['ZARIV_API_KEY']}"},
    timeout=15,
)
print(resposta.json())

PHP

<?php
$ch = curl_init("https://web.zariv.com.br/api/public/v1/imoveis?cidade=Cacoal&finalidade=venda&quartos_min=2&por_pagina=10");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("ZARIV_API_KEY")],
]);
$dados = json_decode(curl_exec($ch), true);
curl_close($ch);

#Resposta

200 OK

{
  "imoveis": [
    {
      "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"
      }
    }
  ],
  "total": 134,
  "pagina": 1,
  "por_pagina": 20
}

Testar agoraUsa a sua chave de API e consulta os seus dados de verdade. A chave não é guardada nem enviada para a Zariv além desta chamada.

Chave de API cidadebairrocodigotipo_imovelfinalidadequartos_min

#Resposta: paginação

Campo	Descrição
`imoveis`	Lista de imóveis da página (veja o objeto imóvel).
`total`	Quantos imóveis existem com esses filtros, somando todas as páginas.
`pagina`	A página devolvida.
`por_pagina`	Itens por página usados (no máximo 50).

Para percorrer tudo, aumente pagina até que pagina × por_pagina alcance total.

#Quais imóveis aparecem

Por padrão, só os disponíveis e os em negociação.
Reservados, inativos, rascunhos e arquivados nunca aparecem.
Vendidos e alugados só aparecem se você pedir com situacao=vendido, situacao=alugado ou os dois.

#Valores aceitos em tipo_imovel

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

#Imóvel por identificador

GET/imoveis/{id}

Um imóvel pelo id. Devolve também imóveis já vendidos ou alugados, para links antigos continuarem funcionando.

#Parâmetros no caminho

Parâmetro	Tipo	Descrição
`id`	string	Identificador do imóvel.

#Exemplo

cURL

curl "https://web.zariv.com.br/api/public/v1/imoveis/3f2b6c1e-5a1d-4b7e-9d0a-6a8f1c2e7b10" \
  -H "Authorization: Bearer $ZARIV_API_KEY"

JavaScript

const resposta = await fetch("https://web.zariv.com.br/api/public/v1/imoveis/3f2b6c1e-5a1d-4b7e-9d0a-6a8f1c2e7b10", {
  headers: { Authorization: `Bearer ${process.env.ZARIV_API_KEY}` },
});
const dados = await resposta.json();
console.log(dados);

Python

import os, requests

resposta = requests.get(
    "https://web.zariv.com.br/api/public/v1/imoveis/3f2b6c1e-5a1d-4b7e-9d0a-6a8f1c2e7b10",
    headers={"Authorization": f"Bearer {os.environ['ZARIV_API_KEY']}"},
    timeout=15,
)
print(resposta.json())

PHP

<?php
$ch = curl_init("https://web.zariv.com.br/api/public/v1/imoveis/3f2b6c1e-5a1d-4b7e-9d0a-6a8f1c2e7b10");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("ZARIV_API_KEY")],
]);
$dados = json_decode(curl_exec($ch), true);
curl_close($ch);

#Resposta

200 OK

{
  "imovel": {
    "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"
    }
  }
}

Testar agoraUsa a sua chave de API e consulta os seus dados de verdade. A chave não é guardada nem enviada para a Zariv além desta chamada.

Chave de API id (no caminho)

Diferente da busca, esta rota também devolve imóveis vendidos ou alugados. Assim, um link antigo compartilhado por um corretor continua abrindo a página do imóvel, mesmo depois do negócio fechado. Imóveis arquivados deixam de abrir.

#Imóvel pelo endereço amigável

GET/imoveis/slug/{slug}

Um imóvel pelo slug, ideal para a página de detalhe do site.

#Parâmetros no caminho

Parâmetro	Tipo	Descrição
`slug`	string	Slug do imóvel.

#Exemplo

cURL

curl "https://web.zariv.com.br/api/public/v1/imoveis/slug/apartamento-3-quartos-centro-cacoal" \
  -H "Authorization: Bearer $ZARIV_API_KEY"

JavaScript

const resposta = await fetch("https://web.zariv.com.br/api/public/v1/imoveis/slug/apartamento-3-quartos-centro-cacoal", {
  headers: { Authorization: `Bearer ${process.env.ZARIV_API_KEY}` },
});
const dados = await resposta.json();
console.log(dados);

Python

import os, requests

resposta = requests.get(
    "https://web.zariv.com.br/api/public/v1/imoveis/slug/apartamento-3-quartos-centro-cacoal",
    headers={"Authorization": f"Bearer {os.environ['ZARIV_API_KEY']}"},
    timeout=15,
)
print(resposta.json())

PHP

<?php
$ch = curl_init("https://web.zariv.com.br/api/public/v1/imoveis/slug/apartamento-3-quartos-centro-cacoal");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("ZARIV_API_KEY")],
]);
$dados = json_decode(curl_exec($ch), true);
curl_close($ch);

#Resposta

200 OK

{
  "imovel": {
    "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"
    }
  }
}

Testar agoraUsa a sua chave de API e consulta os seus dados de verdade. A chave não é guardada nem enviada para a Zariv além desta chamada.

Chave de API slug (no caminho)

Use o slug para páginas como seusite.com.br/imovel/apartamento-3-quartos-centro-cacoal. O slug vem em cada imóvel da busca.