Tendência Lar Developers Platform
V1.0.0 Voltar
Documentação Oficial v1.0

Construa o futuro do
Mercado Imobiliário

Integre a inteligência do Tendência Lar diretamente na sua plataforma. Nossa API RESTful oferece performance e segurança para suas operações.

Base URL
api.tendencialar.com
GET /v1/status
200 OK

Status do Ecossistema

Endpoint fundamental para monitoramento de saúde do serviço e verificação de conectividade básica.

Estrutura de Resposta

Response JSON 
{
    "name": "Tendência Lar API",
    "version": "1.0.0",
    "status": "online",
    "timestamp": "2026-06-03 21:56:06"
}

Protocolo de Autenticação

Esta API segue o padrão RFC 6750, utilizando Bearer Tokens no cabeçalho Authorization para autenticar todas as requisições protegidas..

Inclua o token de acesso no cabeçalho de cada requisição:

HTTP Header
Authorization: Bearer <seu_token_api>

Aviso Crítico: Seu token de API é uma chave mestre. Nunca compartilhe ou armazene em ambientes vulneráveis como GitHub público ou arquivos JS client-side.

GET /v1/properties
200 OK

Listagem Progressiva

Recupere sua coleção de imóveis com suporte nativo a filtros dinâmicos, ordenação avançada e paginação de alta performance.

Query Parameters

Parâmetro Tipo Descrição
page int Índice da página para navegação (default: 1)
status string Filtro de visibilidade: ativo, inativo
type string Categoria do imóvel (casa, apartamento, etc.)
city string Nome da cidade para localização
is_launch bool Filtro para lançamentos: true ou false
launch string Filtro pela fase do lançamento: na_planta, em_construcao, pronto_para_morar

Payload de Sucesso

Response Object 
{
  "status": "success",
  "pagination": {
    "current": 1,
    "total_pages": 15
  },
  "data": [
    {
      "uuid": "c7b1...",
      "title": "Penthouse Garden",
      "price": 1250000.00,
      "city": "Campinas"
    }
  ]
}
POST /v1/properties
201 CREATED

Inserção de Imóvel

Publique novos imóveis instantaneamente.

Request Body (JSON)

Campo Tipo Requisito Descrição
purpose string Sim venda ou locacao
price float Cond. Obrigatório se venda.
bedrooms int Não Número de quartos.
area_total float Sim Área total em m².
images array Não Array de URLs de imagens extras.
videos array Não Array de objetos com description e url.
is_launch bool Não Indica se o imóvel é um lançamento.
launch string Cond. Fase do lançamento: na_planta, em_construcao ou pronto_para_morar. Obrigatório se is_launch for true.
Imagens devem ser enviadas como URLs públicas acessíveis.
O limite máximo por requisição é de 20 fotos extras.

Payload de Exemplo

Request JSON 
{
  "price": "850000.00",
  "rent_price": "0.00",
  "condo_fee": "1500.00",
  "iptu": "750",
  "bedrooms": 4,
  "bathrooms": 3,
  "suites": 3,
  "garages": 4,
  "area_total": "1000.00",
  "area_built": "800.00",
  "year_built": 2026,
  "type": "casa",
  "subtype": "Casa em Condomínio",
  "is_launch": true,
  "launch": "em_construcao",
  "purpose": "venda",
  "status": "ativo",
  "city": "Marília",
  "state": "SP",
  "description_full": "Descrição completa sobre o imóvel",
  "complement": "Uma breve descrição do imóvel",
  "district": "JD. Esmeralda",
  "zipcode": "17516-000",
  "image": "https://tendencialar.com/public/img/types/flat.avif",
  "code": "45825",
  "features": ["Academia", "Portaria 24h"],
  "images": [
    "https://tendencialar.com/public/img/types/churrasqueira.avif",
    "https://tendencialar.com/public/img/types/mobiliado.avif"
  ],
  "videos": [
    {
      "description": "Vídeo 1",
      "url": "https://www.youtube.com/watch?v=2jjzJ3W6pLg"
    },
    {
      "description": "Vídeo 2",
      "url": "https://www.youtube.com/watch?v=5DJadSRyNxU"
    }
  ]
}
PUT /v1/properties/{uuid}
200 UPDATED

Atualizar Imóvel

Modifique propriedades existentes. Envie apenas os campos que deseja alterar.

Request Body 
{
  "price": 895000.00,
  "status": "ativo"
}
DELETE /v1/properties/{uuid}
200 OK

Remoção Definitiva

Remove o registro permanentemente do nosso banco de dados. Esta ação não pode ser desfeita.

Response Example 
{
  "status": "success",
  "code": 200,
  "message": "Imóvel deletado com sucesso."
}
GET /v1/types

Dicionário de Categorias

Obtenha a árvore completa de Tipos e Subtipos permitidos para cadastro, garantindo integridade de dados na sua UI.

Response Example 
{
  "casa": ["Casa de Condomínio", "Sobrado", "Térrea"],
  "apartamento": ["Cobertura", "Duplex", "Loft", "Studio"]
}
GET /v1/leads

Gerenciamento de Leads

Monitore contatos interessados em seus imóveis em tempo real.

Response Example 
{
  "status": "success",
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_pages": 1,
    "total_records": 1
  },
  "data": [
    {
      "uuid": "4de2f6c5-2b2f-11f1-92e5-a6e8d4b39b52",
      "created_at": "2026-03-29 02:22:39",
      "updated_at": "2026-03-29 02:22:39",
      "name": "Lucas Silva",
      "email": "[email protected]",
      "phone": "14987654321",
      "source": "formulario_contato",
      "message": "Olá, gostaria de mais informações sobre este imóvel.",
      "utm": {
        "campaign": null,
        "medium": null,
        "content": null
      },
      "property": {
        "uuid": "d27b7e9f-4cb0-474e-8368-72d0427fa549",
        "title": "Casa em Condomínio no Jd. Esmeralda",
        "url": "https://tendencialar.com/imovel/marilia/sp/casa-em-condominio....",
        "city": "Marília",
        "state": "SP"
      }
    }
  ]
}
DELETE /v1/leads/{uuid}
200 OK

Remover Lead

Remove permanentemente um lead. Esta ação é irreversível.

Response Example 
{
  "status": "success",
  "code": 200,
  "message": "Lead deletado com sucesso."
}
GET /v1/visits

Agenda de Visitas

Visualize o cronograma de visitas agendadas pelos clientes através da plataforma.

Response Example 
{
  "status": "success",
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_pages": 1,
    "total_records": 1
  },
  "data": [
    {
      "uuid": "be3fde25-63ab-d03b-8964-e0bd9a246f8aa052",
      "visitor": {
        "name": "Marques da Silva",
        "email": "[email protected]",
        "phone": "14987654321"
      },
      "schedule": {
        "date": "2026-04-07",
        "time": "09:00:00",
        "datetime": "2026-04-07 09:00:00"
      },
      "status": "pendente",
      "notes": null,
      "created_at": "2026-03-29 02:31:54",
      "updated_at": "2026-03-29 02:31:54",
      "property": {
        "uuid": "d27b7e9f-4cb0-474e-8368-72d0427fa549",
        "title": "Casa em Condomínio no Jd. Esmeralda",
        "url": "https://tendencialar.com/imovel/marilia/sp/casa-em-condominio...",
        "city": "Marília",
        "state": "SP"
      }
    }
  ]
}
DELETE /v1/visits/{uuid}
200 OK

Remover Agendamento

Remove permanentemente um agendamento de visita.

Response Example 
{
  "status": "success",
  "code": 200,
  "message": "Visita deletada com sucesso."
}