Get the geo location data of the IP address.

v1.0.0

What

Get the geo location data of the IP address passed as argument. This information includes:

Latitude and longitude
Time zone
Accuracy radius
Postal code
City name
Region
Country
Country of the service provider
Continent
Reverse PTR hostnames

Parameters

The only argument accepted in the query string is a public IPv4 or IPv6 addresses.

Result

The result contains the following set of data:

The result is a JSON object with the following structure:

self: the URI of the API call
accuracy_radius: The radius in kilometers around the specified location where the IP address is likely to be.
asn_country_iso_code: The ISO code of the country of the Autonomous System (AS) owner of the IP address.
city_geoname_code:``: City geoname code. The geoname code by is a unique identifier assigned to each geographical point on the globe.
city_name:``: City name, in english. The developer can use the geoname code to localize the name of the city.
continent_code: The continent code. It can be any of the following: AF, AN, AS, EU, NA, OC, SA.
country_iso_code: The country ISO 3166-1 alpha-2 code.
hostnames: The list of hostnames associated with the IP address obtained from the reverse DNS lookup.
latitude: The latitude of the geolocation.
longitude: The longitude of the geolocation.
postal_code:``: The postal code of the city.
region_geoname_code:``: The geoname code of the region.
region_name:``: The region name, in english. The developer can use the geoname code to localize the name of the region.
time_zone: The name of the time zone.

Errors

The endpoint will return the following errors:

a 400 Bad Request error if the IP address is not public.
a 422 Unprocessable Entity error if the IP address is malformed.

It will also return the API Global errors described in the API description.

Input

{
  "type": "object",
  "properties": {
    "ip_address": {
      "type": "string",
      "format": "ipvanyaddress"
    }
  },
  "required": [
    "ip_address"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "accuracy_radius",
    "asn_country_iso_code",
    "city_geoname_code",
    "city_name",
    "continent_code",
    "country_iso_code",
    "hostnames",
    "latitude",
    "longitude",
    "postal_code",
    "region_geoname_code",
    "region_name",
    "time_zone"
  ],
  "properties": {
    "accuracy_radius": {
      "type": "number"
    },
    "asn_country_iso_code": {
      "type": "string"
    },
    "city_geoname_code": {
      "type": "integer"
    },
    "city_name": {
      "type": "string"
    },
    "continent_code": {
      "type": "string"
    },
    "country_iso_code": {
      "type": "string"
    },
    "hostnames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "postal_code": {
      "type": "string"
    },
    "region_geoname_code": {
      "type": "integer"
    },
    "region_name": {
      "type": "string"
    },
    "self": {
      "type": "string"
    },
    "time_zone": {
      "type": "string"
    }
  }
}