| propertiesv2list | List properties for sale or rent with options and filters Query Parameters: locationValue (Required): The value of geoLabel field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of name field returned in .../house-prices/v2/get-area (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. locationIdentifier (Required): The value of geoIdentifier field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of id field returned in ..../house-prices/v2/get-area endpoint (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. category: One of the following residential|commercial furnishedState: One of the following : Any|furnished|part_furnished|unfurnished includeRented: Example value: includeRetirementHomes: Example value: includeSharedAccommodation: Example value: includeSharedOwnership: Example value: includeSold: Example value: isAuction: Example value: petsAllowed: Example value: billsIncluded: Example value: keywords: Any word or term, ex : garden,wooden floors section: One of the following : for-sale|to-rent bedsMax: Max number of bed rooms (1 - 10) bedsMin: Min number of bed rooms (1 - 10) priceMax: Maximum sale or rent price priceMin: Minimum sale or rent price sortOrder: One of the following : newest_listings|highest_price|lowest_price|most_reduced page: The page index for paging purpose radius: The radius (miles) to look for properties (0.25 - 40) priceFrequency: One of the following per_month|per_year newHomes: One of the following : only|exclude added: Recently added. One of the following : 24_hours|3_days|7_days|14_days|30_days propertySubType: Filter properties by category. Ignore OR one of the followings (Separated by comma for multiple options) : park_home,bungalow,farms_land,terraced,flats,semi_detached,detached chainFree: Example value: reducedPriceOnly: Example value: feature: One of the followings : has_balcony_terrace|has_parking_garage|has_garden . Separated by comma for multiple options. Ex : has_balcony_terrace,has_parking_garage,... tenure: One of the followings : share_of_freehold|freehold|leasehold. Ex : freehold,leasehold,... smartTags: One of the followings : condition.needs_modernisation|architecture.period_property|type.cottage|style.modern|attributes.utility_room|attributes.basement|attributes.conservatory|attributes.home_office|attributes.bath|attributes.en_suite|attributes.patio|attributes.kitchen_island. Ex : condition.needs_modernisation,architecture.period_property,...
Responses: |
| house_pricesv2estimate | Returned list of estimated house prices Query Parameters: geoIdentifier (Required): The value of 'urlPath' field returned in .../house-prices/v2/auto-complete endpoint OR the value of 'id' field returned in .../house-prices/v2/get-area endpoint. after: The offset to ignore for paging purpose. first: The number of items per response
Responses: |
| agentsdetail | Get detailed information of an agent by id Query Parameters: Responses: |
| agentslist | List agents with filters and options Query Parameters: location (Required): The value of geoIdentifier field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of id field returned in ..../house-prices/v2/get-area endpoint (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. search_type: One of the followings : estate-agents|letting-agents|commercial-agents company_name: Search by agent name. Either 'location' or 'company_name' is required. You can ignore 'location' parameter when passing value into 'company_name' parameter. agents_sort: One of the following : a_z|lowest_avg_price|highest_avg_price|shortest_avg_age|longest_avg_age pn: The page index for paging purpose radius: The radius (miles) to look for agents (0.25 - 40)
Responses: |
| house_pricesget_area_stats_deprecated | Get area stats Query Parameters: Responses: |
| house_pricesget_historic_listings_deprecated | Get historic listings Query Parameters: Responses: |
| house_pricesv2get_area | Use along with .../house-prices/v2/auto-complete endpoint to get related geo id. For example, geo id of postal code. Query Parameters: geoString (Required): Postal code, city, district, ward, area, etc.... Use exact values returned in .../house-prices/v2/auto-complete endpoint for best result
Responses: |
| house_pricesget_running_costs_deprecated | Get running costs Query Parameters: Responses: |
| house_pricesget_market_activity_deprecated | Get market activity in an area Query Parameters: identifier: The value of suggestions/identifier json object returned in .../auto-complete endpoint with properties as search_type. You must use EXACTLY the value returned by the endpoint. area (Required): The value of suggestions/value json object returned in .../auto-complete endpoint with properties as search_type. You must use EXACTLY the value returned by the endpoint.
Responses: |
| house_pricesget_sales_history_deprecated | Get sales history Query Parameters: Responses: |
| propertiesget_nearby_deprecated | Get nearest points of interest Query Parameters: Responses: |
| propertiesv2detail | Get property detail Query Parameters: Responses: |
| propertiesget_broadband_deprecated | Get broadband information Query Parameters: Responses: |
| propertiesget_running_costs_deprecated | Get running costs Query Parameters: listing_id (Required): The value of listing_id field returned in .../properties/list endpoint category: One of the following residential|commercial section: One of the following for-sale|to-rent
Responses: |
| propertieslist_deprecated | List properties for sale or rent with options and filters Query Parameters: area (Required): The value of suggestions/value json object returned in .../auto-complete endpoint with listings as search_type. You must use EXACTLY the value returned by the endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. identifier: The value of suggestions/identifier json object returned in .../auto-complete endpoint with listings as search_type. You must use EXACTLY the value returned by the endpoint. listing_id: The value of listing_id field returned right in this endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. category: One of the following residential|commercial created_since: The date time from which properties added. The format must be yyyy-MM-dd HH:mm:ss, Ex : 2020-09-16 15:00:00 furnished: One of the following furnished|part_furnished|unfurnished include_featured_properties: One of the following 1 | 0 include_rented: One of the following 1 | 0 include_retirement_homes: One of the following yes | no include_shared_accommodation: One of the following yes | no include_shared_ownership: One of the following yes | no include_sold: One of the following 1 | 0 keywords: Any word or term, ex : garden,wooden floors listing_status: One of the following sale | rent maximum_beds: Max number of bed rooms (1 - 10) minimum_beds: Min number of bed rooms (1 - 10) maximum_price: Maximum sale or rent price minimum_price: Minimum sale or rent price order_by: One of the following age|price|price_change|view_count ordering: One of the following ascending|descending page_number: The page index for paging purpose page_size: The number of items per response (max 40) property_type: One of the following and separated by comma for multiple values : flats|farms_land|terraced|semi_detached|detached|bungalow|park_home|offices|retail|industrial|hospitality|land radius: The radius (miles) to look for properties (1 - 40) pets_allowed: One of the following yes | no price_frequency: One of the following per_month|per_year step_back_used: One of the following 1 | 0 bills_included: One of the following yes | no floor_area_max: Maximum floor area, only use with commercial category. floor_area_min: Minimum floor area, only use with commercial category. floor_area_units: One of the following sq_feet|sq_metres new_homes: One of the following yes | no
Responses: |
| propertiesget_area_stats_deprecated | Get area stats Query Parameters: Responses: |
| v2auto_complete | Get auto complete suggestion by term or phrase Query Parameters: Responses: |
| auto_complete_deprecated | Get auto complete suggestion by term or phrase Query Parameters: search_term (Required): Example value: greenwich search_type: One of the following properties|listings. Use listings value to get suggestion for .../properties/list endpoint. Use properties value to get suggestion for .../house-prices/estimate endpoint.
Responses: |
| house_pricesv2detail | Get property price detailed information Query Parameters: Responses: |
| house_pricesv2auto_complete | Get suggestions by term or phrase about city, country, area,etc... Query Parameters: addressPartial (Required): City, district, ward, area, etc....
Responses: |
| house_pricesget_points_of_interest_deprecated | Get nearest points of interest Query Parameters: Responses: |
| house_pricesestimate_deprecated | Returned list of estimated house prices Query Parameters: identifier: The value of suggestions/identifier json object returned in .../auto-complete endpoint with properties as search_type. You must use EXACTLY the value returned by the endpoint. area (Required): The value of suggestions/value json object returned in .../auto-complete endpoint with properties as search_type. You must use EXACTLY the value returned by the endpoint. order_by: One of the following price_paid|last_sold|address|estimated_value ordering: One of the following ascending|descending page_number: The page index for paging purpose page_size: The number of items per response (max 40) property_type: One of the following detached|flat|terraced|semi_detached
Responses: |