Listar Propiedades

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada una de las propiedades registradas en la inmobiliaria.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/properties

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método	GET
Content-Type	application/json
Authorization	Bearer token, Token obtenido al consumir el servicio Login

Parámetros
Parámetro	Tipo	Obligatorio	Valor por defecto	Descripción
page	integer	No	1	Especifica la página de resultados que se desea recuperar al realizar la solicitud.
limit	integer	No	10	Especifica el número máximo de elementos que se deben devolver en la solicitud, el límite máximo es de 50.
listing_start_date	string	No		Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler. Formato: YYYY/mm/dd
listing_end_date	string	No		Representa la fecha de fin del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler. Formato: YYYY/mm/dd

Nota: Para los parámetros de tipo fecha que se compongan de un rango, como listing_start_date y listing_end_date, se debe tener en cuenta que si se envía solo el start_date, se retornarán registros donde la condición es “>= (mayor o igual)”. Si solo se envía el end_date, se retornarán registros donde la condición es “<= (menos o igual)”, y si se envían ambas, entonces se retornarán registros dentro de ese rango de fechas.

Ejemplos de peticiones

https://{{instancia}}.arrendasoft.co/service/v2/public/properties

https://{{instancia}}.arrendasoft.co/service/v2/public/properties/

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26&listing_end_date=2024-03-26

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las propiedades.

[
    {
        "codigo": "137",
        "titulo": "Apartamento cerca del estadio y la cuarta brigada",
        "clase_id": "1247",
        "clase_inmueble": "Apartamento",
        "tipo_servicio_id": "arriendo",
        "tipo_servicio": "Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2024-04-26",
        "asesor_id": "5",
        "asesor": "InterServicios",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "5",
        "departamento": "Antioquia",
        "municipio_id": "1",
        "municipio": "Medellin",
        "barrio_id": "3",
        "barrio": "Estadio",
        "direccion": "CALLE 50 # 74 - 12",
        "coordenadas": "6.21505012838972:-75.57529436962885",
        "valor_arriendo1": "1600000",
        "valor_arriendo2": "0",
        "valor_venta1": "0",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "75.00",
        "observaciones": null,
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": "propietario",
        "folio_matricula": null,
        "referencia_catastral": null,
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "3",
        "cantidad_videos": "1",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "3"
            },
            {
                "id": "5",
                "descripcion": "Nº De Piso",
                "tipo_campo": "numeric",
                "orden": "3",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "4",
                "descripcion": " Antigüedad del Inmueble",
                "tipo_campo": "numeric",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "3"
            },
            {
                "id": "14",
                "descripcion": "Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características Internas",
                "valor": "1"
            },
            {
                "id": "34",
                "descripcion": "Sala",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "31",
                "descripcion": "Red de gas",
                "tipo_campo": "select",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "si",
                "valor_texto": "Si"
            },
            {
                "id": "63",
                "descripcion": "Garaje",
                "tipo_campo": "checkbox",
                "orden": "10",
                "grupo": "Características Internas",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "272",
                "documento": "4207050496",
                "nombres": "CRISTINA GUERRERO",
                "apellidos": ""
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
            },
            {
                "posicion": "3",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
            }
        ],
        "videos": [
            {
                "url": "608AV8w6gL0",
                "tipo": "youtube",
                "descripcion": null,
                "posicion": "1"
            }
        ]
    },
    {
        "codigo": "136",
        "titulo": "FINCA",
        "clase_id": "1254",
        "clase_inmueble": "Finca",
        "tipo_servicio_id": "venta y arriendo",
        "tipo_servicio": "Venta y Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2021-04-16",
        "asesor_id": "6",
        "asesor": "KAREN CANO",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "11",
        "departamento": "Bogota D.c.",
        "municipio_id": "150",
        "municipio": "Bogota",
        "barrio_id": "838",
        "barrio": "Bosa",
        "direccion": "CR 145 # 85 - 9",
        "coordenadas": "4.875468815048683:-73.62556445019526",
        "valor_arriendo1": "6050000",
        "valor_arriendo2": "0",
        "valor_venta1": "500000000",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "1200.00",
        "observaciones": "Esta finca ofrece una experiencia rural única con comodidades modernas. La espaciosa casa principal cuenta con encantadoras habitaciones, cuenta con una reluciente piscina y áreas verdes bien cuidadas.",
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": null,
        "folio_matricula": "0",
        "referencia_catastral": "0",
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "2",
        "cantidad_videos": "0",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "9"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "11",
                "descripcion": "Zona de lavandería",
                "tipo_campo": "checkbox",
                "orden": "14",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "9",
                "descripcion": "Cuarto de servicio",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "26",
                "descripcion": "Sauna / Turco / Jacuzzi",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "83",
                "documento": "2830863285",
                "nombres": "LILIA MARLEN",
                "apellidos": "LOPEZ CASTELLANOS"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_431b70772304a609c280036305f66ac4.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_209e299b845c8bdf9479f5fb055461fe.jpeg"
            }
        ],
        "videos": []
    }
]

Descripciones de las claves de cada elemento

Clave	Descripción
`codigo`	Código del inmueble
`titulo`	Título del anuncio del inmueble
`clase_id`	ID de la clase del inmueble
`clase_inmueble`	Clase del inmueble
`tipo_servicio_id`	ID del tipo de servicio
`tipo_servicio`	Tipo de servicio (arriendo/venta)
`estrato`	ID del estrato del inmueble
`estrato_texto`	Texto descriptivo del estrato
`fecha_consignacion`	Fecha de consignación del inmueble
`asesor_id`	ID del asesor
`asesor`	Nombre del asesor
`pais_id`	ID del país
`pais`	Nombre del país
`departamento_id`	ID del departamento
`departamento`	Nombre del departamento
`municipio_id`	ID del municipio
`municipio`	Nombre del municipio
`barrio_id`	ID del barrio
`barrio`	Nombre del barrio
`direccion`	Dirección del inmueble
`coordenadas`	Coordenadas geográficas del inmueble
`valor_arriendo1`	Valor principal de arriendo
`valor_arriendo2`	Valor secundario de arriendo
`valor_venta1`	Valor principal de venta
`valor_venta2`	Valor secundario de venta
`valor_administracion`	Valor de administración
`avaluo_catastral`	Avalúo catastral del inmueble
`impuesto_predial`	Impuesto predial
`area`	Área del inmueble
`observaciones`	Observaciones adicionales
`propiedad_destacada`	Indicador de propiedad destacada
`llaves_en`	Lugar donde están las llaves
`llaves_otro`	Otro lugar donde están las llaves
`paga_cuota_sost`	Quién paga la cuota de sostenimiento
`folio_matricula`	Folio de matrícula
`referencia_catastral`	Referencia catastral
`edificio_unidad`	Nombre del edificio o unidad
`estado`	ID del estado del inmueble
`estado_texto`	Texto descriptivo del estado
`cantidad_images`	Cantidad de imágenes del inmueble
`cantidad_videos`	Cantidad de videos del inmueble
`caracteristicas`	Lista de características del inmueble
`propietarios`	Lista de propietarios
`imagenes`	Lista de imágenes del inmueble
`videos`	Lista de videos del inmueble

Características

Cada elemento dentro de la lista caracteristicas tiene las siguientes claves:

Clave	Descripción
`id`	ID de la característica
`descripcion`	Descripción de la característica
`tipo_campo`	Tipo de campo de la característica
`orden`	Orden de la característica
`grupo`	Grupo al que pertenece la característica
`valor`	Valor de la característica
`valor_texto`	Texto descriptivo del valor (si aplica)

Propietarios

Cada elemento dentro de la lista propietarios tiene las siguientes claves:

Clave	Descripción
`id`	ID del propietario
`documento`	Documento de identificación
`nombres`	Nombres del propietario
`apellidos`	Apellidos del propietario

Imágenes

Cada elemento dentro de la lista imagenes tiene las siguientes claves:

Clave	Descripción
`posicion`	Posición de la imagen
`size`	Tamaño de la imagen
`imagen`	URL de la imagen

Videos

Cada elemento dentro de la lista videos tiene las siguientes claves:

Clave	Descripción
`url`	URL del video
`tipo`	Tipo de video (e.g., YouTube)
`descripcion`	Descripción del video
`posicion`	Posición del video