Skip to the content

Search

Search for a partial address in our many data sources

Live Demo

To connect to this service you'll need to use one of these endpoints:

WSDL
https://webservices.data-8.co.uk/PredictiveAddress.asmx
JSON
https://webservices.data-8.co.uk/PredictiveAddress/Search.json

Description

Begin an address search by passing the entered partial address to our service. The response will contain any matches found for the information within our many data sources.

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.
country

country

The ISO-2 country code in which the address belongs.

search

search

The partial address entered by the user.

telephoneNumber

telephoneNumber

An optional parameter, the telephone number associated with the address can be supplied.

session

session

The session id that was received in the previous response. This improves efficiency and lookup speeds. This should be included in any subsequent calls to the Search endpoint.

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.

IncludeMR

IncludeMR

Includes addresses from the Multiple Residency database in the results (requires additional licensing).

IncludeNYB

IncludeNYB

Includes addresses from the Not Yet Built database in the results (requires additional licensing).

PreferredLanguage

PreferredLanguage

Set this to cy to retrieve addresses in Welsh where available, or en to prefer English. Addresses are returned in English when this option is not specified.

Results

This method returns an object containing the following fields:

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
Results

Results

A list of possible matches. Each one has the following properties:

  • label - the value to show to the user.
  • value - a unique identifier for the match that can be supplied to the DrillDown or Retrieve endpoints.
  • container - indicates if this match is a container for other addresses (e.g. a town, street etc.). If this is true, the value should be supplied to the DrillDown endpoint to get the details of the addresses in the container record. If it is false, the value should be supplied to the Retrieve endpoint to get the full details of the address.
Count

Count

The number of matches found based on the information provided.

SessionID

SessionID

A SessionID is also included in the response. This should be included in any subsequent calls to the Search endpoint.

Live Demo

country
search
telephoneNumber
session
options
Name Value
Credits Remaining Today: 5

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today