Propiedades
Los endpoints disponibles los encuentras 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 en el cual deberás indicar si buscas un tipo de propiedad en especial. Es opcional y puedes incluir más de 1 tipo de propiedad.
- 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 nuestra referencia dando clic aquÃ.
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 nuestra referencia dando clic aquÃ.
Crear una propiedad
Para crear una propiedad deberás hacer un POST al endpoint /properties
.
Debes de considerar que hay 5 campos obligatorios al momento de hacerlo y son:
- property_type: Es el tipo de propiedad que usarás y deberá ser idéntico a como existe en EasyBroker. Puedes consultar los tipos de propiedad disponibles en este enlace.
- 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.
Puedes probar este endpoint en nuestra referencia dando clic aquÃ.
Actualizar una propiedad
Cuando ya tienes tu inventario en EasyBroker puedes actualizarlo las veces que lo necesites, solo deberás hacer un PATCH al endpoint /properties
con los campos y la información que necesites actualizar.
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.
Puedes probar este endpoint en nuestra referencia dando clic aquÃ.
Consultar las propiedades de tus colaboradores
Si lo que quieres es obtener las propiedades de las colaboraciones que tienes en EasyBroker deberás de contar con un plan en especÃfico, llamado API MLS. Si estás interesado por favor envÃanos un mensaje en el chat para poder ayudarte.
Puedes encontrar más información en nuestra guÃa sobre la API MLS dando clic aquÃ.
Updated 3 months ago