FindMyNearest - Geocoding • Data8 Web Services API Documentation

FindMyNearest

Returns a list of results sorted by shortest distance from the given point.

Description

Finds the distance any given point is, in metres or miles, from the locations in a specified dataset. The use of this service requires additional setup of a dataset containing relevant locations you wish to be compared.

For the best results, a full postcode should be supplied. However, the service will also accept partial postcodes or other parts of an address.

Endpoint URLs

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

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/Location/FindMyNearest.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/Location/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/location.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
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 The licence type under which you are accessing the service. If you are not sure which value to pick, please contact your account manager
point	point The point to use as the origin of the find my nearest search. This can be either a full postcode or a partial address. Using a full postcode will ensure the most accurate results are achieved.
dataset	dataset The name of the predefined dataset of locations to find the nearest one from.
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.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
Service Specific Options
DatumEPSG	DatumEPSG The EPSG code of the datum to use when converting the original OS grid coordinates to latitude and longitude
MaxMatches	MaxMatches The number of addresses to limit the response to.

Results

This method returns an object containing the following fields:

Name Description

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.

Distances

The cleansed address of the initial point stored in the Position attribute, and a list of distances for matched addresses, sorted by closest first, stored in the Distances attribute. Each matched address is made up of a PointOfInterest (containing a name, full address, contact details etc), and the distance in metres and miles from the origin point.

Each Distance contains the following fields:

Name	Description
`Miles`	The distance in miles from the original point.
`Metres`	The distance in metres from the original point.
`PointOfInterest`	Information about the matched point including a name, full address and contact details.

Credit Usage

Each request to this method consumes 1 Location credit and 1 Find My Nearest credit.

Sample Code

Request Format

{
  "licence": "WebClick",
  "point": "CH2 4NE",
  "dataset": "Demo",
  "options": {
    "DatumEPSG": 4326,
    "MaxMatches": 5
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Distances": null
}

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

API Key

Post the request to
https://webservices.data-8.co.uk/Location/FindMyNearest.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
licence	licence WebServerWebClickInternalUserSmallUserLookupInternalServer
point	point
dataset	dataset
Common Options
ApplicationName	ApplicationName
Service-Specific Options
DatumEPSG	DatumEPSG
MaxMatches	MaxMatches
Credits Remaining Today: 10 Try It Now!