v1
latestOpenAPI 3.0.02026-07-13393178.8 KBSearch for properties
This endpoint returns a paginated list of properties which match the search criteria.
A typical use case would be to search for a property via this endpoint then use the HATEOAS links included in the results to view the summary valuation.
You must include at least one search query parameter to make a valid request:
- postcode
- billingAuthorityReference
The property search endpoint does not support pagination the same way as all the other paginated endpoints. After requesting a page of properties, you can query for the next page of results by specifying a combination of <code>afterAddress</code> and <code>afterUarn</code> - these will be the full address and UARN of the last property in your current page of search results. This is as if you were saying: "I've seen all properties up to here, give me what comes next."
The <code>afterUarn</code> parameter must only be used in addition to <code>afterAddress</code>. It's optional, but it's best to always include it, as some addresses might encompass multiple UARNs.
Query parameters
Filters the results to include properties which match the provided postcode. The search is not case sensitive and must contain the 'Outward Code' (e.g. RH1). This, or at least one other search parameter, must be included in your search.
Filters the results to include properties which are inside the provided billing authority. The search is not case sensitive and supports partial references. This, or at least one other search parameter, must be included in your search.
Filters the results down to a single property with the given UARN. This, or at least one other search parameter, must be included in your search.
The results for this endpoint are paginated and this refers to the number of elements per page
The last property address you've retrieved if you want to get to the next page of results. The search will only return properties with address alphabetically after the specified address
return only properties with UARNs greater than the specified UARN. Must be used in conjunction with afterAddress
Headers
Specifies the response format and the version of the API to be used