GetFullAddress
Gets a list of addresses on a postcode
To connect to this service you'll need to use one of these endpoints:
Description
This is the main method to do postcode lookup operations.
Supply:
postcode
- the full postcode to get the address forbuilding
- an optional building to filter the results by
To get all the buildings in a postcode, leave the building
parameter blank.
Each address will be returned as a FormattedAddress
, which includes both a human-readable address, and a RawPAFAddress
which contains a separate field for each part of the address, e.g. building number, street name etc. The details of how the formatted version of the address is generated from the raw address is controlled by the options described below. For more information and examples on the formatting options, please see the Address Formatting page.
If the specified postcode
does not exist, Status.Success
will be false
and Status.ErrorMessage
will indicate that an invalid postcode has been entered.
If you do not have a full postcode, use the FindAddress
or FindFullAddress
methods instead.
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 |
postcode | postcode The full postcode to get addresses for. Formatting of the postcode does not matter so |
building | building An optional value to filter the returned addresses by building name, number, sub-premise (e.g. flat number) or company name. If |
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.
Formatter | Formatter Pick from one of the available formatters to control how the raw address is converted into a human-readable address:
|
---|---|
FixTownCounty | FixTownCounty
|
MaxLines | MaxLines The number of lines to format the address over. An additional line will be included in the result for the postcode. |
MaxLineLength | MaxLineLength The maximum number of characters that can appear in each address 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 |
ExcludeCounty | ExcludeCounty Excludes the county, if any, from the formatted address |
UseAnyAvailableCounty | UseAnyAvailableCounty Uses any available county to populate the formatted address, not just the postal county |
UnwantedPunctuation | UnwantedPunctuation A string containing any punctuation characters to be removed from the formatted address |
FixBuilding | FixBuilding Ensures the building name/number is always placed in the first line |
IncludeUDPRN | IncludeUDPRN Set to |
IncludeLocation | IncludeLocation Set to |
ReturnResultCount | ReturnResultCount Indicates if the |
IncludeNYB | IncludeNYB Set to |
IncludeMR | IncludeMR Set 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
|
---|---|
ResultCount | ResultCount Contains the number of addresses in the |
Results | Results Contains an array of addresses that match the query.
A formatted version of each address in the array is available in the |