IP Geolocation

{
  "success": true,
  "data": {
    "ip": {
      "address": "165.227.149.217",
      "version": 4,
      "numeric": 2783155673,
      "bogon": false
    },
    "geo": {
      "continent": "Europe",
      "continent_code": "EU",
      "continent_geo_name_id": 6255148,
      "country": "Germany",
      "country_code": "DE",
      "country_geo_name_id": 2921044,
      "region": "Hessen",
      "city": "Frankfurt am Main",
      "postal": "65931",
      "latitude": 50.11552,
      "longitude": 8.68417
    },
    "location": {
      "capital": "Berlin",
      "population": 83783942,
      "language": { "name": "German", "code": "de", "native": "Deutsch" },
      "flag": {
        "emoji": "🇩🇪",
        "unicode": "U+1F1E9 U+1F1EA",
        "png": {
          "1000px": "https://greip.io/img/flags/png1000px/de.png",
          "250px": "https://greip.io/img/flags/png250px/de.png",
          "100px": "https://greip.io/img/flags/png100px/de.png"
        },
        "svg": "https://greip.io/img/flags/svg/de.svg"
      },
      "phone": "49",
      "is_eu": true,
      "neighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT",
      "tld": ".de"
    },
    "currency": {
      "name": "Euro",
      "code": "EUR",
      "symbol": "€"
    },
    "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,
      "current_time": "03:33:13",
      "current_timestamp": 1709519593,
      "is_dst": false,
      "sun_info": {
        "sunset": "18:14:11",
        "sunrise": "06:59:29",
        "transit": "12:36:50",
        "civil_twilight_begin": "06:28:47",
        "civil_twilight_end": "18:44:53",
        "nautical_twilight_begin": "05:51:20",
        "nautical_twilight_end": "19:22:21",
        "astronomical_twilight_begin": "05:13:27",
        "astronomical_twilight_end": "20:00:13",
        "day_length": "11:14:42"
      }
    },
    "security": {
      "vpn_or_proxy": true,
      "vpn_or_proxy_type": "VPN",
      "tor": false,
      "bot": false,
      "relay": false,
      "relay_country": null,
      "relay_city": null,
      "hosting": true,
      "is_blacklisted": false
    },
    "device": {
      "mobile": { "detected": false },
      "type": "desktop",
      "os": {
        "type": "desktop",
        "name": "MacOS",
        "family": "macintosh",
        "version": "Big Sur",
        "title": "MacOS Big Sur",
        "bits64": "1"
      },
      "browser": {
        "name": "Safari",
        "version": "17.2",
        "version_major": "1",
        "title": "Safari 17.2",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Safari/605.1.15"
      },
      "fingerprint": null
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "execution_ms": 4
}

{
  "success": false,
  "code": 101,
  "type": "invalid_key",
  "description": "The API Key is missing or invalid."
}

IP geolocation for the current request

curl --request GET \
  --url https://v2.greipapi.com/geo/ip \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v2.greipapi.com/geo/ip', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v2.greipapi.com/geo/ip",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v2.greipapi.com/geo/ip"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v2.greipapi.com/geo/ip")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "ip": {
      "address": "165.227.149.217",
      "version": 4,
      "numeric": 2783155673,
      "bogon": false
    },
    "geo": {
      "continent": "Europe",
      "continent_code": "EU",
      "continent_geo_name_id": 6255148,
      "country": "Germany",
      "country_code": "DE",
      "country_geo_name_id": 2921044,
      "region": "Hessen",
      "city": "Frankfurt am Main",
      "postal": "65931",
      "latitude": 50.11552,
      "longitude": 8.68417
    },
    "location": {
      "capital": "Berlin",
      "population": 83783942,
      "language": { "name": "German", "code": "de", "native": "Deutsch" },
      "flag": {
        "emoji": "🇩🇪",
        "unicode": "U+1F1E9 U+1F1EA",
        "png": {
          "1000px": "https://greip.io/img/flags/png1000px/de.png",
          "250px": "https://greip.io/img/flags/png250px/de.png",
          "100px": "https://greip.io/img/flags/png100px/de.png"
        },
        "svg": "https://greip.io/img/flags/svg/de.svg"
      },
      "phone": "49",
      "is_eu": true,
      "neighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT",
      "tld": ".de"
    },
    "currency": {
      "name": "Euro",
      "code": "EUR",
      "symbol": "€"
    },
    "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,
      "current_time": "03:33:13",
      "current_timestamp": 1709519593,
      "is_dst": false,
      "sun_info": {
        "sunset": "18:14:11",
        "sunrise": "06:59:29",
        "transit": "12:36:50",
        "civil_twilight_begin": "06:28:47",
        "civil_twilight_end": "18:44:53",
        "nautical_twilight_begin": "05:51:20",
        "nautical_twilight_end": "19:22:21",
        "astronomical_twilight_begin": "05:13:27",
        "astronomical_twilight_end": "20:00:13",
        "day_length": "11:14:42"
      }
    },
    "security": {
      "vpn_or_proxy": true,
      "vpn_or_proxy_type": "VPN",
      "tor": false,
      "bot": false,
      "relay": false,
      "relay_country": null,
      "relay_city": null,
      "hosting": true,
      "is_blacklisted": false
    },
    "device": {
      "mobile": { "detected": false },
      "type": "desktop",
      "os": {
        "type": "desktop",
        "name": "MacOS",
        "family": "macintosh",
        "version": "Big Sur",
        "title": "MacOS Big Sur",
        "bits64": "1"
      },
      "browser": {
        "name": "Safari",
        "version": "17.2",
        "version_major": "1",
        "title": "Safari 17.2",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Safari/605.1.15"
      },
      "fingerprint": null
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "execution_ms": 4
}

{
  "success": false,
  "code": 101,
  "type": "invalid_key",
  "description": "The API Key is missing or invalid."
}

{
  "success": true,
  "data": {
    "ip": {
      "address": "165.227.149.217",
      "version": 4,
      "numeric": 2783155673,
      "bogon": false
    },
    "geo": {
      "continent": "Europe",
      "continent_code": "EU",
      "continent_geo_name_id": 6255148,
      "country": "Germany",
      "country_code": "DE",
      "country_geo_name_id": 2921044,
      "region": "Hessen",
      "city": "Frankfurt am Main",
      "postal": "65931",
      "latitude": 50.11552,
      "longitude": 8.68417
    },
    "location": {
      "capital": "Berlin",
      "population": 83783942,
      "language": { "name": "German", "code": "de", "native": "Deutsch" },
      "flag": {
        "emoji": "🇩🇪",
        "unicode": "U+1F1E9 U+1F1EA",
        "png": {
          "1000px": "https://greip.io/img/flags/png1000px/de.png",
          "250px": "https://greip.io/img/flags/png250px/de.png",
          "100px": "https://greip.io/img/flags/png100px/de.png"
        },
        "svg": "https://greip.io/img/flags/svg/de.svg"
      },
      "phone": "49",
      "is_eu": true,
      "neighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT",
      "tld": ".de"
    },
    "currency": {
      "name": "Euro",
      "code": "EUR",
      "symbol": "€"
    },
    "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,
      "current_time": "03:33:13",
      "current_timestamp": 1709519593,
      "is_dst": false,
      "sun_info": {
        "sunset": "18:14:11",
        "sunrise": "06:59:29",
        "transit": "12:36:50",
        "civil_twilight_begin": "06:28:47",
        "civil_twilight_end": "18:44:53",
        "nautical_twilight_begin": "05:51:20",
        "nautical_twilight_end": "19:22:21",
        "astronomical_twilight_begin": "05:13:27",
        "astronomical_twilight_end": "20:00:13",
        "day_length": "11:14:42"
      }
    },
    "security": {
      "vpn_or_proxy": true,
      "vpn_or_proxy_type": "VPN",
      "tor": false,
      "bot": false,
      "relay": false,
      "relay_country": null,
      "relay_city": null,
      "hosting": true,
      "is_blacklisted": false
    },
    "device": {
      "mobile": { "detected": false },
      "type": "desktop",
      "os": {
        "type": "desktop",
        "name": "MacOS",
        "family": "macintosh",
        "version": "Big Sur",
        "title": "MacOS Big Sur",
        "bits64": "1"
      },
      "browser": {
        "name": "Safari",
        "version": "17.2",
        "version_major": "1",
        "title": "Safari 17.2",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Safari/605.1.15"
      },
      "fingerprint": null
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "execution_ms": 4
}

{
  "success": false,
  "code": 101,
  "type": "invalid_key",
  "description": "The API Key is missing or invalid."
}

GET

geo

IP geolocation for the current request

curl --request GET \
  --url https://v2.greipapi.com/geo/ip \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v2.greipapi.com/geo/ip', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v2.greipapi.com/geo/ip",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v2.greipapi.com/geo/ip"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v2.greipapi.com/geo/ip")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "ip": {
      "address": "165.227.149.217",
      "version": 4,
      "numeric": 2783155673,
      "bogon": false
    },
    "geo": {
      "continent": "Europe",
      "continent_code": "EU",
      "continent_geo_name_id": 6255148,
      "country": "Germany",
      "country_code": "DE",
      "country_geo_name_id": 2921044,
      "region": "Hessen",
      "city": "Frankfurt am Main",
      "postal": "65931",
      "latitude": 50.11552,
      "longitude": 8.68417
    },
    "location": {
      "capital": "Berlin",
      "population": 83783942,
      "language": { "name": "German", "code": "de", "native": "Deutsch" },
      "flag": {
        "emoji": "🇩🇪",
        "unicode": "U+1F1E9 U+1F1EA",
        "png": {
          "1000px": "https://greip.io/img/flags/png1000px/de.png",
          "250px": "https://greip.io/img/flags/png250px/de.png",
          "100px": "https://greip.io/img/flags/png100px/de.png"
        },
        "svg": "https://greip.io/img/flags/svg/de.svg"
      },
      "phone": "49",
      "is_eu": true,
      "neighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT",
      "tld": ".de"
    },
    "currency": {
      "name": "Euro",
      "code": "EUR",
      "symbol": "€"
    },
    "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,
      "current_time": "03:33:13",
      "current_timestamp": 1709519593,
      "is_dst": false,
      "sun_info": {
        "sunset": "18:14:11",
        "sunrise": "06:59:29",
        "transit": "12:36:50",
        "civil_twilight_begin": "06:28:47",
        "civil_twilight_end": "18:44:53",
        "nautical_twilight_begin": "05:51:20",
        "nautical_twilight_end": "19:22:21",
        "astronomical_twilight_begin": "05:13:27",
        "astronomical_twilight_end": "20:00:13",
        "day_length": "11:14:42"
      }
    },
    "security": {
      "vpn_or_proxy": true,
      "vpn_or_proxy_type": "VPN",
      "tor": false,
      "bot": false,
      "relay": false,
      "relay_country": null,
      "relay_city": null,
      "hosting": true,
      "is_blacklisted": false
    },
    "device": {
      "mobile": { "detected": false },
      "type": "desktop",
      "os": {
        "type": "desktop",
        "name": "MacOS",
        "family": "macintosh",
        "version": "Big Sur",
        "title": "MacOS Big Sur",
        "bits64": "1"
      },
      "browser": {
        "name": "Safari",
        "version": "17.2",
        "version_major": "1",
        "title": "Safari 17.2",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Safari/605.1.15"
      },
      "fingerprint": null
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "execution_ms": 4
}

{
  "success": false,
  "code": 101,
  "type": "invalid_key",
  "description": "The API Key is missing or invalid."
}

Authentication

Include your API key in the Authorization header:

Authorization: Bearer <api_key>

API v2 accepts the key only in this header, not in query parameters or request bodies. See Authentication. GET /geo/ip resolves the IP address of the current request and returns the same rich data object as IP Lookup (geo, optional modules, and related fields). To look up a different address, use the IP in the path on GET /lookup/ip/{ip}, not a query parameter.

Query parameters

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 deviceSample value: security,timezone,currencyFor more information please refer to Customize response modules.

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 RUFor more information please refer to Localization.

string

The callback command can help you make the response 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.

string

default:"JSON"

The format command is used to get a response in a specific format.Expected values: JSON, XML, CSV, or NewlineFor more information please refer to Response format.

string

default:"live"

The mode command is used 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.

string

Optional label for your own analytics or support correlation (for example a product or channel name).

string

The user_id 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.

Response properties

boolean

required

true when the request succeeded; false on error.

object

required

Hide properties

object

required

Hide properties

string

required

IP address you’re looking up.

integer

required

Type of IP address (IPv4, or IPv6), expressed as 4 or 6.

integer

required

Numeric representation of the IP address.

boolean

required

Indicates if the IP address is a bogon.

object

required

Hide properties

string

required

Name of the continent where the IP address is.

string

required

Code representation of the continent.

string

required

Code representation of the country in ISO-3166 format.

integer

required

GeoName ID of the continent.

string

required

Name of the country.

integer

required

GeoName ID of the country.

string

required

Name of the region.

string

required

Name of the city.

string

required

ZIP code of the location where the IP address belong.

number

required

Latitude coordinate of the location.

number

required

Longitude coordinate of the location.

object

required

Show details

string

required

Capital city of the country.

integer

required

Population of the country.

object

required

Show details

string

required

Official language of the country.

string

required

Language code in ISO-639 format.

string

required

Native name of the language.

object

required

Show details

string

required

Flag emoji representation.

string

required

Flag Unicode representation.

object

required

Show images

string

required

URL to 1000px PNG flag.

string

required

URL to 250px PNG flag.

string

required

URL to 100px PNG flag.

string

required

URL to SVG flag.

string

required

International dialing code for the country.

boolean

required

Indicates if the country is in the EU.

string

required

List of neighboring countries’ codes.

string

required

Top-level domain of the country.

object

required

Show details

string

required

Name of the currency.

string

required

Currency code in ISO-4217 format.

string

required

Symbol of the currency.

object

required

Show details

string

required

Autonomous System Number (for example AS15169).

string

required

Name of the ASN.

string

required

Organization associated with the ASN.

string

required

Phone contact for the ASN.

string

required

Email contact for the ASN.

string

required

Domain associated with the ASN.

string

required

Date of ASN creation.

string

required

Type of organization (“isp”, “hosting”, “business”, “education”, or “government”).

object

required

Show details

string

required

Timezone name.

string

required

Timezone abbreviation.

integer

required

Timezone offset from UTC.

string

required

Current time in the timezone.

integer

required

Current timestamp in the timezone.

boolean

required

Indicates if Daylight Saving Time is active.

object

required

Show details

string

required

Sunset time.

string

required

Sunrise time.

string

required

Solar transit time.

string

required

Civil twilight begin time.

string

required

Civil twilight end time.

string

required

Nautical twilight begin time.

string

required

Nautical twilight end time.

string

required

Astronomical twilight begin time.

string

required

Astronomical twilight end time.

string

required

Length of the day.

object

required

Show details

boolean

required

Indicates if the IP address is a proxy service.

string

required

Type of proxy used.

boolean

required

Indicates if accessed through Tor network.

boolean

required

Indicates if the user is a bot.

boolean

required

Indicates if it’s a Apple’s Private Relay connection.

string

Country code for Apple Private Relay when detected; otherwise null.

string

City for Apple Private Relay when detected; otherwise null.

boolean

required

Indicates if the IP address belong to a hosting provider.

boolean

required

Indicates if the IP address is blacklisted due to applying custom rules or were found in one of your blacklists.

object

required

Show details

object

required

Mobile detection from the user agent.

Hide properties

boolean

required

true when the user agent looks like a mobile device.

string

required

Type of device.

object

required

Show details

string

required

Type of operating system.

string

required

Name of the operating system.

string

required

Family of the operating system.

string

required

Version of the operating system.

string

required

Title of the operating system.

string

required

64-bit mode hint from the parser (often Unknown when not detected).

object

required

Show details

string

required

Name of the browser.

number

required

Version of the browser.

integer

required

Major version of the browser.

string

required

Title of the browser.

string

required

The user-agent of the browser.

string

Device fingerprint hash when available; null on IP lookup routes that omit device capture.

object

The custom rules applied to this request, learn more.

Hide properties

integer

required

The total number of custom rules applied to this request.

object

required

The custom rules applied to this request, learn more.

Hide properties

string

required

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

string

required

The rule title you set when creating the rule.

integer

required

Time taken to process the request (milliseconds).

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

params

string

lang

string

callback

string

format

string

default:JSON

mode

string

default:live

source

string

user_id

string

Response

200

Data Lookup

Risk Scoring

Account Management

Authentication

Query parameters

Response properties

Authorizations

Query Parameters

Response

​Authentication

​Query parameters

​Response properties

Authorizations

Query Parameters

Response

Authentication

Query parameters

Response properties