IPAddressToCountrySimple - CountryDetection • Data8 Web Services API Documentation

IPAddressToCountrySimple

Identifies a country from a customer's IP address.

Description

Identifies a country from a customer's IP address. Both IPv4 and IPv6 addresses are supported.

The details of the detected country are provided in the returned values. If no country could be identified, the country name and ISO code are both set to "Unknown".

If the ipAddress parameter is left blank, the IP address that the request is being made from will be used. This is particularly useful when integrating the service into a web page via JavaScript, at which point the public IP address is not known to the calling code but will be determined automatically by our service.

Endpoint URLs

This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/CountryDetection/IPAddressToCountrySimple.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/CountryDetection/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/countrydetection.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.
ipAddress	ipAddress The IP address to detect the country for. Leave blank to use the IP address of the client.
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.

Results

This method returns an object containing the following fields:

Name	Description
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.
CountryName	CountryName Contains the ISO standard name of the detected country
CountryISO	CountryISO Contains the 2-character ISO code of the detected country
IDC	IDC Contains the international telephone dialling code of the detected country
CCTLD	CCTLD Contains the country-code top level domain name of the detected country

Credit Usage

Each request to this method consumes 1 CountryDetection credit.

Sample Code

Request Format

{
  "ipAddress": ""
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "CountryName": "United Kingdom",
  "CountryISO": "GB",
  "IDC": "44",
  "CCTLD": ".uk"
}

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/CountryDetection/IPAddressToCountrySimple.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
ipAddress	ipAddress
Credits Remaining Today: 5 Try It Now!