HOMFY - Partner API
  1. Imóveis
HOMFY - Partner API
  • Bem vindo
  • Autenticação
    • Definições
    • Gerar token
      POST
    • Renovar token
      POST
  • Imóveis
    • Definições
    • Consultar Imóveis
      POST
  • Schemas
    • Property
    • PropertyStatus
    • PropertyType
    • PropertyContract
    • PropertyPurpose
    • PropertyAddress
    • PropertyDetail
    • PropertyListing
    • PropertyListing
    • PropertyListingPrice
    • PropertyListingImage
    • PropertyListingVideo
    • RealstateAgentRegister
  1. Imóveis

Consultar Imóveis

POST
/property/search
Consultar de Imóveis da Carteira do Corretor

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Example
{
    "page": 0,
    "rows": 0,
    "select": [
        "string"
    ],
    "filters": {
        "nome_do_campo": {
            "value": "string"
        }
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/property/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 0,
    "rows": 0,
    "select": [
        "string"
    ],
    "filters": {
        "nome_do_campo": {
            "value": "string"
        }
    }
}'

Responses

🟢200Success
application/json
Body

Example
{
    "items": [
        {
            "id": 0,
            "code": "string",
            "status": 1,
            "contract": "Compra",
            "purpose": "Residencial",
            "type": "Apartamento",
            "address": {
                "uf": "string",
                "state": "string",
                "city": "string",
                "district": "string",
                "zipcode": "string",
                "street": "string",
                "street_type": "string",
                "street_number": "string",
                "complement": "string",
                "block": "string",
                "latitude": "string",
                "longitude": "string"
            },
            "defail": {
                "tipo_construcao": "string",
                "ano_construcao": 0,
                "entrega_ano": 0,
                "entrega_mes": 0,
                "dormitorios": 0,
                "suites": 0,
                "banheiros": 0,
                "garagens": 0,
                "garagem_tipo": "string",
                "garagem_numero_box": "string",
                "financiavel": 0,
                "exclusividade": true,
                "lancamento": true,
                "ocupacao": "Desocupado",
                "area_total": 0,
                "area_privativa": 0,
                "area_util": 0,
                "topografia": "Aclive",
                "terreno_comprimento": 0,
                "terreno_largura": 0,
                "numero_pessoas": 0,
                "posicao": "Frente",
                "posicao_solar": "Leste",
                "distancia_mar": 0,
                "permuta": true,
                "seguro_fianca": true,
                "adega": true,
                "agua_quente": true,
                "alarme": true,
                "andar_do_apto": "string",
                "andares": 0,
                "antena_parabolica": true,
                "aquecimento_eletrico": true,
                "ar_central": true,
                "ar_condicionado": true,
                "area_escritorio": 0,
                "area_laje": 0,
                "area_mezanino": 0,
                "area_servico": true,
                "armario_embutido": true,
                "banheiro_auxiliar": true,
                "banheiro_social": true,
                "bar": true,
                "calefacao": true,
                "canaletas_no_rodape": true,
                "cerca_eletrica": true,
                "churrasqueira": true,
                "closet": 0,
                "construcao_alvenaria": true,
                "copa": true,
                "copa_cozinha": true,
                "cozinha": true,
                "cozinha_americana": true,
                "cozinha_com_tanque": true,
                "cozinha_montada": true,
                "cozinha_planejada": true,
                "deck": true,
                "dependencia_de_empregada": true,
                "despensa": true,
                "dormitorio_com_armario": true,
                "edicula": true,
                "escritorio": true,
                "espera_split": true,
                "estado_conservacao_imovel": "Construção",
                "estar_intimo": true,
                "formatodo_galpao": "string",
                "forro": true,
                "gabinete": true,
                "hidromassagem": true,
                "hidro_suite": 0,
                "home_theater": true,
                "jardim_inverno": true,
                "lareira": true,
                "lavabo": true,
                "living": true,
                "living_ambientes": 0,
                "living_hall": true,
                "local_carga_edescarga": true,
                "mezanino": true,
                "mobiliado": true,
                "patio": true,
                "pe_direito_alto": "Sim",
                "piscina": true,
                "piso": "string",
                "piso_area_intima": "string",
                "piso_dormitorio": "string",
                "piso_elevado": "string",
                "piso_sala": "string",
                "porao": true,
                "reformado": true,
                "sacada": true,
                "sacada_com_churrasqueira": true,
                "sala": true,
                "sala_armarios": true,
                "sala_estar": true,
                "sala_jantar": true,
                "salas": 0,
                "sala_tv": true,
                "sauna": true,
                "semi_mobiliado": true,
                "sotao": true,
                "split": true,
                "suite_master": true,
                "terraco": true,
                "tvcabo": true,
                "vista_mar": true,
                "vista_panoramica": true,
                "vitrine": true,
                "wcempregada": true
            },
            "listing": {
                "title": "string",
                "description": "string",
                "article": "string",
                "tour360": "string",
                "videos": [
                    {
                        "link": "string",
                        "title": "string",
                        "description": "string"
                    }
                ],
                "images": [
                    {
                        "link": "string",
                        "title": "string",
                        "description": "string"
                    }
                ],
                "price": {
                    "price_sale": 0,
                    "price_rental": 0,
                    "price_realty_cluster": 0,
                    "price_iptu": 0,
                    "price_cleaning_fee": 0
                }
            }
        }
    ]
}
🟠401Unauthorized
🟠400Bad Request
Modified at 2025-10-14 13:26:22
Previous
Definições
Next
Property
Built with