| Name | Filter Properties |
|---|---|
| Description | Get a list of properties that macth with the search criteria |
| Method | GET |
| URL | /search/search?[location=Florida%2C+United+States][&page=1][&per_page=10][&luxury=0]... |
| Example | /api/search/search?location=Florida%2C+United+States&page=1&per_page=10&luxury=0... | Access | EVERYONE |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| Fields | Type | Required | Description |
|---|---|---|---|
| location | text | no | Location by Google, same structure. |
| page | number | no | It can be used to paginate the result. By default 0 returns page 1 with 100 items per page. |
| per_page | number | no | It can be used to limit the result. By default 100 items per page. |
| luxury | bool | no | It can be used if you want to get luxury properties. By default 0 doesn't return luxury properties. |
| check_in | date | no | Tentative check in. |
| check_out | date | no | Tentative check out. |
| min_price | number | no | Minimum price. |
| max_price | number | no | Maximum price. |
| min_sleeps | number | no | Minimum sleeps. |
| max_sleeps | number | no | Maximum sleeps. |
| min_bedrooms | number | no | Minimum bedrooms. |
| max_bedrooms | number | no | Maximum bedrooms. |
| bedrooms | number | no | Exactly number of bedrooms. |
| min_bathrooms | number | no | Minimum bathrooms. |
| max_bathrooms | number | no | Maximum bathrooms. |
| bathrooms | number | no | Exactly number of bedrooms. |
| property_type | array | no | Types of properties: Check here. |
| location_types | array | no | Types of locations: Check here. |
| amenities | array | no | Types of amenities: Check here. |
{
"items_total": "2024",
"items": [
{
"id": "10000000",
"tagline": "Newly Renovated Splendor - Islander 317!!!",
"description": "CONTACT US for a detailed quote or for more information on SPECIALS...",
"luxury": false,
"size": "1109",
"size_unit": 0,
"property_type": "Condo",
"location_types": [
"Near The Ocean",
"Waterfront",
"Golf"
],
"bedrooms": 2,
"bathrooms": 2,
"half_bath": 0,
"sleeps": 6,
"currency": "USD",
"bedding": "King Size in Master Bedroom...",
"views": 6981,
"min_price": 174,
"favorite": 0,
"reviews_av": 5,
"reviews_total": 7,
"featured": true,
"subscribed": false,
"location": {
"address": "Kissimmee, FL, United States",
"latitude": "28.324052481956",
"longitude": "-81.627319020172",
"country": "USA",
"state": "Florida",
"city": "Kissimmee",
"neighborhood": "null",
"postal_code": "null",
"show_map": true
},
"images": [
{
"id": 174320,
"description": "",
"image": "http://dev.homeescape.com/uploads/images/2255/14250000/medium/HE-14250000-6614474.jpg"
},
...
],
"owner": {
"name": "Srikanth",
"photo": "http://dev.homeescape.com/uploads/images/2255/CoronadoBeach_Highfield-1038.JPG"
},
"purchased": "2015",
"why_this": "We chose our home after looking at many, many properties...",
"benefits": "Water views and easy beach access drew us to this home..."
},
...
]
}
| Code | Message | Cause | Possible Frontend Message [Behavior] |
|---|---|---|---|
EC000 |
Internal error in API |
Internal error connecting the database | "Oops! Looks like we hit a snag. Try closing the app and reopening it." |
EC001 |
User not found |
Token user id doesn't match our records | "Sorry, We couldn't find your information!" |
EC004 |
Not found result |
There are problems finding the data in our database | We couldn't find any results that matched your request, please expand your search and try again. |
SC006 |
User no authorization |
The token role is not valid for using the API services | "Access Denied. Try contacting the support team." |
SC014 |
Expired token |
The token has expired | "Access Denied. Try contacting the support team." |
VID110 |
Invalid input for page |
Page is not a number | [Call the API again using a valid value for page] |
VID111 |
Invalid input for per_page |
Per_page is not a number | [Call the API again using a valid value for per_page] |
VID202 |
Invalid input for check_in |
Check_in doesn't meet the date's format | "Please enter a valid Check In date" |
VID203 |
Invalid input for check_out |
Check_out doesn't meet the date's format | "Please enter a valid Check Out date" |
VID218 |
Invalid input for luxury |
Luxury is not in [0,1] | [Call the API again using a valid value for luxury] |
VID264 |
Invalid input for min_price |
Min_price is not a number | "Min_price must have only numbers" - [Call the API again using a valid value for min_price] |
VID265 |
Invalid input for max_price |
Max_price is not a number | "Max_price must have only numbers" - [Call the API again using a valid value for max_price] |
VID266 |
Invalid input for min_sleeps |
Min_sleeps is not a number | "Min_sleeps must have only numbers" - [Call the API again using a valid value for min_sleeps] |
VID267 |
Invalid input for max_sleeps |
Max_sleeps is not a number | "Max_sleeps must have only numbers" - [Call the API again using a valid value for max_sleeps] |
VID268 |
Invalid input for min_bedrooms |
Min_bedrooms is not a number | "Min_bedrooms must have only numbers" - [Call the API again using a valid value for min_bedrooms] |
VID269 |
Invalid input for max_bedrooms |
Max_bedrooms is not a number | "Max_bedrooms must have only numbers" - [Call the API again using a valid value for max_bedrooms] |
VID270 |
Invalid input for bedrooms |
Bedrooms is not a number | "Bedrooms must have only numbers" - [Call the API again using a valid value for bedrooms] |
VID271 |
Invalid input for min_bathrooms |
Min_bathrooms is not a number | "Min_bathrooms must have only numbers" - [Call the API again using a valid value for min_bathrooms] |
VID272 |
Invalid input for max_bathrooms |
Max_bathrooms is not a number | "Max_bathrooms must have only numbers" - [Call the API again using a valid value for max_bathrooms] |
VID273 |
Invalid input for bathrooms |
Bathrooms is not a number | "Bathrooms must have only numbers" - [Call the API again using a valid value for bathrooms] |