GET
/
geoip
curl --request GET \
  --url https://greipapi.com/geoip \
  --header 'Authorization: Bearer <token>'
{
  "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
}

​
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.

​
bogon
boolean
required

Indicates if the IP address is a bogon.

​
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
​
custom_rules_applied
object

The custom rules applied to this request, learn more.

​
total
integer
required

The total number of custom rules applied to this request.

​
rules
object
required

The custom rules applied to this request, learn more.

​
id
string
required

The rule ID as shown in the dashboard (e.g: CR104).

​
title
string
required

The rule title you set when creating the rule.

​
status
string
required

Response status (success/error).

​
executionTime
integer
required

Time taken to process the data (in milliseconds).

Was this page helpful?