Find properties, streets and buildings by typed address
/api/v1/search/addressesTurns typed text into property slugs, using the same cascade as the search box on the website. Three shapes of query are recognised automatically. A postcode ("AL1 2AY") or a postcode district ("AL1") returns the properties in it. A name with a number ("7 Ashwood Mews") resolves straight to the matching homes. A name on its own ("Ashwood Mews") returns the streets and buildings that match, with a count of the properties inside each, so you can narrow and search again.
Results are a mixed list discriminated by kind. A property result carries the slug every other endpoint is keyed by. A street or building result is not addressable on its own: add a house or flat number to the query to turn it into properties.
- A name plus a number can return both: the matching homes first, then the streets and buildings that matched, which is what you get back when the street exists but that number does not.
- Search covers the whole of the UK. Properties withdrawn at the owner's request are never returned.
detailplaces an entity: the post town, prefixed by the street when the entity is a named building.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
q | query | string | Yes | The address, place or postcode to search for. At least 2 characters, or 3 when it is not a postcode. | 7 ashwood mews |
limit | query | integer | No | How many results to return.Defaults to 10.Minimum 1. Maximum 25. | 10 |
curl -H "Authorization: Bearer upl_live_Ab12Cd34EfGhIjKlMnOpQrStUvWxYz01" \
"https://ukpropertylooker.com/api/v1/search/addresses?q=7%20ashwood%20mews"{
"data": [
{
"kind": "property",
"slug": "7-ashwood-mews-bridge-of-don-aberdeen-ab22-8xs",
"displayName": "7 Ashwood Mews, Aberdeen",
"postcode": "AB22 8XS"
},
{
"kind": "property",
"slug": "7-ashwood-mews-st-albans-al1-2ay",
"displayName": "7 Ashwood Mews, St Albans",
"postcode": "AL1 2AY"
},
{
"kind": "street",
"name": "Ashwood Mews",
"detail": "St Albans",
"propertyCount": 11
}
],
"meta": {
"query": "7 ashwood mews",
"count": 7,
"limit": 10
}
}