Parameters
The following parameters can be supplied to this method
| username |
username apikey-, e.g.
apikey-ABCD-1234-EFGH-5678
|
|---|---|
| password |
password |
| country | country The ISO-2 country code in which the address belongs. |
| id | id The |
| options | options |
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 |
|
Address Formatting Options |
|
| There are a large number of options to control how the raw address details are combined & formatted for presentation. They are described in more detail with live interactive examples on the address formatting reference. A summary of the available options is also listed below. | |
| Name | Description |
| Formatter |
Formatter Pick from one of the available formatters to control how the raw address is converted into a human-readable address:
|
| MaxLines | MaxLines The number of lines to format the address over. An additional line will be included at the end of the results for the postcode |
| MaxLineLength | MaxLineLength The maximum number of characters that can appear in each address line |
| FixTownCounty | FixTownCounty true to ensure that the town and county are returned in the last two address lines, or false if they should appear in the first available line |
| FixBuilding | FixBuilding Ensures the building name/number is always placed in the first line |
| NormalizeCase | NormalizeCase Converts all text in the address except the town name to proper case |
| NormalizeTownCase | NormalizeTownCase Converts the town name to proper case |
| UseAnyAvailableCounty | UseAnyAvailableCounty Uses any available county to populate the formatted address, not just the postal county |
| ExcludeCounty | ExcludeCounty Excludes the county, if any, from the formatted address |
| UnwantedPunctuation | UnwantedPunctuation A string containing any punctuation characters to be removed from the formatted address |
| Geocoding Options | |
| Note: Geocoding information is not available for all addresses. Some addresses (e.g. PO Boxes) do not represent a physical location, while for some countries (including Isle of Man and Channel Islands) the data is not currently available. The information requested by these options will be returned wherever possible, but is not guaranteed for all addresses. | |
| Name | Description |
| IncludeLocation | IncludeLocation Includes location information (latitude/longitude, easting/northing and/or grid reference, depending on country) where possible |
| IncludeCountry | IncludeCountry Include the ISO 2-character code and full name of the country |
| IncludeAdminArea |
IncludeAdminArea Includes names & codes for the administrative areas the address is in where possible. For UK addresses this can include:
For UK addresses, this option sets the For US addresses the |
| Address Unique Reference Options | |
Note: Only one unique identifier for each address will be returned. An error will be returned if you set more than
one of these options to true.
|
|
| Name | Description |
| IncludeUDPRN |
IncludeUDPRN Set totrue to include the UDPRN for
UK addresses
|
| IncludeUPRN |
IncludeUPRN Set totrue to include the UPRN for
UK addresses. This is not available by default and requires additional licensing - speak to your account manager
for additional information.
When this option is enabled, more accurate premise-level information is also used for the geocoding information
used by the |
| Dataset Options | |
| Note: Each additional dataset requires additional licensing. If you attempt to use a dataset which your account is not licensed for an error will be returned. Please speak to your account manager to enable additional datasets | |
| Name | Description |
| IncludeMR | IncludeMR Includes addresses from the UK Multiple Residency database, e.g. multiple flats behind a single letter box, university halls of residence |
| IncludeNYB | IncludeNYB Includes addresses from the UK Not Yet Built database, e.g. houses currently being developed |
| Service-Specific Options | |
| Name | Description |
| PreferredLanguage | PreferredLanguage Set this to |
| IncludeWhat3Words | IncludeWhat3Words Indicates if the coordinates of the what3words searched for by the user should be included in the response instead of the standard coordinates available for the address. This option consumes a what3words credit in addition to the standard PredictiveAddress credit. |
| UseFiveDigitZip | UseFiveDigitZip For US addresses, this option gives you control over the formatting of the zip code returned within the formatted address. Set the value to |
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
|
|---|---|
| Result | Result An object containing full details of a complete address. A formatted version of each address in the array is available in the |