PROD

Retorna todos os anúncios de imóveis em destaque configurados na plataforma.

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/features

Parâmetros

ChaveTipoObrigatórioDescrição
maxintnoQuantidade máxima de destaques a retornar. Padrão: 150

Código de exemplo

GET /api/action/express-v1/features HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Uma lista de objetos Feature (destaque).

ObjetoCampoTipoObrigatórioDescrição
ResponsefeaturesFeatureyesO array de imóveis em destaque para este site
FeaturethumbnailstringyesURL completa da imagem thumbnail
propertyIdintegeryesID do imóvel em destaque
codestringyesCódigo interno do cliente para o imóvel
typeDescstringyesDescrição do tipo de imóvel. Consulte a lista de valores possíveis em > Constantes
operationDescstringyesDescrição da operação. Consulte a lista de valores possíveis em > Constantes
descriptionstringyesDescrição do imóvel. Texto livre inserido pelo cliente
titlestringyesTítulo do imóvel. Texto livre inserido pelo cliente.
featuredIdstringyesID único do anúncio em destaque.
seoUrlstringyesCaminho de URL do imóvel. Pode ser usado para criar um link para o imóvel.
showPricebooleanyesIndica se o cliente decidiu exibir ou não o preço
priceintegeryesPreço do imóvel (venda, aluguel, etc.)
currencystringyesMoeda do preço do imóvel
occupancystringyesQuantidade máxima de pessoas
ambiencesstringyesNúmero de ambientes ou espaços do imóvel
roomsstringyesNúmero de dormitórios do imóvel
soldbooleanSe o imóvel está marcado como Vendido, aparece no JSON
rentedbooleanSe o imóvel está marcado como Alugado, aparece no JSON
suspendedbooleanSe o imóvel está marcado como Suspenso, aparece no JSON
bathrooomsintegerSe o imóvel possui banheiros declarados, aparecem no JSON
buildingAreaintegerSe o imóvel possui área construída declarada, aparece no JSON
langAreaintegerSe o imóvel possui área de terreno declarada, aparece no JSON
reservedbooleanSe o imóvel está marcado como Reservado, aparece no JSON
addressDescstringCombinação de zone1, zone2 e zone3 conforme sua existência
addressstringEndereço do imóvel
zone1stringEstado do imóvel
zone2stringBairro ou município do imóvel
zone3stringCidade do imóvel

Código de exemplo

{
    "features": [
          {
              "rooms": "5",
              "code": "1-44442",
              "typeDesc": "Casa",
              "addressDesc": "Capital Federal,Colegiales",
              "description": "Test Images, Propiedad TestTest Images, Propiedad Test",
              "title": "Test Images, Propiedad Test",
              "type": "2",
              "customerCountry": "1",
              "websiteId": 791,
              "seoUrl": "venta-de-casa-en-colegiales-capital-federal-1-193602",
              "ambiences": "5",
              "price": 10.0,
              "propertyType": "2",
              "custId": 1,
              "currency": "ARS",
              "propertyId": 193602,
              "thumbnail": "https://s3.amazonaws.com/mapaprop-dev-image/photos/1/193054/1950917t.jpg",
              "address": "cloanda",
              "operationDesc": "Venta",
              "featuredId": 40063,
              "zone2": "Colegiales",
              "zone1": "Capital Federal",
              "propertyOperation": "1",
              "propertyTypeDesc": "Casa",
              "showPrice": true,
              "operation": "1",
              "propertyOperationDesc": "Venta",
              "customerCountryDesc": "Argentina"
            }
        {
            ...
        }
    ]
}