Authentication

After signing up and validating your email, you will be able to find your API Key in your dashboard.

To make a request, you will need to append an api_key query parameter to every request.

GET: https://api.getgeoapi.com/v2/ip/check?api_key={YOUR_API_KEY}

Formats

We currently support JSON and XML formats. To specify the format you need to attach the format parameter to the request as shown in the example below

GET: https://api.getgeoapi.com/v2/ip/check
?api_key={YOUR_API_KEY}
&format={FORMAT}

The format parameter can have the following options:

• json
• xml

Endpoints

Please remember to add your api_key to every request.

GET: https://api.getgeoapi.com/v2/ip/check

GET: https://api.getgeoapi.com/v2/ip/{ip}

IPv4 / IPv6 Lookup

IP Lookup returns geo location data of any provided IPv4 or IPv6 address.

Endpoint:

GET: https://api.getgeoapi.com/v2/ip/{IP}

Example request:

GET: https://api.getgeoapi.com/v2/ip/37.140.128.10
?api_key={YOUR_API_KEY}
&format=json&filter=city&language=en

Request parameters:

Go to the section IP Lookup Response to see the example of the response.

Requester IP Lookup

Requester IP Lookup returns geo data of the IP address which is calling the API.

Endpoint:

GET: https://api.getgeoapi.com/v2/ip/check

Example request:

GET: https://api.getgeoapi.com/v2/ip/check
?api_key={YOUR_API_KEY}
&format=json

Request parameters:

IP Lookup Response

The example of the response for the IP 37.140.128.10

{
    "status": "success",
    "ip":"37.140.128.10",
    "type":"IPv4",
    "city":{
        "geonameid":524901,
        "name":"Moscow",
        "population":10381222
    },
    "area":{
        "code":"RU-MOW",
        "geonameid":524894,
        "name":"Moscow"
    },
    "country":{
        "code":"RU",
        "name":"Russia",
        "phone_code":"7",
        "area_size":"17100000.00 sq. km",
        "capital":"Moscow",
        "population":140702000,
        "geonameid":2017370,
        "is_in_eu":false,
        "flag":{
          "emoji":"🇷🇺",
          "file":"http://commons.wikimedia.org/wiki/Special:FilePath/Flag_of_Russia.svg",
          "unicode":"U+1F1F7 U+1F1FA"
        }
        "languages": {
          "ru": "Russian",
    },
    "time":{
        "timezone":"Europe/Moscow",
        "code":"MSK",
        "gmt_offset": 10800,
        "is_daylight_saving":false
    },
    "asn":{
        "organisation":"YANDEX LLC",
        "number":13238
    },
    "currency":{
        "code":"RUB",
        "name":"Russian Ruble"
    },
    "location":{
        "latitude":55.7522,
        "longitude":37.6156
    },
    "security":{
        "is_tor":false,
        "is_proxy":false,
        "is_threat":false,
        "is_crawler":false
    },
    "continent":{
        "geonameid":6255148,
        "code":"EU",
        "name":"Europe"
    },
    "postcode":"102087"
}

<?xml version="1.0" encoding="utf-8"?>
<root>
    <status>success</status>
    <ip>37.140.128.10</ip>
    <type>IPv4</type>
    <city>
        <geonameid>524901</geonameid>
        <name>Moscow</name>
        <population>10381222</population>
    </city>
    <area>
        <geonameid>524894</geonameid>
        <code>RU-MOW</code>
        <name>Moscow</name>
    </area>
    <country>
        <geonameid>2017370</geonameid>
        <code>RU</code>
        <name>Russia</name>
        <phone_code>7</phone_code>
        <area_size>17100000.00 sq. km</area_size>
        <capital>Moscow</capital>
        <population>140702000</population>
        <is_in_eu>False</is_in_eu>
        <flag>
            <emoji>🇷🇺</emoji>
            <file>http://commons.wikimedia.org/wiki/Special:FilePath/Flag_of_Russia.svg</file>
            <unicode>U+1F1F7 U+1F1FA</unicode>
        </flag>
        <languages>
            <ru>Russian</ru>
        </languages>
    </country>
    <time>
        <timezone>Europe/Moscow</timezone>
        <code>MSK</code>
        <gmt_offset>10800</gmt_offset>
        <is_daylight_saving>false</is_daylight_saving>
    </time>
    <asn>
        <organisation>YANDEX LLC</organisation>
        <number>13238</number>
    </asn>
    <currency>
        <code>RUB</code>
        <name>Russian Ruble</name>
    </currency>
    <location>
        <latitude>55.7522</latitude>
        <longitude>37.6156</longitude>
    </location>
    <security>
        <is_tor>False</is_tor>
        <is_proxy>False</is_proxy>
        <is_threat>False</is_threat>
        <is_crawler>False</is_crawler>
    </security>
    <continent>
        <geonameid>6255148</geonameid>
        <code>EU</code>
        <name>Europe</name>
    </continent>
    <postcode>102087</postcode>
</root>

Response object:

Errors

In case the request fails or the resource is not available an error will be returned in JSON or XML format.

Error response example:

{
    "status":"failed",
    "error":{
        "message":"Invalid key.",
        "code":"403"
    }
}

<?xml version="1.0" encoding="utf-8"?>
<root>
    <status>failed</status>
    <error>
        <message>Invalid key.</message>
        <code>403</code>
    </error>
</root>

Error codes:

Code Examples

PHP example:

<?php

$key = "{YOUR_API_KEY}";

$url = "https://api.getgeoapi.com/v2/ip/check?api_key=".$key."&format=json";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($curl);
curl_close($curl);

$json = json_decode($response, true);

print_r($json);

?>

Python example:

import requests

key = "{YOUR_API_KEY}"

parameters = {"api_key": key, "format": "json"}

url = "https://api.getgeoapi.com/v2/ip/check

response = requests.get(url, parameters)

print(response.json())

JavaScript ES6 example:

const key = "{YOUR_API_KEY}";

const url =  `https://api.getgeoapi.com/v2/ip/check?api_key=${key}&format=json`

fetch(url)
  .then(response => response.json())
  .then(data => console.log(data));

JavaScript/jQuery example:

var key = "{YOUR_API_KEY}";

var url =  "https://api.getgeoapi.com/v2/ip/check?api_key=" + key + "&format=json"

$.getJSON(url, function (data) {
    console.log(data);
});

Curl example:

curl --request GET \
--url 'https://api.getgeoapi.com/v2/ip/check?api_key={YOUR_API_KEY}'