Geocode - Geocoding • Data8 Web Services API Documentation

Geocode

Returns the physical coordinates for a free-text address element.

Description

Finds the location of a free-text address. The location is returned as an array of FuzzyPosition objects, each representing the location of one possible alternative location.

If you have a full postcode for the address, you can retrieve the location more easily using the FindLocation method.

Information on administrative areas can also be retrieved in addition to the physical coordinates.

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/Geocode.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
name	name The town name or other address element to get the location of
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
GetAdminArea	GetAdminArea Indicates that the results should include the `CountyCode`, `County`, `DistrictCode`, `District`, `WardCode` and `Ward` properties
GetConstituency	GetConstituency Indicates that the output should include the `Constituency` property
GetCountry	GetCountry Indicates that the results should contain the `Country` property
DatumEPSG	DatumEPSG The EPSG code of the datum to use when converting the original OS grid coordinates to latitude and longitude

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.

Result

An array of possible matches to the supplied name. Each match has the following fields:

Name	Description
`Easting`	The distance of the centre point of the location east of the OS grid origin to the southwest of Scilly
`Northing`	The distance of the centre point of the location north of the OS grid origin
`GridReference`	The location of the centre point of the location as a 6-digit OS grid reference
`Longitude`	The longitude of the centre point of the location expressed in decimal degrees in the WGS84 datum
`Latitude`	The latitude of the centre point of the location expressed in decimal degrees in the WGS84 datum
`CountyCode`	The reference code for the county the centre point of the location is in
`County`	The name of the administrative county the centre point of the location is in
`DistrictCode`	The reference code for the district the centre point of the location is in
`District`	The name of the administrative district the centre point of the location is in
`WardCode`	The reference code for the ward the centre point of the location is in
`Ward`	The name of the electoral ward the centre point of the location is in
`Country`	The name of the country the centre point of the location is in
`Description`	The name of the location that has been matched to
`StdDev`	The standard deviation of the distance of addresses in this area to the centre point location that has been returned, in metres. This gives an indication of the size of the area

Credit Usage

Each request to this method consumes 1 Location credit.

Sample Code

Request Format

{
  "licence": "InternalUser",
  "name": "Chester",
  "options": {
    "GetAdminArea": true,
    "GetConstituency": true,
    "GetCountry": true,
    "DatumEPSG": 4326
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Results": 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/Geocode.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
name	name
Common Options
ApplicationName	ApplicationName
Service-Specific Options
GetAdminArea	GetAdminArea
GetConstituency	GetConstituency
GetCountry	GetCountry
DatumEPSG	DatumEPSG
Credits Remaining Today: 10 Try It Now!