ImovoMAP Data API - Documentação

Seu token SANDBOX e PRODUÇÃO aparecererão na área API após você efetuar seu login

Requisições

URL PRODUÇÃO:: https://imovomap.com.br/v1
URL SANDBOX:: https://sandbox.imovomap.com.br/v1

Todas as requisições devem conter o parâmetro auth_id (na querystring) com o token mostrado nesta página, de acordo com o ambiente de desenvolvimento.

Caso esteja usando o token de teste, nenhum evento POST ficará disponível no site.

Respostas

Todas as respostas estarão no formato JSON, com estruturas específicas de cada requisição.

De modo geral, respostas bem sucedidas retornarão código HTTP 200 OK.

Erros

Na ocorrência de erros, a resposta será da seguinte forma:

{
    "errors": [
        "Descrição do erro.",
        ...
    ]
}

Ou seja, um simples array de strings com descrições dos erros (geralmente somente um erro) na entrada errors.

Quanto ao código HTTP:

400 Bad Request: requisições consideradas inválidas.
401 Unauthorized: autenticação/autorização malsucedida.
404 Not Found: recursos inexistentes, como na requisição de uma imóvel com um ID inválido.
500 Internal Server Error: se a API estiver com problemas internos.

Ações de acesso a imóveis

Obter lista de tipos de imóveis

GET /types

Exemplo de resposta:

{
    "general": {
        "total_results": "15",
    },
    "types": [
        {
            "type.id": "999999999",
            "type.name": "Casa",          
        },
        {
            "type.id": "999999999",
            "type.name": "Apartamento"
        },
        ...
    ]
}

Dados retornados:

`total_results`	Quantidade de tipos de imóveis encontradas
`type.id`	ID do tipo de imóvel
`type.name`	Nome do tipo do imóvel

Obter lista de imóveis

GET /properties?{{parametros}}

Parâmetros:

`per_page`	Resultados por página Formato: Numérico
`page`	Número da página Formato: Numérico
`status`	Status do imóvel: 0: Oculto 1: Visível Formato: Numérico
`type`	Tipo de imóvel: ## Id do tipo de imóvel Formato: Numérico
`sector`	Status: 0: Locação 1: Venda 2: Temporada Formato: Numérico
`condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta Formato: Numérico
`purpose`	Finalidade: 0: Comercial 1: Residencial
`city`	Cidade: Formato: Texto
`uf`	Estado: Formato: Texto Caracteres: 2
`bed`	Quartos: ## Quantidade Formato: Numérico
`bath`	Banheiros: ## Quantidade Formato: Numérico
`suites`	Suítes: ## Quantidade Formato: Numérico
`garage`	Vagas de Garagem: ## Quantidade Formato: Numérico
`date_add`	Data de cadastro do imóvel: Formato: Data (yyyy-mm-dd)

Exemplo de resposta:

{
    "general": {
        "total_results": "15",
        "per_page": "15",
        "total_pages": 1
    },
    "properties": [
        {
            "properties.id": "999999999",
            "properties.date": "2019-01-25",          
            "properties.status": "1"
        },
        {
            "properties.id": "999999999",
            "properties.date": "2019-01-25",          
            "properties.status": "0"
        },
        ...
    ]
}

Dados retornados:

`total_results`	Quantidade de imóveis encontradas
`per_page`	Resultados por página (caso tenha o parâmetro tenha sido utilizado na requisição)
`total_pages`	Total de páginas
`properties.id`	ID do imóvel
`properties.idp`	ID Interno do imóvel em seu sistema
`properties.date`	Data da imóvel
`properties.status`	Status do imóvel: 0: Oculto 1: Visível solved: Solucionada

Obter dados de um imóvel

GET /properties/{{properties.id}}

Parâmetros:

properties.id ID do imóvel
Formato: Numérico

Exemplo de resposta:

{
    "properties.id": "999999999",
    "properties.idp": "ABC123",    
    "properties.status": "0",
    "properties.type": "3",
    "properties.sector": "1",
    "properties.condition": "1", 
    "properties.purpose": "1",
    "properties.addr_cep": "80730-420",
    "properties.addr_addr": "Rua Capitão Souza Franco",
    "properties.addr_number": "15",
    "properties.addr_plus": "-" ,
    "properties.addr_area": "Batel",
    "properties.addr_city": "CUritiba",
    "properties.addr_uf": "PR",
    "properties.lat": "-23.7080884",
    "properties.lng": "-46.5458486",
    "properties.bed": "4" ,
    "properties.bath": "2",
    "properties.suites": "1",
    "properties.garage": "2",
    "properties.areat": "345",
    "properties.areac": "230",
    "properties.areau": "115" ,
    "properties.value_s": "450000,00",
    "properties.value_r": "0",
    "properties.value_c": "0",
    "properties.url_img": "http://www.imovogo.com.br/assets/common/general-img.png",
    "properties.url_dest": "http://www.imovogo.com.br/",
    "properties.date_add": "2019-01-10 18:42:00",
    "properties.date_lastupdate": "2019-01-12 18:42:00"
}

Dados retornados:

`properties.id`	ID do imóvel
`properties.idp`	ID Interno do imóvel em seu sistema
`properties.status`	Status do imóvel: 0: Oculto 1: Visível
`properties.type`	Tipo de imóvel: ## Id do tipo de imóvel
`properties.sector`	Status: 0: Locação 1: Venda 2: Temporada
`properties.condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta
`properties.purpose`	Finalidade: 0: Comercial 1: Residencial
`properties.addr_cep`	CEP do Imóvel
`properties.addr_addr`	Logradouro do Imóvel
`properties.addr_number`	Número residencial do imóvel
`properties.addr_plus`	Complemento ao endereço do imóvel
`properties.addr_area`	Bairro do Imóvel
`properties.addr_city`	Cidade do Imóvel
`properties.addr_uf`	UF do Imóvel
`properties.lat`	Latitude referente à localização geográfica de acordo com o Google Maps
`properties.lng`	Longitude referente à localização geográfica de acordo com o Google Maps
`properties.bed`	Quantidade de quartos
`properties.bath`	Quantidade de banheiros
`properties.suites`	Quantidade de suítes
`properties.garage`	Quantidade de vagas na garagem
`properties.areat`	Área total do imóvel
`properties.areac`	Área construída do imóvel
`properties.areau`	Área útil do imóvel
`properties.value_s`	Valor de venda
`properties.value_r`	Valor de locação
`properties.value_c`	Valor do condomínio
`properties.url_img`	URL da imagem do imóvel
`properties.url_dest`	URL de destino do imóvel
`properties.date_add`	Data de cadastro
`properties.date_lastupdate`	Data da última atualização

Obter métricas de um imóvel

GET /properties/{{properties.id}}/analytics?{{parametros}}

Parâmetros:

`properties.id`	ID do imóvel Formato: Numérico
`date_start`	Data inicial do período consultado: Formato: Data (yyyy-mm-dd)
`date_end`	Data final do período consultado: Formato: Data (yyyy-mm-dd)
Se apenas uma das datas for informada, ela será considerada como critério de início/fim da consulta de dados até o extremo mais antigo/novo do período.

Exemplo de resposta:

{
    "general": {
        "date_start": "2019-01-01",
        "date_end":  "2019-01-31"
    },
    "analytics": [
        {
            "properties.id": "999999999",
            "properties.prints": "5327",          
            "properties.clicks": "432{"
        }
        ...
    ]
}

Dados retornados:

`date_start`	Data inicial do período consultado
`date_end`	Data final do período consultado
`properties.id`	ID do imóvel
`properties.prints`	Quantidade de impressões no período
`properties.clicks`	Quantidade de impressões no período

Ações CRUD em imóveis

Adicionar um imóvel

POST /properties/

Parâmetros:

`properties.idp`	ID Interno do Imóvel em seu sistema: Formato: Alfanumérico
`properties.status`	Status do imóvel: 0: Oculto 1: Visível Formato: Numérico
`properties.type`	Tipo de imóvel: ## Id do tipo de imóvel Formato: Numérico
`properties.sector`	Status: 0: Locação 1: Venda 2: Temporada Formato: Numérico
`properties.condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta Formato: Numérico
`properties.purpose`	Finalidade: 0: Comercial 1: Residencial Formato: Numérico
`properties.addr_cep`	CEP do Imóvel Formato: Alfanumérico (00000-000)
`properties.addr_addr`	Logradouro do Imóvel Formato: Texto
`properties.addr_number`	Número residencial do imóvel Formato: Texto
`properties.addr_plus`	Complemento ao endereço do imóvel Formato: Texto
`properties.addr_area`	Bairro do Imóvel Formato: Texto
`properties.addr_city`	Cidade do Imóvel Formato: Texto
`properties.addr_uf`	UF do Imóvel Formato: Texto (AA)
`properties.lat`	Latitude referente à localização geográfica de acordo com o Google Maps Formato: Numérico positivo (sem sinal) ou negativo utilizando o "." como separador decimal. Ex: -46.1234567, 52.1234567
`properties.lng`	Longitude referente à localização geográfica de acordo com o Google Maps Formato: Numérico positivo (sem sinal) ou negativo utilizando o "." como separador decimal. Ex: -46.1234567, 52.1234567
`properties.bed`	Quantidade de quartos Formato: Numérico
`properties.bath`	Quantidade de banheiros Formato: Numérico
`properties.suites`	Quantidade de suítes Formato: Numérico
`properties.garage`	Quantidade de vagas na garagem Formato: Numérico
`properties.areat`	Área total do imóvel Formato: Numérico
`properties.areac`	Área construída do imóvel Formato: Numérico
`properties.areau`	Área útil do imóvel Formato: Numérico
`properties.value_s`	Valor de venda Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.value_r`	Valor de locação Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.value_c`	Valor do condomínio Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.url_img`	URL da imagem do imóvel Formato: URL inciada por "https://"
`properties.url_dest`	URL de destino do imóvel Formato: URL inciada por "http://" ou "https://"

Exemplo de resposta:

{
    "properties.id": "999999999",
    "properties.idp": "ABC123",
    "properties.status": "0",
    "properties.type": "3",
    "properties.sector": "1",
    "properties.condition": "1", 
    "properties.purpose": "1",
    "properties.addr_cep": "80730-420",
    "properties.addr_addr": "Rua Capitão Souza Franco",
    "properties.addr_number": "15",
    "properties.addr_plus": "-" ,
    "properties.addr_area": "Batel",
    "properties.addr_city": "CUritiba",
    "properties.addr_uf": "PR",
    "properties.lat": "-23.7080884",
    "properties.lng": "-46.5458486",
    "properties.bed": "4" ,
    "properties.bath": "2",
    "properties.suites": "1",
    "properties.garage": "2",
    "properties.areat": "345",
    "properties.areac": "230",
    "properties.areau": "115" ,
    "properties.value_s": "450000,00",
    "properties.value_r": "0",
    "properties.value_c": "0",
    "properties.url_img": "http://www.imovogo.com.br/assets/common/general-img.png",
    "properties.url_dest": "http://www.imovogo.com.br/",
    "properties.date_add": "2019-01-10 18:42:00",
    "properties.date_lastupdate": "2019-01-12 18:42:00"
}

Dados retornados:

`properties.id`	ID do imóvel
`properties.idp`	ID Interno do imóvel em seu sistema
`properties.status`	Status do imóvel: 0: Oculto 1: Visível
`properties.type`	Tipo de imóvel: ## Id do tipo de imóvel
`properties.sector`	Status: 0: Locação 1: Venda 2: Temporada
`properties.condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta
`properties.purpose`	Finalidade: 0: Comercial 1: Residencial
`properties.addr_cep`	CEP do Imóvel
`properties.addr_addr`	Logradouro do Imóvel
`properties.addr_number`	Número residencial do imóvel
`properties.addr_plus`	Complemento ao endereço do imóvel
`properties.addr_area`	Bairro do Imóvel
`properties.addr_city`	Cidade do Imóvel
`properties.addr_uf`	UF do Imóvel
`properties.lat`	Latitude referente à localização geográfica de acordo com o Google Maps
`properties.lng`	Longitude referente à localização geográfica de acordo com o Google Maps
`properties.bed`	Quantidade de quartos
`properties.bath`	Quantidade de banheiros
`properties.suites`	Quantidade de suítes
`properties.garage`	Quantidade de vagas na garagem
`properties.areat`	Área total do imóvel
`properties.areac`	Área construída do imóvel
`properties.areau`	Área útil do imóvel
`properties.value_s`	Valor de venda
`properties.value_r`	Valor de locação
`properties.value_c`	Valor do condomínio
`properties.url_img`	URL da imagem do imóvel
`properties.url_dest`	URL de destino do imóvel
`properties.date_add`	Data de cadastro
`properties.date_lastupdate`	Data da última atualização

Atualizar dados de um imóvel

PUT /properties/{{properties.id}}/

Parâmetros:

`properties.id`	ID do imóvel Formato: Numérico
`properties.status`	Status do imóvel: 0: Oculto 1: Visível Formato: Numérico
`properties.type`	Tipo de imóvel: ## Id do tipo de imóvel Formato: Numérico
`properties.sector`	Status: 0: Locação 1: Venda 2: Temporada Formato: Numérico
`properties.condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta Formato: Numérico
`properties.purpose`	Finalidade: 0: Comercial 1: Residencial Formato: Numérico
`properties.addr_cep`	CEP do Imóvel Formato: Alfanumérico (00000-000)
`properties.addr_addr`	Logradouro do Imóvel Formato: Texto
`properties.addr_number`	Número residencial do imóvel Formato: Texto
`properties.addr_plus`	Complemento ao endereço do imóvel Formato: Texto
`properties.addr_area`	Bairro do Imóvel Formato: Texto
`properties.addr_city`	Cidade do Imóvel Formato: Texto
`properties.addr_uf`	UF do Imóvel Formato: Texto (AA)
`properties.lat`	Latitude referente à localização geográfica de acordo com o Google Maps Formato: Numérico positivo (sem sinal) ou negativo utilizando o "." como separador decimal. Ex: -46.1234567, 52.1234567
`properties.lng`	Longitude referente à localização geográfica de acordo com o Google Maps Formato: Numérico positivo (sem sinal) ou negativo utilizando o "." como separador decimal. Ex: -46.1234567, 52.1234567
`properties.bed`	Quantidade de quartos Formato: Numérico
`properties.bath`	Quantidade de banheiros Formato: Numérico
`properties.suites`	Quantidade de suítes Formato: Numérico
`properties.garage`	Quantidade de vagas na garagem Formato: Numérico
`properties.areat`	Área total do imóvel Formato: Numérico
`properties.areac`	Área construída do imóvel Formato: Numérico
`properties.areau`	Área útil do imóvel Formato: Numérico
`properties.value_s`	Valor de venda Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.value_r`	Valor de locação Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.value_c`	Valor do condomínio Formato: Numérico com duas casas decimais Ex: 12345,23
`properties.url_img`	URL da imagem do imóvel Formato: URL inciada por "https://"
`properties.url_dest`	URL de destino do imóvel Formato: URL inciada por "http://" ou "https://"

Exemplo de resposta:

{
    "properties.id": "999999999",
    "properties.idp": "ABC123",    
    "properties.status": "0",
    "properties.type": "3",
    "properties.sector": "1",
    "properties.condition": "1", 
    "properties.purpose": "1",
    "properties.addr_cep": "80730-420",
    "properties.addr_addr": "Rua Capitão Souza Franco",
    "properties.addr_number": "15",
    "properties.addr_plus": "-" ,
    "properties.addr_area": "Batel",
    "properties.addr_city": "CUritiba",
    "properties.addr_uf": "PR",
    "properties.lat": "-23.7080884",
    "properties.lng": "-46.5458486",
    "properties.bed": "4" ,
    "properties.bath": "2",
    "properties.suites": "1",
    "properties.garage": "2",
    "properties.areat": "345",
    "properties.areac": "230",
    "properties.areau": "115" ,
    "properties.value_s": "450000,00",
    "properties.value_r": "0",
    "properties.value_c": "0",
    "properties.url_img": "http://www.imovogo.com.br/assets/common/general-img.png",
    "properties.url_dest": "http://www.imovogo.com.br/",
    "properties.date_add": "2019-01-10 18:42:00",
    "properties.date_lastupdate": "2019-01-12 18:42:00"
}

Dados retornados:

`properties.id`	ID do imóvel
`properties.idp`	ID Interno do imóvel em seu sistema
`properties.status`	Status do imóvel: 0: Oculto 1: Visível
`properties.type`	Tipo de imóvel: ## Id do tipo de imóvel
`properties.sector`	Status: 0: Locação 1: Venda 2: Temporada
`properties.condition`	Estado do imóvel: 0: Usado 1: Novo 2: Planta
`properties.purpose`	Finalidade: 0: Comercial 1: Residencial
`properties.addr_cep`	CEP do Imóvel
`properties.addr_addr`	Logradouro do Imóvel
`properties.addr_number`	Número residencial do imóvel
`properties.addr_plus`	Complemento ao endereço do imóvel
`properties.addr_area`	Bairro do Imóvel
`properties.addr_city`	Cidade do Imóvel
`properties.addr_uf`	UF do Imóvel
`properties.lat`	Latitude referente à localização geográfica de acordo com o Google Maps
`properties.lng`	Longitude referente à localização geográfica de acordo com o Google Maps
`properties.bed`	Quantidade de quartos
`properties.bath`	Quantidade de banheiros
`properties.suites`	Quantidade de suítes
`properties.garage`	Quantidade de vagas na garagem
`properties.areat`	Área total do imóvel
`properties.areac`	Área construída do imóvel
`properties.areau`	Área útil do imóvel
`properties.value_s`	Valor de venda
`properties.value_r`	Valor de locação
`properties.value_c`	Valor do condomínio
`properties.url_img`	URL da imagem do imóvel
`properties.url_dest`	URL de destino do imóvel
`properties.date_add`	Data de cadastro
`properties.date_lastupdate`	Data da última atualização

Remover imóvel

DELETE /properties/{{properties.id}}/

Parâmetros:

properties.id ID do imóvel
Formato: Numérico

Exemplo de resposta:

{
    "properties": [
        {
            "properties.id": "999999999",
            "properties.remove": "success",          
        }
        ...
    ]
}

Dados retornados:

`properties.id`	ID do imóvel
`properties.status`	Status atual do imóvel: 0: Oculto 1: Visível
`properties.remove`	Retorno da remoção do imóvel success: Imóvel removido

Caso ainda tenha alguma dúvida sobre a API ou sobre a integração, envie um e-mail para integracao@imovomap.com.br.

ImovoMAP Data API - Documentação

Seu token SANDBOX e PRODUÇÃO aparecererão na área API após você efetuar seu login

Requisições

Respostas

Erros

Ações de acesso a imóveis

Obter lista de tipos de imóveis

Exemplo de resposta:

Dados retornados:

Obter lista de imóveis

Parâmetros:

Exemplo de resposta:

Dados retornados:

Obter dados de um imóvel

Parâmetros:

Exemplo de resposta:

Dados retornados:

Obter métricas de um imóvel

Parâmetros:

Exemplo de resposta:

Dados retornados:

Ações CRUD em imóveis

Adicionar um imóvel

Parâmetros:

Exemplo de resposta:

Dados retornados:

Atualizar dados de um imóvel

Parâmetros:

Exemplo de resposta:

Dados retornados:

Remover imóvel

Parâmetros:

Exemplo de resposta:

Dados retornados:

Apartamento 3 quarto(s) em Itacoatiara/NITEROI

Apartamento 3 quarto(s) em Ahú/CURITIBA