Filtrado¶
Todos los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de propiedades, ver la sección de Obtener todas las propiedades
| Filtro | Tipo | Detalle |
|---|---|---|
| match | String | Palabras claves para realizar una busqueda. |
| id_property | Number | Id de la propiedad. |
| id_user | Number | Id del usuario asociado a la propiedad. |
| title | String | Título parcial o completo de la propiedad. |
| id_country | Number | Id de un país, ver Paises. |
| id_region | Number | Id de una región, ver Regiones. |
| id_city | Number | Id de una ciudad, ver ciudades. |
| id_location | Number | Id de una localidad, ver Localidades. |
| id_zone | Number | Id de una zona, ver Zonas. |
| id_property_type | Number | Id del tipo de propiedad, ver Tipos de propiedad |
| for_sale | Boolean | Inmueble en venta |
| for_rent | Boolean | Inmueble esta diponible para la renta |
| for_transfer | Boolean | Inmueble esta diponible para permutar(transferencia). |
| min_bedrooms | Number | Número mínimo de habitaciones de la propiedad |
| max_bedrooms | Number | Número máximo de habitaciones de la propiedad |
| bathrooms | Number | Número mínimo de baños de la propiedad |
| garages | Number | Número mínimo de garajes de la propiedad |
| id_status_on_page | Number | Id del estado de la propiedad, ver Estado en la página. |
| id_availability | Number | Id de la disponibilidad de la propiedad, ver Disponibilidad. |
| id_property_condition | Number | Id de la condición de la propiedad, ver la sección Condiciones de la propiedad. |
| building_date | Number | Año de construcción mínimo de la propiedad. |
| min_price | Number | Precio mínimo de la propiedad. |
| max_price | Number | Precio máximo de la propiedad. |
| min_private_area | Number | Area privada mínima de la propiedad. |
| max_private_area | Number | Area privada máxima de la propiedad. |
| min_built_area | Number | Area construida mínima de la propiedad. |
| max_built_area | Number | Area construida máxima de la propiedad. |
| min_area | Number | Area mínima de la propiedad. |
| max_area | Number | Area máxima de la propiedad. |
| scope | Number | Indica si se listan las propiedades propias o de los aliados, ver scope |
| short | Boolean | Si se envía como true no se muestra en la respuesta los listados de Galerías y Características |
Es posible fitrar inmuebles en varias zonas, para ello en la propiedad id_zone se deben agregar los Id de las zonas separados por coma ( , ).
Note
Si se envía el parametro short con valor true retorna una versión reducida de la propiedad, sin el listado de Galerías y Características. Estos listado se pueden obtener de forma independiente como esta indicado en Galerías de la propiedad, y Características de la propiedad.
Filtrado adicional¶
Aplican opciones de filtrado definidas en Galerías de imágenes de la propiedad.
| Filtro | Tipo | |
|---|---|---|
| lax_business_type | Boolean | El valor de lax_business_type es false por defecto. Cuando lax_business_type es true, se listan los inmuebles que cumplan con al menos uno de los filtros de tipo de negocio (for_sale, for_rent, for_transfer) enviados como true. Cuando lax_business_type es false se listan los inmuebles que cumplan todos los filtros de tipo de negocio (for_sale, for_rent, for_transfer) enviados como true. |
Paginación y ordenamiento¶
| Filtro | Tipo | |
|---|---|---|
| skip | Number | Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno) |
| take | Number | Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo) |
| order | String | Puede tomar dos valores asc (Ascendente) y desc (Descendente), desc por omisión |
| order_by | String | Ordena por una criterio en específico, id_property por omisión ver order_by |
order_by¶
| Valor | Descripción |
|---|---|
| id_property | Ordena las propiedades por id |
| title | Ordena las propiedades por título |
| id_country | Ordena las propiedades por país |
| id_region | Ordena las propiedades por región |
| id_city | Ordena las propiedades por ciudad |
| id_property_type | Ordena las propiedades por tipo |
| id_business_type | Ordena las propiedades segun su tipo de negocio |
| sale_price | Ordena las propiedades por su precio de venta |
| rent_price | Ordena las propiedades por su precio de renta |
| visits | Ordena las propiedades por su número de visitas |
| id_status_on_page | Ordena las propiedades por estado, ver Estado en la página. |
| created_at | Ordena las propiedades por fecha de registro |
| max_price | Ordena las propiedades por precio de mayor a menor |
| min_price | Ordena las propiedades por precio de menor a mayor |
Scope¶
| Valor | Representa |
|---|---|
| 1 | Privado, lista sólo las propiedades creadas por la empresa. |
| 2 | Aliados, lista sólo las propiedades activas de empresas aliadas. |
| 3 | Todas, lista propiedades privadas y propiedades activas de empresas aliadas. (opción por defecto) |
| 4 | Club, sólo cuenta las propiedades activas en los clubes. |