> ## Documentation Index
> Fetch the complete documentation index at: https://docs.greip.io/llms.txt
> Use this file to discover all available pages before exploring further.
# IP Geolocation
> This API allows you to retrieve detailed geolocation information for a visitor’s or user’s IP address.
By using the IP Geolocation method, you can access data such as the user’s country, city, ISP, and more, enabling you to personalize user experiences, enhance security, and make data-driven decisions based on geographic insights.
export const MCPCallout = () => {
return
;
};
### Query Parameters
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](/options/customize-modules).
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](/options/response-format).
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](/options/localization).
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](/options/development-environment).
The userID command can be used to identify requests sent by specific users to monitor in the [Events Page](/dashboard-guides/monitoring-capabilities/real-time-threat-monitoring).
Expected values: email address, phone number, user id, name, etc.
For more information please refer to [User Identifier](/options/user-identifier).
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](/options/jsonp-callback).
```json Success theme={null}
{
"data": {
"ip": "165.227.149.217",
"ipType": "IPv4",
"IPNumber": 2783155673,
"bogon": false,
"continentName": "Europe",
"continentCode": "EU",
"countryCode": "DE",
"continentGeoNameID": 6255148,
"countryName": "Germany",
"countryGeoNameID": 2921044,
"regionName": "Hessen",
"cityName": "Frankfurt am Main",
"zipCode": "65931",
"latitude": "50.115520",
"longitude": "8.684170",
"location": {
"capital": "Berlin",
"population": 83783942,
"language": { "name": "German", "code": "de", "native": "Deutsch" },
"flag": {
"emoji": "🇩🇪",
"unicode": "U+1F1E9 U+1F1EA",
"png": {
"1000px": "https://www.gredev.io/img/flags/png1000px/de.png",
"250px": "https://www.gredev.io/img/flags/png250px/de.png",
"100px": "https://www.gredev.io/img/flags/png100px/de.png"
},
"svg": "https://www.gredev.io/img/flags/svg/de.svg"
},
"phoneCode": "49",
"countryIsEU": true,
"countryNeighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT",
"tld": ".de"
},
"currency": {
"currencyName": "Euro",
"currencyCode": "EUR",
"currencySymbol": "€"
},
"asn": {
"asn": "AS14061",
"name": "DIGITALOCEAN-ASN",
"org": "DigitalOcean, LLC",
"phone": "+1-347-875-6044",
"email": "noc@digitalocean.com",
"domain": "digitalocean.com",
"created": "2012-05-14",
"type": "hosting"
},
"timezone": {
"name": "Europe/Berlin",
"abbreviation": "CET",
"offset": 3600,
"currentTime": "03:33:13",
"currentTimestamp": 1709519593,
"isDST": false,
"sunInfo": {
"sunset": "18:14:11",
"sunrise": "06:59:29",
"transit": "12:36:50",
"civilTwilightBegin": "06:28:47",
"civilTwilightEnd": "18:44:53",
"nauticalTwilightBegin": "05:51:20",
"nauticalTwilightEnd": "19:22:21",
"astronomicalTwilightBegin": "05:13:27",
"astronomicalTwilightEnd": "20:00:13",
"dayLength": "11:14:42"
}
},
"security": {
"isProxy": true,
"proxyType": "VPN",
"isTor": false,
"isBot": false,
"isRelay": false,
"isHosting": true,
"blacklisted": false
},
"device": {
"isMobile": false,
"type": "desktop",
"OS": {
"type": "desktop",
"name": "MacOS",
"family": "macintosh",
"version": "Big Sur",
"title": "MacOS Big Sur",
"64bits_mode": 1
},
"browser": {
"name": "Safari",
"version": 17.2,
"versionMajor": 1,
"title": "Safari 17.2"
}
},
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 4
}
```
```json Error theme={null}
{
"status": "error",
"code": 101,
"type": "invalid_key",
"description": "The API Key is missing or invalid."
}
```
### Response properties
IP address you're looking up.
Type of IP address (`IPv4`, or `IPv6`).
Numeric representation of the IP address.
Indicates if the IP address is a bogon.
Name of the continent where the IP address is.
Code representation of the continent.
Code representation of the country in `ISO-3166` format.
GeoName ID of the continent.
Name of the country.
GeoName ID of the country.
Name of the region.
Name of the city.
ZIP code of the location where the IP address belong.
Latitude coordinate of the location.
Longitude coordinate of the location.
Capital city of the country.
Population of the country.
Official language of the country.
Language code in `ISO-639` format.
Native name of the language.
Flag emoji representation.
Flag Unicode representation.
URL to 1000px PNG flag.
URL to 250px PNG flag.
URL to 100px PNG flag.
URL to SVG flag.
International dialing code for the country.
Indicates if the country is in the EU.
List of neighboring countries' codes.
Top-level domain of the country.
Name of the currency.
Currency code in `ISO-4217` format.
Symbol of the currency.
Autonomous System Number.
Name of the ASN.
Organization associated with the ASN.
Phone contact for the ASN.
Email contact for the ASN.
Domain associated with the ASN.
Date of ASN creation.
Type of organization ("isp", "hosting", "business", "education", or
"government").
Timezone name.
Timezone abbreviation.
Timezone offset from UTC.
Current time in the timezone.
Current timestamp in the timezone.
Indicates if Daylight Saving Time is active.
Sunset time.
Sunrise time.
Solar transit time.
Civil twilight begin time.
Civil twilight end time.
Nautical twilight begin time.
Nautical twilight end time.
Astronomical twilight begin time.
Astronomical twilight end time.
Length of the day.
Indicates if the IP address is a proxy service.
Type of proxy used.
Indicates if accessed through Tor network.
Indicates if the user is a bot.
Indicates if it's a Apple's Private Relay connection.
Indicates if the IP address belong to a hosting provider.
Indicates if the IP address is blacklisted due to applying [custom
rules](/knowledge-base/custom-rules/overview) or were found in one of
your blacklists.
Indicates if the device is a mobile device.
Type of device.
Type of operating system.
Name of the operating system.
Family of the operating system.
Version of the operating system.
Title of the operating system.
Indicates 64-bit mode (1 for true, 0 for false).
Name of the browser.
Version of the browser.
Major version of the browser.
Title of the browser.
The user-agent of the browser.
The custom rules applied to this request, [learn
more](/knowledge-base/custom-rules/overview).
The total number of custom rules applied to this request.
The custom rules applied to this request, [learn
more](/knowledge-base/custom-rules/overview).
The rule ID as shown in the dashboard (e.g: `CR104`).
The rule title you set when creating the rule.
Response status (success/error).
Time taken to process the data (in milliseconds).