Mapaprop
PROD

Retorna os imóveis que o cliente marcou como destaques para o seu site, na ordem que ele escolheu.

Informações do recurso
AutenticaçãoObrigatória (Token de API, Bearer)
Scopeexpress-base
Método HTTPGET
RespostaJSON
Versão1

URL do recurso

https://mapaprop.app/api/action/express-v1/featureds

Código de exemplo

GET /api/action/express-v1/featureds HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}

Parâmetros

NomeTipoObrigatórioDescrição
fromintnoA partir de qual destaque começar. Padrão 0. Serve para pedir a segunda página, a terceira, e assim por diante.
sizeintnoQuantos destaques retornar. Padrão 20, que também é o máximo; acima disso o serviço responde com um erro.

Resposta

Um documento JSON com a mesma forma que GET /api/action/express-v1/properties: a escolha do cliente é um filtro e uma ordem, não outro tipo de objeto, então os imóveis chegam com os mesmos campos e podem ser exibidos com o mesmo código.

🔴 A ordem importa e é a que o cliente definiu no seu painel. A lista chega já ordenada: não a reordene.

Um imóvel em destaque que não esteja publicado —vendido, suspenso ou despublicado— simplesmente não aparece. Destacar define o que é mostrado primeiro, não se pode ser mostrado.

Se o cliente não marcou nenhum destaque, a resposta é a lista vazia, com a mesma forma.

Se houver mais de 20

O campo total diz quantos destaques o site tem no total, não quantos esta resposta traz. Se total for maior que os imóveis que você recebeu, peça a página seguinte com from:

GET /api/action/express-v1/featureds?from=0&size=20
GET /api/action/express-v1/featureds?from=20&size=20

Um from além do último destaque retorna a lista vazia com o total real, não um erro.

⚠️ Uma página pode trazer menos imóveis que o size pedido: os destaques que não estão publicados não voltam (veja acima). Por isso a paginação se faz olhando o total, em vez de esperar que cada página venha completa.

Exemplo de resposta

{
  "took": 3,
  "total": 9,
  "properties": [
    {
      "propertyId": 2603801,
      "code": "1-AB1234",
      "title": "...",
      "propertyOperation": "...",
      "propertyType": "...",
      "price": 185000,
      "currency": "USD",
      "photos": ["https://images.mapaprop.app/photos/1/2603801/3025164.jpg"]
    }
  ]
}