GET /properties
Duas formas: um imóvel pelo seu paId, ou a lista dos seus.
Um imóvel
GET https://property-api.mapaprop.com/property-v1/properties/{paId}
A lista
GET https://property-api.mapaprop.com/property-v1/properties
{ "total": 12, "items": [ { "…" } ] }
A lista é de UM clientRef, não de todo o seu inventário. Devolve os imóveis do cliente que
você envia em x-client-ref. Para o inventário de outra, peça com o clientRef dela. Veja
clientRef.
Autenticação
Authorization: Bearer <seu token>.
curl https://property-api.mapaprop.com/property-v1/properties/01M3PTZ8YBMM5DSNW03WP8VD9E \
-H "Authorization: Bearer $TOKEN"
A resposta
A resposta traz o clientRef, o mesmo que você enviou no envelope. Nós o devolvemos nos seis
caminhos (verify, cadastro, consulta, listagem, edição e exclusão) para que você possa cruzá-lo com a sua
base sem ter que lembrar com qual clientRef perguntou.
O mesmo que o cadastro devolveu — object,
portals, summary — mais o detalhe das imagens.
Os portais são recalculados a cada consulta. Não é uma foto do dia em que você cadastrou: se melhorarmos o mapeamento de um portal, você vê isso aqui sem enviar nada de novo.
verdictAtCreation — o veredito do dia do cadastro
Além de portals — que é recalculado — o GET traz o veredito tal como foi no dia em que você
cadastrou, com a sua data:
"verdictAtCreation": {
"at": "2026-09-29T21:52:43.549Z",
"argenprop": { "status": "fields_complete", "blockers": [] },
"zonaprop": { "status": "fields_complete", "blockers": [] }
}
Para decidir se publica, olhe portals, não isto. Os dois convivem de propósito e dizem coisas
diferentes:
portals | o que o sistema diria hoje |
verdictAtCreation | o que disse no dia do cadastro, com a sua data |
verdictAtCreation é registro histórico: serve para explicar por que um cadastro de um mês atrás
passou ou não passou, com o mapeamento que existia então.
published — o que está publicado em cada portal
O que a publicação escreveu do outro lado. Enquanto você não publicar, vem como null:
"published": {
"cabaprop": { "itemId": null, "remoteStatus": null },
"argenprop": { "itemId": "01M41AQNXYG4W4SEEEEPHEDNX4", "portalItemId": 20685478, "remoteStatus": "published" },
"zonaprop": { "itemId": "01M41AQNXYG4W4SEEEEPHEDNX4", "remoteStatus": "published" }
}
| Campo | O que é |
|---|---|
itemId | O código com o qual nós nomeamos o anúncio nesse portal |
portalItemId | O id que o portal deu ao anúncio — veja abaixo |
remoteStatus | O seu estado: published, unpublished ou error |
portalItemId — o id do portal, sem gastar cota
Alguns portais devolvem o id do anúncio na mesma resposta que o publica. Quando o fazem, nós o guardamos e o entregamos aqui: é o número com o qual o anúncio existe no painel do portal, e o que o suporte deles reconhece se o seu cliente escrever para eles.
| Portal | Vem? | |
|---|---|---|
| Argenprop | ✅ | devolve ao publicar |
| Zonaprop | — | a sua publicação vai identificada pelo código que nós enviamos: não devolve um id próprio |
Não é preciso consultar o estado para tê-lo. Aparece assim que você publica, e lê-lo aqui é de
graça. Se o seu portal não está na tabela, o campo é omitido — não vem como null.
⚠️ Pode mudar durante a vida da propriedade. No Argenprop, derrubar um anúncio libera o seu
código, portanto publicar de novo cria um anúncio novo, com outro portalItemId. Se você guardar
o número do seu lado, releia-o depois de cada publicação.
E se você consultou o estado, também url e remote
Quando você usa GET …/publication/{portal}, o que o
portal respondeu fica guardado aqui. Assim você lê de novo sem gastar outra chamada de cota:
"published": {
"zonaprop": {
"itemId": "01M41AQNXYG4W4SEEEEPHEDNX4",
"remoteStatus": "published",
"url": "https://www.zonaprop.com.ar/propiedades/clasificado/-60321762.html",
"remote": {
"portalItemId": 60321762,
"publicationState": "ONLINE",
"visits": 37,
"checkedAt": "2026-10-03T18:42:57.716Z"
}
}
}
| Campo | O que é |
|---|---|
url | Onde o anúncio publicado pode ser visto |
remote | Tudo o que o portal disse na última vez que perguntamos — o detalhe completo aqui |
remote.checkedAt | De quando é este dado. Se for suficiente, não é preciso consultar de novo |
url e remote não aparecem até você consultar o estado pelo menos uma vez. Não vêm como
null de propósito: um null diria "não há estado no portal", e a verdade é "ainda não
perguntamos".
São TRÊS campos e nomeiam o mesmo anúncio de três maneiras. Vale deixá-los claros:
| Campo | De quem é | De onde sai | Custa? |
|---|---|---|---|
itemId | nosso — o código com o qual publicamos | nós o montamos | de graça |
portalItemId | do portal | ele respondeu ao publicar | de graça |
remote.portalItemId | do portal | ele respondeu ao consultar o estado | 1 chamada de cota |
Os dois últimos nomeiam a mesma coisa e deveriam coincidir. Se diferirem, o de remote é mais antigo:
diz o que o portal reportava no seu checkedAt.
⚠️ A url ainda precisa do estado — mas por outro motivo: o id sozinho não basta, também é
preciso saber montar o endereço público desse portal. Hoje nós o montamos para o Zonaprop; para o
Argenprop ainda não, então a sua url fica em null em vez de lhe dar um link quebrado.
mapaprop — o cadastro na sua conta
Só se você é cliente da Mapaprop e gerou o seu token pelo app. A propriedade é cadastrada sozinha na sua conta quando termina a ingestão das imagens, e este bloco diz como foi:
{
"mapaprop": {
"state": "synced",
"propertyId": 2619527,
"branchId": 1,
"message": "La propiedad existe en tu cuenta de Mapaprop con el id 2619527 (sucursal 1)…"
}
}
O propertyId é o id da Mapaprop, diferente do paId desta API: é com ele que você a encontra
no app. Os estados (pending, synced, rejected, blocked, exhausted), o que cada um
significa e quando tentar de novo estão em
Tentar o cadastro de novo; o panorama completo, em
Mapaprop.
Esta é a forma de saber se algo falhou. O cadastro roda sozinho e em diferido, então o estado é consultado aqui — não avisamos por nenhum outro canal.
synced significa que a propriedade existe na sua conta, não que esteja publicada.
images e assets — o estado das suas imagens
images dá o resumo e assets o detalhe, uma entrada por imagem:
"images": { "status": "partial", "total": 4, "processed": 3 },
"assets": [
{ "n": 1, "slot": "image", "source": "https://tu-cdn.com/frente.jpg",
"url": "https://…/image-1.jpg", "ok": true },
{ "n": 2, "slot": "image", "source": "https://tu-cdn.com/living.jpg",
"error": "el host del origen no existe (DNS no resuelve) [ENOTFOUND]", "ok": false }
]
| Campo | O que é |
|---|---|
slot | image ou blueprint |
source | A URL que você nos enviou |
url | Onde ficou. Somente se ok |
error | Por que não pôde ser baixada. Somente se não ok |
Os estados de images.status e o que fazer com cada um estão em
POST /properties.
Erros
| Código | Quando |
|---|---|
401 | Token ausente, vencido ou inválido |
404 | Esse paId não existe |
O GET nunca devolve 409: consultar é sempre possível, mesmo enquanto as imagens estão sendo
baixadas. Aliás, é assim que se acompanha o andamento.
Relacionados
- POST /properties — o cadastro
- DELETE /properties/{paId} — excluir