HomeEscape API

Service

Name	Search Properties
Description	Get a list of properties that match 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

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

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.

Response

            
                {
                    "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",
                            "Beach"
                           ],        
                         "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": 0,
                         "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://homeescape.com/.../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..."
                        },    
                        ...
                    ]
                }

Response Codes

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	"You have been logged out." - [Take the user to the login screen]
`EC004`	`Not found result`	There are problems finding the data in our database	"We are still working on adding properties to this location. Please visit again soon."
`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]
`VID218`	`Invalid input for luxury`	Luxury is not in [0,1]	[Call the API again using a valid value for luxury]