GET
/
geoip

​
Query Parameters

params
string

The params command can be used to specify the required modules you want to get in the response.

Expected values: security, currency, timezone, location, and/or device

Sample value: security,timezone,currency

For more information please refer to Customize response modules.

format
string
default: "JSON"

The format command is used to get a response in a specific format.

Expected values: JSON, XML, CSV, or Newline

For more information please refer to Response Format.

lang
string
default: "EN"

The lang command is used to get a response in a specific language.

Expected values: EN, AR, DE, FR, ES, JA, ZH, or RU

For more information please refer to Localization.

mode
string
default: "live"

The mode command is used to in the development stage to simulate the integration process before releasing it to the production environment.

Expected values: live, or test.

For more information please refer to Development Environment.

userID
string

The userID command can be used to identify requests sent by specific users to monitor in the Events Page.

Expected values: email address, phone number, user id, name, etc.

For more information please refer to User Identifier.

callback
string

The callback command can help you make the response as a JSONP format.

Expected values: any name that can be used as a function name in Javascript, e.g: myFunctionName.

For more information please refer to JSONP Callback.

​
Response properties

data
object
required
ip
string
required

IP address you’re looking up.

ipType
string
required

Type of IP address (IPv4, or IPv6).

IPNumber
integer
required

Numeric representation of the IP address.

continentName
string
required

Name of the continent where the IP address is.

continentCode
string
required

Code representation of the continent.

countryCode
string
required

Code representation of the country in ISO-3166 format.

continentGeoNameID
integer
required

GeoName ID of the continent.

countryName
string
required

Name of the country.

countryGeoNameID
integer
required

GeoName ID of the country.

regionName
string
required

Name of the region.

cityName
string
required

Name of the city.

zipCode
string
required

ZIP code of the location where the IP address belong.

latitude
string
required

Latitude coordinate of the location.

longitude
string
required

Longitude coordinate of the location.

location
object
required
currency
object
required
asn
object
required
timezone
object
required
security
object
required
device
object
required
status
string
required

Response status (success/error).

executionTime
integer
required

Time taken to process the data (in milliseconds).

Was this page helpful?

IP Lookup