Cadastrar imóveis em lote - Homfy Public API

Até 200 imóveis por chamada, respeitado o teto de 5 MB de corpo — e o imóvel é a entidade mais pesada da API: com detail e listing preenchidos, 200 itens passam desse teto e a resposta é 413. Se a sua carga for completa, mande de 50 em 50. A resposta separa created de skipped, então a carga inteira pode ser reenviada após uma falha sem duplicar nada.

A resposta 201 pode conter falha: um item pode falhar sozinho e os demais serem criados. Confira errors — cada entrada identifica o imóvel pelo partner_code.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "properties": [
        {
            "status": 1,
            "realty_cluster_id": 42,
            "partner_code": "AP-1024",
            "type": "Apartamento",
            "purpose": "Residencial",
            "contract": "Compra",
            "address": {
                "state": "SC",
                "zipcode": "88015-600",
                "city": "Florianópolis",
                "district": "Centro",
                "street": "Bocaiúva",
                "street_number": "120",
                "street_type": "Rua",
                "reference": "Próximo ao mercado",
                "complement": "Apto 302",
                "block": "Torre B",
                "latitude": "-27.593500",
                "longitude": "-48.548500"
            },
            "detail": {
                "exclusividade": false,
                "lancamento": false,
                "permuta": false,
                "seguro_fianca": true,
                "fiador": true,
                "caucao": false,
                "titulo_capitalizacao": false,
                "entrega_ano": 2027,
                "entrega_mes": 3,
                "dormitorios": 2,
                "suites": 1,
                "banheiros": 2,
                "garagens": 1,
                "financiavel": 1,
                "ano_construcao": 2019,
                "area_total": 120,
                "area_privativa": 88,
                "area_util": 95,
                "terreno_comprimento": 30,
                "terreno_largura": 12,
                "numero_pessoas": 6,
                "distancia_mar": 500,
                "nro_matricula": 123456,
                "nro_iptu": 987654,
                "nro_medidor_energia": 12345,
                "nro_medidor_agua": 67890,
                "nro_medidor_gas": 11223,
                "andares": 2,
                "area_escritorio": 30,
                "area_laje": 60,
                "area_mezanino": 25,
                "closet": 1,
                "hidro_suite": 1,
                "living_ambientes": 2,
                "salas": 1,
                "tipo_construcao": "Alvenaria",
                "garagem_tipo": "Coberta",
                "garagem_numero_box": "12",
                "ocupacao": "Desocupado",
                "topografia": "Plano",
                "posicao": "Frente",
                "posicao_solar": "Norte",
                "andar_do_apto": "3",
                "estado_conservacao_imovel": "Novo",
                "formatodo_galpao": "Modular",
                "pe_direito_alto": "Não",
                "piso": "Porcelanato",
                "piso_area_intima": "Madeira",
                "piso_dormitorio": "Vinílico",
                "piso_sala": "Laminado",
                "caracteristicas": [
                    "Piscina",
                    "Churrasqueira",
                    "Academia"
                ]
            },
            "listing": {
                "title": "Apartamento 2 dormitórios no Centro",
                "description": "Apartamento reformado, a duas quadras do mar.",
                "tour360": "https://tour.exemplo.com/ap-2-dorm",
                "price": {
                    "price_sale": 450000,
                    "price_rental": 2500,
                    "price_realty_cluster": 680,
                    "price_iptu": 120,
                    "price_cleaning_fee": 250
                },
                "display_on_site": true
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/property/batch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "properties": [
        {
            "status": 1,
            "realty_cluster_id": 42,
            "partner_code": "AP-1024",
            "type": "Apartamento",
            "purpose": "Residencial",
            "contract": "Compra",
            "address": {
                "state": "SC",
                "zipcode": "88015-600",
                "city": "Florianópolis",
                "district": "Centro",
                "street": "Bocaiúva",
                "street_number": "120",
                "street_type": "Rua",
                "reference": "Próximo ao mercado",
                "complement": "Apto 302",
                "block": "Torre B",
                "latitude": "-27.593500",
                "longitude": "-48.548500"
            },
            "detail": {
                "exclusividade": false,
                "lancamento": false,
                "permuta": false,
                "seguro_fianca": true,
                "fiador": true,
                "caucao": false,
                "titulo_capitalizacao": false,
                "entrega_ano": 2027,
                "entrega_mes": 3,
                "dormitorios": 2,
                "suites": 1,
                "banheiros": 2,
                "garagens": 1,
                "financiavel": 1,
                "ano_construcao": 2019,
                "area_total": 120,
                "area_privativa": 88,
                "area_util": 95,
                "terreno_comprimento": 30,
                "terreno_largura": 12,
                "numero_pessoas": 6,
                "distancia_mar": 500,
                "nro_matricula": 123456,
                "nro_iptu": 987654,
                "nro_medidor_energia": 12345,
                "nro_medidor_agua": 67890,
                "nro_medidor_gas": 11223,
                "andares": 2,
                "area_escritorio": 30,
                "area_laje": 60,
                "area_mezanino": 25,
                "closet": 1,
                "hidro_suite": 1,
                "living_ambientes": 2,
                "salas": 1,
                "tipo_construcao": "Alvenaria",
                "garagem_tipo": "Coberta",
                "garagem_numero_box": "12",
                "ocupacao": "Desocupado",
                "topografia": "Plano",
                "posicao": "Frente",
                "posicao_solar": "Norte",
                "andar_do_apto": "3",
                "estado_conservacao_imovel": "Novo",
                "formatodo_galpao": "Modular",
                "pe_direito_alto": "Não",
                "piso": "Porcelanato",
                "piso_area_intima": "Madeira",
                "piso_dormitorio": "Vinílico",
                "piso_sala": "Laminado",
                "caracteristicas": [
                    "Piscina",
                    "Churrasqueira",
                    "Academia"
                ]
            },
            "listing": {
                "title": "Apartamento 2 dormitórios no Centro",
                "description": "Apartamento reformado, a duas quadras do mar.",
                "tour360": "https://tour.exemplo.com/ap-2-dorm",
                "price": {
                    "price_sale": 450000,
                    "price_rental": 2500,
                    "price_realty_cluster": 680,
                    "price_iptu": 120,
                    "price_cleaning_fee": 250
                },
                "display_on_site": true
            }
        }
    ]
}'

Responses

🟢201

application/json

Resultado por item: criados, já existentes e erros.

Bodyapplication/json

Example

{
    "created": [
        {
            "partner_code": "AP-1024",
            "property_id": 1547,
            "code": "SC1547"
        }
    ],
    "skipped": [
        {
            "partner_code": "AP-1024",
            "property_id": 1547
        }
    ],
    "errors": [
        {
            "errorCode": "PARTNER_PROPERTY_NOT_FOUND",
            "errorMessage": "string"
        }
    ]
}

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500