URL Querystring parameters for API and JS plugin

The listings returned by BDP can be controlled via the URL (web address) parameters of the page called. This is referred to as a Search Query and takes the form outlined below. This enables you to have a menu on your website that could be, for example, linking to properties by area, properties by price or by number of bedrooms.

We have tried to include a number of examples below, but if you are having difficulty generating the specific search you need, please use our support ticket system to get in touch.

The search query forms a standard url query string, except that is starts with a ‘&’ instead of a ‘?’. A search url should be of the form:

In all examples on this page ‘yourwebsite.com’ should be replaced with the Listings Page URL, on many sites this may be yourwebsite.com/properties.html. The Listings Page URL can be set in Domain Details on the Technical Configuration page in the User Interface.

Contents Search Paramaters Search Ordering Options Search Query Examples Property Types

---

Search Parameters

Search Ordering Options

Search ordering parameters define the order in which the property results appear, this is set using the ‘ord’ value in the query string. The default is asking price in descending order.

Search Query Examples

 

Look for lettings outside Edinburgh under £1000

 

Look for sales properties between £200,000 and £300,000

 

Look for all lettings in Edinburgh

 

Look for all flats for sale in Edinburghunder £500,000

 

Look for all terraced bungalows to let

 

Look for all flats for sale in Edinburgh under £500,000 in ascending order of price

 

Look for all flats for sale in Edinburgh under £500,000 in ascending order of date marketed

Property Types

The following table shows available property types and their corresponding ids. Parent Ids (in bold) will look for all child types, eg Id 47 (Flat / Apartments) will look for all forms of Flat.