Propiedades

📘

Los endpoints disponibles se encuentran en el apartado Properties de nuestra referencia API.

Consultar el listado de tus propiedades

Puedes obtener la lista de todas tus propiedades haciendo un GET al endpoint /properties.

Para realizar tu búsqueda puedes usar los filtros disponibles:

  • Page: Te ayudará con la paginación de los resultados.
  • Limit: Por defecto la cantidad de resultados que entregamos es de 20 y el límite es de 50 por página.
  • Search[property_types]: Array de strings con los símbolos de los tipos de propiedades que quieres buscar. Consulta los símbolos actuales en /property_types. Es opcional y puedes incluir más de un tipo.
  • Search: Filtro que te ayudará con la búsqueda de propiedades de acuerdo a sus características.
    Los disponibles son:
{
  "updated_after": "2020-03-01T23:26:53.402Z",
  "updated_before": "2025-03-01T23:26:53.402Z",
  "operation_type": "sale",
  "min_price": 500000,
  "max_price": 3000000,
  "min_bedrooms": 1,
  "min_bathrooms": 1,
  "min_parking_spaces": 1,
  "min_construction_size": 100,
  "max_construction_size": 1000,
  "min_lot_size": 100,
  "max_lot_size": 1000
}
  • Search[statuses]: Array de strings con el que puedes buscar por el estatus actual de las propiedades.

Por útlimo, si no aplicas alguno de estos filtros la API te devolverá todas las propiedades.

Puedes probar este endpoint en List all properties.

Consultar los detalles de una propiedad específica

Si deseas obtener la información completa de una propiedad en específico, tendrás que usar la ruta /properties/{property_id}.

Puedes hacer la consulta con el ID interno que le hayan asigando o con el ID de EasyBroker que tiene cada propiedad.

Al consultar una propiedad obtendrás todos los detalles de la misma incluyendo fotografías, descripción, tipo de operación, características, entre otros.

Puedes probar este endpoint en Retrieve a property.

Crear una propiedad

Para crear una propiedad deberás hacer un POST al endpoint /properties.

Debes considerar que hay 6 campos obligatorios:

  • property_type: Es el símbolo estable del tipo de propiedad. Consulta los valores actuales en /property_types. Los nombres siguen siendo compatibles, pero pueden cambiar o traducirse.
  • operations: Es donde indicarás el tipo de operación de la propiedad y su precio.
  • title: Es el título que tendrá la publicación.
  • description: La descripción de la publicación, cuenta con un límite de 4000 caracteres.
  • status: El status con el que se creará la propiedad, recomendamos crearla como not_published para que no se publique de inmediato y por si acaso debes hacer alguna corrección.
  • location: En este campo deberás indicar la ubicación exacta de la propiedad. Para saber cuáles son las ubicaciones registradas en EasyBroker puedes consultar nuestra guía de Ubicaciones.

Los demás campos que encuentras en la referencia son opcionales y posteriormente puedes ir actualizando su información de acuerdo a tus necesidades. No es obligatorio crear tu propiedad con toda la información sin embargo lo recomendamos para que empieces a publicar y compartir tu inventario en la Bolsa Inmobiliaria.

Consulta todos los campos, tipos y reglas en Create a property.

❗️

Importante

Si creas la propiedad con estado published, también puede enviarse a los portales que tengas activos. Usa not_published si quieres revisarla primero.

Actualizar una propiedad

Cuando ya tienes tu inventario en EasyBroker puedes actualizarlo las veces que lo necesites. Haz un PATCH al endpoint /properties/{property_id} con los campos que deseas cambiar. Los campos que no envíes conservan su valor.

El único parámetro obligatorio al momento de hacer el request será el ID de la propiedad.
Recuerda que puedes usar el ID interno o el ID de EasyBroker.

Consulta los campos disponibles en Update a property.


Continúa con

Did this page help you?