| Response |
took |
int |
yes |
How long the search took in milliseconds |
|
total |
int |
yes |
How many total records are in the context of this search. You can paginate thru them |
|
Filters |
Array of filters |
yes |
The list of filters in url |
|
brokerId |
filter int |
|
The broker ID filter response |
|
properties |
Array of Property |
yes |
The list of Property objects |
| Property |
propertyHash |
string |
yes |
A unique ID for the property |
|
custId |
int |
yes |
The customer ID |
|
timestamp |
string |
yes |
ISO8601 timestamp of when the property was created |
|
lastUpdate |
string |
yes |
ISO8601 timestamp of when the property was last updated |
|
code |
string |
yes |
A unique code of the property entered by the customer |
|
branchId |
int |
yes |
The ID of the branch that this property is related to. ‣. |
|
type |
string |
yes |
The translated description of the property type. ‣ |
|
operation |
string |
yes |
The translated description of the property operation. ‣ |
|
propertyType |
string |
yes |
The id of the property type. ‣ |
|
propertyOperation |
int |
yes |
The id of the property operation. ‣ |
|
status |
string |
yes |
The translated description of the property status of the building. ‣ |
|
mainImage |
string |
no |
The url of the main thumbnail related to the property |
|
currency |
string |
yes |
The currency symbol of the price of the property. ‣ |
|
price |
int |
yes |
The price of the property |
|
expensesCurrencies |
string |
no |
The currency symbol of the monthly / yearly expenses of the property. ‣ |
|
expensesPrice |
int |
no |
The price of the monthly / yearly expenses of the property |
|
taxCurrency |
string |
no |
The currency symbol of the monthly / yearly taxes of the property. ‣ |
|
taxPrice |
int |
no |
The price of the monthly / yearly taxes of the property |
|
title |
string |
yes |
A title entered by the customer |
|
address |
string |
yes |
The street address and number of the property |
|
zipCode |
string |
yes |
The postal code of the property location |
|
zone |
string |
yes |
A friendly description combining from city (if available) to state |
|
countryId |
int |
yes |
The ID of the property country location |
|
stateId |
int |
yes |
The ID of the property state location. ‣ |
|
countyId |
int |
yes |
The ID of the property county location. ‣ |
|
cityId |
int |
no |
The ID of the property city location. ‣ |
|
countryId |
int |
yes |
The ID of the property country location. ‣ |
|
country |
string |
yes |
The name of the country |
|
state |
string |
yes |
The name of the state |
|
county |
string |
yes |
The name of the county or 2nd division location |
|
city |
string |
no |
The name of the city / neighborhood or 3rd division |
|
suspended |
boolean |
yes |
The publication has been suspended |
|
reserved |
boolean |
yes |
The property has been reserved |
|
rented |
boolean |
yes |
The property has been rented |
|
sold |
boolean |
yes |
The property has been sold |
|
description |
string |
yes |
The long description of the property |
|
conditions |
string |
no |
The long conditions statement of the property. Usually related to payments |
|
bedrooms |
int |
no |
Number of bedrooms of the property |
|
ambiences |
int |
no |
Number of ambiences / spaces of the property |
|
bathrooms |
int |
no |
Number of bathrooms of the property |
|
dependencies |
int |
no |
Number of dependency rooms (extra rooms) |
|
occupancy |
int |
no |
Number of occupants (generally if this is a temp rental) |
|
toilettes |
int |
no |
Number of toilettes (half bathrooms) in the property |
|
buildingArea |
int |
no |
Square meters of the built area |
|
landArea |
int |
no |
Square meters of the land of the property |
|
yearsOld |
int |
no |
How old the property is |
|
ubication |
string |
no |
The property cardinal ubication in the building |
|
totalFloors |
int |
no |
The total floors in the building |
|
apartmentsPerFloor |
int |
no |
The amount of apartments per floor |
|
airConditionerType |
string |
no |
Type of air conditioner. |
|
waterHeaterType |
string |
no |
Type of water heater. |
|
heatingType |
string |
no |
Type of heating appliances. |
|
balconyType |
string |
no |
Type of balcony. |
|
garage |
int |
no |
The total garages of the property |
|
garageType |
string |
no |
Type of garage. |
|
images |
Array of Image |
no |
Array of Image object |
|
location |
Location |
yes |
Location object |
| Location |
lon |
string |
yes |
Longitude location of the property |
|
lat |
string |
yes |
Latitude location of the property |
| Image |
image |
string |
yes |
URL for image |
|
thumbnail |
string |
yes |
URL for the thumbail |
|
orientation |
int |
yes |
Orientation of the image. 1 = PORTRAIT, 2 = LANDSCAPE |
|
type |
int |
yes |
Type of image. 1 = PHOTO, 2 = BLUEPRINT |
|
contentType |
string |
yes |
The image content type |
|
timestamp |
string |
yes |
The ISO8601 timestamp of when the image was uploaded |
| Labels |
labels |
Array of labels |
no |
The labels / amenities of properties - ‣ |
| Object |
Field |
Type |
Required |
Description |
| Filters |
bedrooms |
int |
no |
The number of bedrooms in the property |
|
size |
int |
yes |
The size of property response |