0151 355 4555



Finds details of an address within a locality. The locality to search within is identified by the localityKey parameter, which should be a locality key returned from the LocalitiesByName or LocalitiesByPostcode methods.

The building to find the address for is specified by the building parameter. This should be set to the name of the building or organisation you wish to find.

Note that this should not be a building number; to find addresses using a building number you should first identify the street the building is on using the StreetsByLocalityKey or StreetsByName methods, then use the AddressesByStreetKey method to find the building address.

View all Address validation methods

Code Samples

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

<script type="text/javascript">

function loadIntegr8() {
  // Load the AddressCapture Integr8 service

function AddressesByLocalityKey(licence, localityKey, 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="localityKey">string</param>
  /// <param name="building">string</param>
  var addresscapture = new data8.addresscapture();

function showAddressesByLocalityKeyResult(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.Results
    //   Contains an array of addresses or partial address details that match the query.
    //   A human-readable description of each item in the array is available in the Description field,
    //   and an identifier to be passed to other methods is available in the ID field.