¿Qué es?
La API provee perfiles de propiedades generados procesalmente para asistir el desarrollo de páginas web orientadas al rubro inmobiliario.
Contiene perfiles de departamentos, casas, oficinas, comercios, terrenos, campos, y galpones con características acordes. Estos perfiles fueron generados con un algoritmo y no representan propiedades reales.
La API también acepta una amplia variedad de parámetros para ordenar, paginar, y filtrar los resultados.
What is it?
The API provides procedurally generated property profiles to assist in the development of websites aimed at real estate.
It contains profiles for apartments, houses, offices, stores, lots, fields, and sheds with matching features.
It also acceps a wide range of parameters to sort, paginate, and filter the results.
¿Cómo usar?
How to use?
ENDPOINTSGET props
Devuelve una lista con todos los perfiles de propiedades que cumplen con los parámetros establecidos. Los filtros son excluyentes. Por default, la paginación está configurada para ordenar los resultados cada 20 páginas y devolver la primer página (ambos de estos parámetros son configurables)
It returns a list with all the property profiles that match the parameters. The filters are exclusionary. By default, pagination is configured to sort results by 20 pages and to return the first page (both these parameters are configurable)
Ordenación
Sorting
- sortBy=[
price| expenses| bathrooms| bedrooms|...] - Propiedad con la que ordenar los resultados. Toma un único argumento. Acepta como argumento cualquier propiedad que posean los perfiles.
- Property to use to sort results. It takes a single argument. It accepts any property existing profiles contain as the argument.
- sortOrder=[
asc| desc] - Sentido en el que ordenar los resultados. Toma un único argumento.
- Direction results are to be ordered in. It takes a single argument.
Paginación
Pagination
- page=
(int) - Número de página a devolver. Toma un único argumento.
- Number of pages to return. It takes a single argument.
- forPage=
(int) - Cantidad de perfiles que contendrá cada página. Toma un único argumento.
- Amount of profiles pages will contain. It takes a single argument.
Filtros
Filters
- price=
min [,max] - Precio de la propiedad. Si recibe sólo un argumento se lo considera precio mínimo. Si recibe dos argumentos se los considera respectivamente precios minimo y maximo.
- Property price. If passed a single argument it's considered as the minimum price. If passed two arguments they're considered respectively minimum and maximum price.
- operation=
rent, buy - Tipo de operación de la propiedad.
- Operation type.
- bedrooms=
min [,max] - Cantidad de habitaciones que deben poseer las propiedades. Si recibe sólo un argumento se considera cantidad mínima. Si recibe dos argumentos se las considera respectivamente cantidades mínima y maxima.
- Amount of rooms properties must have. If passed a single argument it's considered minimum amount. If passed two arguments they're considered respectively minimum and maximum amounts.
- bathrooms=
min [,max] - Cantidad de baños que deben poseer las propiedades. Si recibe sólo un argumento se considera cantidad mínima. Si recibe dos argumentos se las considera respectivamente cantidades mínima y maxima.
- Amount of bathrooms properties must have. If passed a single argument it's considered minimum amount. If passed two arguments they're considered respectively minimum and maximum amounts.
- amenities=
amoblado, ascensor, balcon, barrioCerrado, calefon, chimenea, cochera, cocina, lavanderia, pilera, patio, sotano - Amenidades que deben poseer las propiedades.
- Amenities properties must have.
- built=
min [,max] - Año de construcción de la propiedad. Si recibe sólo un argumento se considera año mínimo. Si recibe dos argumentos se los considera respectivamente años minimo y maximo.
- The propety's construction year. If passed a single argument it's considered minimum year. If passed two arguments they're considered respectively minimum and maximum years.
- timeMarketDays=
min [,max] - Cantidad de dias en el que la propiedad estuvo en el mercado. Si recibe sólo un argumento se considera cantidad mínima. Si recibe dos argumentos se las considera respectivamente cantidades mínima y maxima.
- Amount of days that the property has been in the market. If passed a single argument it's considered minimum amount. If passed two arguments they're considered respectively minimum and maximum amounts.
- currency=
ars, usd - Moneda de transacción de la propiedad.
- Property transaction currency.
- expenses=
min [,max] - Expensas de la propiedad.
- Property expenses.
- area=
min [,max] - Superficie de la propiedad.
- Property area.
- hectaresField=
min [,max] - Hectáreas del campo.
- Field hectares.
- added=
dd/mm/yyyy [,dd/mm/yyyy] - Fecha en la que se agregó el perfil de la propiedad al sitio.
- Date the profile was created on the site.
- edited=
dd/mm/yyyy [,dd/mm/yyyy] - Fecha en la que se editó por ultima vez el perfil de la propiedad.
- Date the profile was last edited.
GET props/{id}
Devuelve el perfil de la propiedad con la ID especificada.
Returns the property profile with the specified ID.