GeoIP Method

Search…
GeoIP Method
Overview
This method is used to retrieve the visitor information (like: IP Address and/or location data).
Options
Option
Type
Description
params
Array
Specifies the modules you want to retrieve as visitor information.
It's an Array of consist some Strings as it's items.

Accepts: location, security, timezone, currency and/or device.

Default: []
format
String
You can use this option to specify the API output format.

Accepts: JSON, XML, CSV or Newline.

Default: JSON
lang
String
Specifies the API output language.

Accepts: EN, AR, DE, FR, ES, JA, JA, ZH or RU.

Default: EN
mode
String
You can use this option for using the Development Environment of the API, read more.

Accepts: live or test.

Default: live
Usage:
Basic example of using this method:
GeoIP.geoip({})
.then(res => {
    console.log(res);
})
.catch(error => {
    console.log(error);
});
Description:
This method accepts one parameter of type Object. The object contains the options you want to specify for this method. Let's dive into this:
Let's say that we want to retrieve the visitor information and also the timezone and device information. So the code will be like this:
GeoIP.geoip({
    'params': ['timezone', 'device']    // <--- This key/value added to the options
})
.then(res => {
    console.log(res);
})
.catch(error => {
    console.log(error);
});
Beside this, we can inform the module to return the response as XML:
GeoIP.geoip({
    'params': ['timezone', 'device'],
    'format': 'XML'    // <--- This key/value added to the options
})
.then(res => {
    console.log(res);
})
.catch(error => {
    console.log(error);
});
And so on...
The .then() will return the response if it's successfully fetched and the .catch() will return the error if something goes wrong.
If the request completed successfully, so the res variable of .then() returns the data in the format you specified. And we can read the data like this:
GeoIP.geoip({
    'params': ['timezone', 'device']
})
.then(res => {
    console.log(res?.data?.ip);    // <--- This will `log` the visitor IP
})
.catch(error => {
    console.log(error);
});
Tools & Libraries - Previous
Lookup Method
Last modified 7mo ago
Copy link
On this page
Overview
Options
Usage: