FindAddress
Finds addresses using a fuzzy free-text search.
This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.
Description
Finds details of an address matching the search criteria. The search is performed using the town
, street
and building
parameters. The town
parameter is required, and at least one of the street
and building
parameters must also be specified.
The search is performed using fuzzy matching, so some amount of misspelling is allowed, although exact matches will be preferred.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
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 |
town | town The name of the town to search in. |
street | street The name of the street to find in the |
building | building The name of the building or organisation to find in the |
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 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 addresses that match the query. Each address is returned with a |