Definições - HOMFY - Partner API

O endpoint de Consulta de Imóveis disponibiliza somente Imóveis adicionados na Carteira de Imóveis da conta na Homfy.

Esta conta é identificada a partir do token gerado no endpoint de Autenticação e utilizado no Header desta requisição de Consulta de Imóveis.

💡

O Token para esta request deve ser gerado com o api_key da conta na Homfy e o scope properties

O endpoint foi concebido pensando em trazer flexibilidade para a consulta. Todos os dados de Imóvel que a consulta retorna, devem ser informados na propriedade select do body.

Para realizar filtros, a consulta possui o campo filters no body, este filters é um objeto com os campos que serão utilizados como filtro da consulta.
Campos disponíveis para filtrar:id, code, type, purpose, contract, status, state, cities.

A consulta de Imóveis tende a ter um retorno muito extenso devido a sua natureza que é consultar todos os Imóveis que uma conta tem a disposição para negociar. Pensando neste cenário onde o JSON pode ser muito grande, foi necessário paginar a consulta.

Com a propriedade rows no body é possível informar a quantidade máxima de Imóveis que a consulta irá retornar. O limite é de 20 Imóveis por requisição.
Junto com o rows, é possível realizar a páginação utilizado a propriedade page no body.
Combine estes duas propriedades e você poderá buscar todos os Imóveis da conta.

Exemplo de body da request
Para saber todos os campos que podem ser retornado você pode consultar o response do Endpoint
Para campos aninhados, utilize o padrão pai.filho

{
    "page": 0,
    "rows": 10,
    "select": [
        "id",
        "code",
        "type",
        "purpose",
        "contract",
        "status",
        "address.city",
        "detail.dormitorios",
        "listing.id",
        "listing.images.link",
        "listing.price.id",
        "listing.price.price_sale"
    ],
    "filters": {
        "id": {
            "value": 1
        },
        "code": {
            "value": "RS00000001"
        },
        "type": {
            "value": "Apartamento"
        },
        "purpose": {
            "value": "Residencial"
        },
        "contract": {
            "value": "Compra"
        },
        "status": {
            "value": 1
        },
        "state": {
            "value": "rs"
        },
        "cities": {
            "value": [
                "porto alegre",
                "são leopoldo"
            ]
        }
    }
}

📌

Importante
Caso seja necessário utilizar outro campo no filtro, deve ser feito contato com a Homfy pedindo a adição explicando o motivo.