GetFullAddress

Gets a list of addresses on a postcode

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

This is the main method to do postcode lookup operations.

Supply:

postcode - the full postcode to get the address for
building - 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.

Credit Usage

Each request to this method consumes 1 AddressCapture credit.

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
postcode	postcode The full postcode to get addresses for. Formatting of the postcode does not matter so `"ch24ne"`, `"CH2 4NE"`, `"ch02 4Ne"` are all accepted.
building	building An optional value to filter the returned addresses by building name, number, sub-premise (e.g. flat number) or company name. If `null` or `""` are supplied, all addresses on the postcode are included in the result.
options	options An array of options that control further details of how this method operates. See the Advanced Options section below for more information.

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: `DefaultFormatter` `PAFStandardFormatter` `NoOrganisationFormatter`
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
IncludeConstituency	IncludeConstituency Includes the UK parliamentary constituency the address is in 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: `County` `CountyCode` `District` `DistrictCode` `Ward` `WardCode` `Country` For UK addresses, this option sets the `Country` field to the name of the nation within the UK, i.e. "England", "Scotland", "Wales" or "Northern Ireland". This overrides the `IncludeCountry` option that would otherwise set it to "United Kingdom" For US addresses the `County`, `CountyCode` and `District` fields can be populated.
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 to `true` to include the UDPRN for UK addresses
IncludeUPRN	IncludeUPRN Set to `true` 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 `IncludeLocation` option.
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
ReturnResultCount	ReturnResultCount Indicates if the `ResultCount` field in the result should be populated with the total number of addresses returned.

Results

This method returns an object containing the following fields:

Status

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
ResultCount	ResultCount Contains the number of addresses in the `Results` field. This field is only populated if the `ReturnResultCount` option is set to `True`
Results	Results Contains an array of addresses that match the query. A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.

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

ResultCount

ResultCount

Contains the number of addresses in the Results field. This field is only populated if the ReturnResultCount option is set to True

Results

Results

Contains an array of addresses that match the query. A formatted version of each address in the array is available in the Address field, and a structured version of the address is available in the RawAddress field.

Live Demo

licence

postcode

building

options

Name	Value
Common Options
ApplicationName
Address Formatting Options
Formatter
MaxLines
MaxLineLength
FixTownCounty
FixBuilding
NormalizeCase
NormalizeTownCase
UseAnyAvailableCounty
UnwantedPunctuation
Geocoding Options
IncludeLocation
IncludeCountry
IncludeAdminArea
Address Unique Reference Options
IncludeUDPRN
IncludeUPRN
Dataset Options
IncludeMR
IncludeNYB
Service-Specific Options
ReturnResultCount

Sample Code

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- https://www.data-8.co.uk/ValidationAdmin/AjaxAPIKey -->
<script type="text/javascript" src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key&load=AddressCapture">
</script>

<script type="text/javascript">

function GetFullAddress(licence, postcode, building) {
  /// <param name="licence">string. One of the following values: WebServerFull, WebClickFull, WebClickThoroughfare, InternalUserFull, InternalUserThoroughfare, SmallUserFull, SmallUserThoroughfare, Lookup, InternalServerFull, InternalServerThoroughfare, FreeTrial, FreeTrialThoroughfare, InternalUserFullArea, InternalUserThoroughfareArea, WebServerThoroughfare</param>
  /// <param name="postcode">string</param>
  /// <param name="building">string</param>
  var addresscapture = new data8.addresscapture();
  
  addresscapture.getfulladdress(
    licence,
    postcode,
    building,
    [
      new data8.option('ReturnResultCount', 'false'),
      new data8.option('MaxLines', '6'),
      new data8.option('FixTownCounty', 'true'),
      new data8.option('IncludeLocation', 'true')
    ],
    showGetFullAddressResult
  );
}

function showGetFullAddressResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  }
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.ResultCount
    //   Contains the number of addresses in the `Results` field. This field is only populated if the `ReturnResultCount` option is set to `True`
    // result.Results
    //   Contains an array of addresses that match the query.
    //   A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.
  }
}

</script>

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function GetFullAddress($licence, $postcode, $building)
{
  $options = array(
    "Option" => array(
      array(
        "Name" => "ReturnResultCount",
        "Value" => "false"
      ),
      array(
        "Name" => "MaxLines",
        "Value" => "6"
      ),
      array(
        "Name" => "FixTownCounty",
        "Value" => "true"
      ),
      array(
        "Name" => "IncludeLocation",
        "Value" => "true"
      )
    )
  );
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "licence" => $licence,
    "postcode" => $postcode,
    "building" => $building,
    "options" => $options
  );
  $client = new SoapClient("https://webservices.data-8.co.uk/AddressCapture.asmx?WSDL");
  $result = $client->GetFullAddress($params);
  if ($result->GetFullAddressResult->Status->Success == 0)
  {
    echo "Error: " . $result->GetFullAddressResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->GetFullAddressResult->ResultCount
    //   Contains the number of addresses in the `Results` field. This field is only populated if the `ReturnResultCount` option is set to `True`
    // $result->GetFullAddressResult->Results
    //   Contains an array of addresses that match the query.
    //   A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.
    //   NOTE: This field contains an array of items, but if it contains only one item,
    //   PHP may not recognise it as an array. To always extract the result of this
    //   field as an array, we recommend you always access it using the
    //   getArrayFromResponse method described at
    //   http://www.php.net/soap_soapclient_soapcall#75797, e.g.
    //   foreach (getArrayFromResponse($result->GetFullAddressResult->Results) as $item)
    //   {
    //     ...
    //   }
  }
}

Request Format

{
  "licence": "WebClickFull",
  "postcode": "CH2 4NE",
  "building": "4",
  "options": {
    "ReturnResultCount": false,
    "MaxLines": 6,
    "FixTownCounty": true,
    "IncludeLocation": true
  }
}

Results Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "ResultCount": 1,
  "Results": [
    {
      "Address": {
        "Lines": [
          "Data 8",
          "Unit 4",
          "Venture Point, Stanney Mill Road",
          "Little Stanney",
          "CHESTER",
          "",
          "CH2 4NE"
        ]
      },
      "RawAddress": {
        "Organisation": "DATA 8",
        "Department": "",
        "AddressKey": 36402248,
        "OrganisationKey": 3403817,
        "PostcodeType": "S",
        "BuildingNumber": 0,
        "SubBuildingName": "UNIT 4",
        "BuildingName": "VENTURE POINT",
        "DependentThoroughfareName": "",
        "DependentThoroughfareDesc": "",
        "ThoroughfareName": "STANNEY MILL",
        "ThoroughfareDesc": "ROAD",
        "DoubleDependentLocality": "",
        "DependentLocality": "LITTLE STANNEY",
        "Locality": "CHESTER",
        "Postcode": "CH2 4NE",
        "Dps": "1E",
        "PoBox": "",
        "PostalCounty": "",
        "TraditionalCounty": "CHESHIRE",
        "AdministrativeCounty": "CHESHIRE WEST AND CHESTER",
        "CountryISO2": null,
        "UniqueReference": "52418170",
        "Location": {
          "Easting": 341730,
          "Northing": 374581,
          "GridReference": "SJ417745",
          "Longitude": -2.8737181943573029,
          "Latitude": 53.2654176920885,
          "CountyCode": null,
          "County": null,
          "DistrictCode": null,
          "District": null,
          "WardCode": null,
          "Ward": null,
          "Country": null,
          "Constituency": null
        },
        "AdditionalData": null
      }
    }
  ]
}

Depending on your chosen authentication method you will need to modify this request slightly:

Public Sub GetFullAddress(licence As String, postcode As String, building As String)
  Dim rs As ADODB.Recordset
  Set rs = New ADODB.Recordset
  rs.Open "https://webservices.data-8.co.uk/recordset.ashx?service=AddressCapture&method=GetFullAddressSimple" &
    "&username=your-username" &
    "&password=your-password" &
    "&licence=" & licence &
    "&postcode=" & postcode &
    "&building=" & building
  If rs.MoveFirst Then
    If rs.Fields(0).Name = "Success" And rs.Fields(0).Value = false Then
      MsgBox "Error: " & rs.Fields(1)
    Else
      'TODO: Process method results here.
      'All the results are available in the first row in the recordset.
      'Results can be extracted from the following fields:
      'ResultCount
      '  Contains the number of addresses in the `Results` field. This field is only populated if the `ReturnResultCount` option is set to `True`
      'Each result is available in a different row in the recordset.
      'Results can be extracted from the following fields:
      'RawAddress_Organisation
      'RawAddress_Department
      'RawAddress_AddressKey
      'RawAddress_OrganisationKey
      'RawAddress_PostcodeType
      'RawAddress_BuildingNumber
      'RawAddress_SubBuildingName
      'RawAddress_BuildingName
      'RawAddress_DependentThoroughfareName
      'RawAddress_DependentThoroughfareDesc
      'RawAddress_ThoroughfareName
      'RawAddress_ThoroughfareDesc
      'RawAddress_DoubleDependentLocality
      'RawAddress_DependentLocality
      'RawAddress_Locality
      'RawAddress_Postcode
      'RawAddress_Dps
      'RawAddress_PoBox
      'RawAddress_PostalCounty
      'RawAddress_TraditionalCounty
      'RawAddress_AdministrativeCounty
      'RawAddress_CountryISO2
      'RawAddress_UniqueReference
      'RawAddress_Location_Easting
      'RawAddress_Location_Northing
      'RawAddress_Location_GridReference
      'RawAddress_Location_Longitude
      'RawAddress_Location_Latitude
      'RawAddress_Location_CountyCode
      'RawAddress_Location_County
      'RawAddress_Location_DistrictCode
      'RawAddress_Location_District
      'RawAddress_Location_WardCode
      'RawAddress_Location_Ward
      'RawAddress_Location_Country
      'RawAddress_Location_Constituency
    End If
  End If
End Sub

GetFullAddress

Description

Credit Usage

Parameters

Advanced Options

Results

Live Demo

Live Demo Results

Sample Code

Request Format

Results Format