IPAddressToCountrySimple
Identifies a country from a customer's IP address
To connect to this service you'll need to use one of these endpoints:
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.
Parameters
The following parameters can be supplied to this method
| username |
username apikey-, e.g.
apikey-ABCD-1234-EFGH-5678
|
|---|---|
| password |
password |
| ipAddress | ipAddress The IP address to detect the country for. Leave blank to use the IP address of the client. |
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.
| Common Options | |
|---|---|
| Name | Description |
| 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:
| Status |
Status 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 |