Este serviço retorna a lista de zonas onde o cliente possui imóveis.
| Informações do recurso | |
|---|---|
| Autenticação | Obrigatória (Token de API, Bearer) |
| Scope | express-base |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
URL do recurso
https://mapaprop.app/api/action/express-v1/zones
Código de exemplo
GET /api/action/express-v1/zones HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
Resposta
Um documento JSON com a lista de zonas em hierarquia onde o cliente possui imóveis.
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | states | Array of State | yes | A lista de objetos State |
| State | description | string | yes | A descrição do estado |
| id | int | yes | O ID do estado | |
| count | int | yes | Quantidade de imóveis publicados do cliente nesse estado | |
| counties | Array of County | no | A lista de objetos County (é a segunda divisão geográfica da região; pode não ser um município em sentido estrito) | |
| County | description | string | yes | A descrição do município |
| id | int | yes | O ID do município | |
| count | int | yes | Quantidade de imóveis publicados do cliente nesse município | |
| cities | Array of City | no | A lista de objetos City | |
| City | description | string | yes | A descrição da cidade |
| id | int | yes | O ID da cidade | |
| count | int | yes | Quantidade de imóveis publicados do cliente nessa cidade |
Sobre count
É a quantidade de imóveis publicados do cliente nessa zona, com o mesmo critério que o resto do serviço usa. Serve para montar um seletor que mostre quantos imóveis há em cada zona sem precisar de uma consulta por zona.
Os níveis acumulam: o count de um estado inclui o de todos os seus municípios, e o de um município inclui o de todas as suas cidades.
Uma zona só aparece na resposta se o cliente tiver pelo menos um imóvel publicado nela, portanto count nunca é 0.
Mudança de 29 de setembro de 2026. Até essa data o arranjo cities repetia uma entrada por imóvel: um município com 100 imóveis em 20 cidades devolvia 100 entradas, com a mesma cidade várias vezes. Agora devolve uma entrada por cidade, e a quantidade de imóveis viaja em count. Se a sua integração deduplicava por conta própria, pode parar; se contava as entradas repetidas para estimar volume, use count.
Exemplo de resposta
{
"states": [
{
"description": "Capital Federal",
"id": 1,
"count": 98,
"counties": [
{
"description": "Belgrano R",
"id": 14,
"count": 6
},
{
"description": "Las Cañitas",
"id": 15,
"count": 3
},
{
"description": "Microcentro",
"id": 24,
"count": 7
},
{
"description": "Monserrat",
"id": 25,
"count": 1
},
{
"description": "Puerto Madero",
"id": 26,
"count": 2
},
{
"description": "Retiro",
"id": 27,
"count": 9
},
{
"description": "San Nicolás",
"id": 28,
"count": 2
},
{
"description": "Colegiales",
"id": 32,
"count": 6
},
{
"description": "Congreso",
"id": 33,
"count": 1
},
{
"description": "Nuñez",
"id": 43,
"count": 9
},
{
"description": "Palermo",
"id": 46,
"count": 4
},
{
"description": "Palermo Chico",
"id": 48,
"count": 1
},
{
"description": "Palermo Hollywood",
"id": 49,
"count": 2
},
{
"description": "Palermo Soho",
"id": 50,
"count": 7
},
{
"description": "San Cristobal",
"id": 58,
"count": 7
},
{
"description": "San Telmo",
"id": 59,
"count": 2
},
{
"description": "Villa Crespo",
"id": 62,
"count": 4
},
{
"description": "Almagro",
"id": 90,
"count": 2
},
{
"description": "Balvanera",
"id": 91,
"count": 9
},
{
"description": "Belgrano",
"id": 93,
"count": 7
},
{
"description": "Constitución",
"id": 99,
"count": 1
},
{
"description": "Recoleta",
"id": 116,
"count": 2
},
{
"description": "Barrio Norte",
"id": 654,
"count": 4
}
]
},
{
"description": "Córdoba",
"id": 6,
"count": 1,
"counties": [
{
"description": "Colón",
"id": 273,
"count": 1,
"cities": [
{
"description": "Colonia Tirolesa",
"id": 255,
"count": 1
}
]
}
]
},
{
"description": "Formosa",
"id": 9,
"count": 7,
"counties": [
{
"description": "Laishi",
"id": 496,
"count": 7,
"cities": [
{
"description": "Herradura",
"id": 2896,
"count": 7
}
]
}
]
},
{
"description": "La Rioja",
"id": 12,
"count": 1,
"counties": [
{
"description": "Chilecito",
"id": 561,
"count": 1,
"cities": [
{
"description": "Colonia Malligasta",
"id": 4011,
"count": 1
}
]
}
]
}
]
}