Hierarchical ​Search

Drill down through towns and streets to find addresses

Overview

If you need to explore the addresses by drilling down from towns to streets to addresses, these methods are for you.

Normally the Postcode Search and Free-Text Search options will provide the simplest user experience, but for instances where they may not be appropriate for you these methods allow you to start off searching for a town and drill down to the streets and finally into the addresses.

With this approach, start off with the LocalitiesByName or LocalitiesByPostcode methods to find the town.

Pass the locality key from the results of those methods to the StreetsByLocalityKey method to drill down to the streets in that town. Alternatively, bypass the initial search for a town and jump straight to the street using StreetsByName instead.

Finally, pass the street key from the results of that method to the AddressesByStreetKey method to find addresses on that street.