Este serviço retorna a lista de empreendimentos imobiliários da sua conta (a imobiliária dona do token). O escopo vem do access token, não é enviado como parâmetro.

URL do recurso

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

Código de exemplo

GET /api/action/express-v1/developments?customerId=1&dateFrom=20-02-2019&dateTo=28-02-2019 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Parâmetros

Paginação

Este endpoint utiliza paginação por offset via os parâmetros from e size.

A resposta sempre inclui o campo total com o total de registros que correspondem aos seus filtros (não apenas os retornados na página atual). Use-o para saber quando parar de paginar.

Como paginar

Para obter a página N (índice 1) com um tamanho de página fixo:

from = (N - 1) * size

Continue solicitando a próxima página enquanto from + size < total.

Exemplo: paginar 25 empreendimentos, 20 por página

Suponha que uma busca retorne "total": 25. Para obter todos os resultados são necessárias 2 requisições:

Página 1 — registros 1 a 20:

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

Resposta: { "took": 8, "total": 25, "properties": [ ...20 items... ] }

Página 2 — registros 21 a 25:

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

Resposta: { "took": 6, "total": 25, "properties": [ ...5 items... ] }

Neste ponto from + size = 40 >= total = 25, portanto não há mais páginas.

Observações

• Mantenha os filtros consistentes entre páginas. Alterar qualquer filtro entre requisições (por exemplo operation, stateId, dateFrom) reinicia o conjunto de resultados e seu offset apontará para uma coleção diferente.
• size não pode ultrapassar 20. Solicitar size=21 ou mais retorna um erro de validação: "You cannot retrieve more than 20 properties at a time". Para recuperar conjuntos grandes é necessário paginar.
• from é um offset, não um número de página. from=2 retorna registros a partir da posição 3, não a "página 2".
• O campo took indica o tempo em milissegundos que a busca levou no servidor para aquela página.

Resposta

Um documento JSON com a lista de zonas em hierarquia onde o cliente possui imóveis.

Resposta de exemplo

{
"took":6,
"total":3,
"properties": [
        {
"zipCode":"1884",
"country":"Argentina",
"developmentProperties": [
198102
            ],
"landArea":133,
"county":"Almirante Brown",
"buildingArea":235,
"cityId":897,
"type":220,
"ambiences":2,
"zone":"Malvinas Argentinas, Almirante Brown, Buenos Aires, Argentina",
"price":1200000,
"airConditionerType":"Central",
"publication": [
                {
"mercadolibre":false,
"plan":"no-plan"
                },
                {
"cabaprop":false,
"plan":"no-plan"
                },
                {
"zonaprop":false,
"plan":"no-plan"
                },
                {
"navent":false,
"plan":"no-plan"
                }
            ],
"state":"Buenos Aires",
"branchId":1,
"images": [],
"development":true,
"descriptionFormatted":"Descripcion de un desarrollo unico del sistema.",
"bathrooms":2,
"suspended":false,
"labels": [
"laundry",
"playroom",
"suite"
            ],
"propertyOperation":"Venta",
"bedrooms":2,
"garages":1,
"yearsOld":12,
"reserved":false,
"lastUpdate":"2024-10-22T12:21:00.000-03:00",
"customerCountryDesc":"Argentina",
"code":"1-DESARROLLO-3",
"city":"Malvinas Argentinas",
"description":"Descripcion de un desarrollo unico del sistema.",
"alternativePrices": [],
"title":"titulo de desarrollo",
"networks": [
"4",
"5"
            ],
"customerCountry":1,
"countryId":1,
"seoUrl":"venta-de-desarrollo-inmobiliario-en-malvinas-argentinas-almirante-brown-buenos-aires-1-247058",
"rented":false,
"countyId":140,
"propertyType":"Desarrollo Inmobiliario",
"hightlight": {},
"currency":"ARS",
"timestamp":"2024-10-03T00:00:00.000-03:00",
"sold":false,
"address":"Calle 123 1537",
"stateId":2,
"garage":1,
"propertyHash":"1a9ad9df2c25980db55e6f74c5d62b94",
"mainImage":"https://s3.amazonaws.com/mapaprop-dev-image/photos/noimage.gif",
"garageType":"Espacio Guarda Coche",
"location": {
"lon":"-58.54596230000001",
"lat":"-34.5904958"
            },
"attributes": [
                {
"group_sub":"label",
"country":"ar",
"key_legacy":"hasLaundry",
"group_subtype":"spaces",
"id":"laundry",
"label":"Lavadero",
"locale":"es_AR",
"type":"bool",
"group":"propertyAttribute",
"status":true
                },
                {
"group_sub":"label",
"country":"ar",
"key_legacy":"petsReady",
"group_subtype":"extras",
"id":"petsReady",
"label":"Apto mascotas",
"locale":"es_AR",
"type":"bool",
"group":"propertyAttribute",
"status":true
                },
                {
"group_sub":"label",
"country":"ar",
"key_legacy":"playroom",
"group_subtype":"spaces",
"id":"playroom",
"label":"Playroom",
"locale":"es_AR",
"type":"bool",
"group":"propertyAttribute",
"status":true
                },
                {
"group_sub":"label",
"country":"ar",
"key_legacy":"hasPrivatElevator",
"group_subtype":"ammenities",
"id":"private-elevator",
"label":"Elevador privado",
"locale":"es_AR",
"type":"bool",
"group":"propertyAttribute",
"status":true
                },
                {
"group_sub":"label",
"country":"ar",
"key_legacy":"suite",
"group_subtype":"spaces",
"id":"suite",
"label":"Dormitorio en suite",
"locale":"es_AR",
"type":"bool",
"group":"propertyAttribute",
"status":true
                }
            ],
"operation":1
        }
    ]
}