Skip to the content

StreetsByLocalityKey

Finds a list of streets within a town or village that match the requested street name.

Live Demo

To connect to this service you'll need to use one of these endpoints:

WSDL
https://webservices.data-8.co.uk/addresscapture.asmx
JSON
https://webservices.data-8.co.uk/AddressCapture/StreetsByLocalityKey.json

Description

Finds a list of streets within a town or village that match the requested street name.

The localityKey indicates the area to search within. This can be obtained from the results of the LocalitiesByName or LocalitiesByPostcode methods.

The street name is assumed to have a wildcard at the end, e.g. "High" will match "High Street".

If null is supplied as the street parameter, all streets in the locality will be returned.

Note that, where a town contains multiple villages, you must supply the localityKey for the correct village in order to find the expected street. If you supply the localityKey that represents only the town without a village, only streets that are found in the town itself (i.e. not in a village within the town) will be included in the results.

If you only know the town name and not whether the street is within a village in that town, you may prefer to use the StreetsByName method, which does not have this limitation.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
licence

licence

As the Royal Mail PAF database can be licensed in multiple ways, this parameter indicates under which license you are accessing the data. This must match the variant you have a license or credits for - if you are unsure which option to choose, please contact your account manager

localityKey

localityKey

The identifier of a locality as returned from the LocalitiesByName or LocalitiesByPostcode methods

street

street

The name of the street to find within the locality

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
Results

Results

Contains an array of streets that match the query. Each street is returned with a Description, which contains a partial, human-readable version of the address, and an ID which can be supplied to the AddressesByStreetKey method to get the list of addresses on the street

Live Demo

licence
localityKey
street
options No options are currently supported by this method
Credits Remaining Today: 5

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today