agentslist
Find and filter UK property agents by location, name, or type (estate, letting, commercial) with sorting options for price, age, or alphabetical order.
Instructions
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:
200 (Success): Successful response
Content-Type:
application/json
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| location | Yes | 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 | No | One of the followings : estate-agents|letting-agents|commercial-agents | |
| company_name | No | 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 | No | One of the following : a_z|lowest_avg_price|highest_avg_price|shortest_avg_age|longest_avg_age | |
| pn | No | The page index for paging purpose | 1 |
| radius | No | The radius (miles) to look for agents (0.25 - 40) | 0 |