Skip to the content

StreetsByName

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

Live Demo

This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.

Changing the hosting country does not affect the data returned by the service. However you may wish to select a particular country based on your data residency requirements or network latency.
JSON
Open API
SOAP

Description

Finds a list of streets that match the requested street name within towns or villages matching the locality name.

This method is equivalent to calling the LocalitiesByName method to retrieve a list of all towns or villages that match the locality name, then calling StreetsByLocalityKey for each of the returned towns or villages to find the requested street. However, this method provides much better performance than making these repeated calls. See the documentation for the LocalitiesByName and StreetsByLocalityKey methods for further details.

Credit Usage

Requests to this method do not consume credits, but you must have some AddressCapture credits available.

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

locality

locality

The name of the locality to search for the street within

street

street

The name of the street to find within the locality

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

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
locality
street
options
Name Value
Common Options

Sample Code