Getting started with IPLocate

Introduction

IPLocate provides an API to return data for IPv4 and IPv6 IP addresses - such as country, city, continent, timezone, and more.

The API also provides comprehensive ASN data, WHOIS data, and threat and privacy data. For example:

• which organisation hosts the IP address
• whether the IP address is a proxy or VPN, or belongs to a hosting provider
• whether the IP address is abusive

IPLocate data is updated daily, using 50TB+ of public and proprietary data to produce our ground-truth data sets.

Quick start

Start by signing up for a free API key.

We have client libraries for popular languages, so you can get started quickly:

Want to see a new language here, or developed your own integration? Let us know!

Or, try these quick start snippets:

Curl

curl https://iplocate.io/api/lookup/8.8.8.8?apikey=

Node.js

const iplocate = require('node-iplocate');

iplocate('17.253.0.0', { api_key: "" }).then((results) => {
  console.log(results);
});

JavaScript (fetch)

const response = await fetch('https://iplocate.io/api/lookup/17.253.0.0?apikey=');
const data = await response.json();

console.log(data);

Ruby

require 'iplocate'

results = IPLocate.lookup('17.253.0.0')

puts results.inspect

Python

import requests

ip = '17.253.0.0'
apiKey = ''
url = f'https://iplocate.io/api/lookup/{ip}&apikey={apiKey}'

response = requests.get(url)
print(response.json())

PHP

<?php

$res = file_get_contents('https://iplocate.io/api/lookup/17.253.0.0?apikey=');
$res = json_decode($res);

var_dump($res);

Authentication and API limits

Sign up for a free API key for 1,000 requests per day. You can purchase a monthly or yearly subscription starting at $25/month for higher API limits.

Pass your API key in the ?apikey query parameter, or in the X-API-Key header.

If you don't include an API key, your IP address is limited to 50 requests per day.

Our API provides information about your rate limits in the response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

You can also view your current usage and quota in your account dashboard.

API response data

An example response from the API can be seen by using the tool on the home page, or below:

{
  "ip": "123.243.246.200",
  "country": "Australia",
  "country_code": "AU",
  "is_eu": false,
  "city": "Sydney",
  "continent": "Oceania",
  "latitude": -33.8672,
  "longitude": 151.1997,
  "time_zone": "Australia/Sydney",
  "postal_code": "2049",
  "subdivision": "New South Wales",
  "subdivision2": null,
  "network": "123.243.240.0/20",
  "asn": {
    "asn": "AS7545",
    "route": "123.243.246.0/24",
    "netname": "TPG-INTERNET-AP",
    "name": "TPG Telecom Limited",
    "country_code": "AU",
    "domain": "tpgtelecom.com.au",
    "type": "isp",
    "rir": "APNIC"
  },
  "privacy": {
    "is_abuser": false,
    "is_anonymous": false,
    "is_bogon": false,
    "is_datacenter": false,
    "is_icloud_relay": false,
    "is_proxy": false,
    "is_tor": false,
    "is_vpn": false
  },
  "company": {
    "name": "TPG Telecom",
    "domain": "www.tpgtelecom.com.au",
    "country_code": "AU",
    "type": "isp"
  },
  "abuse": {
    "address": "TPG Internet Pty Ltd., (Part of the Total Peripherals Group), 65 Waterloo Road, North Ryde NSW 2113",
    "email": "[email protected]",
    "name": "ABUSE TPGCOMAU",
    "network": "123.243.246.192 - 123.243.246.223",
    "phone": "+000000000"
  }
}

Base data Available in all plans

The base API response includes IP geolocation information such as country, city, currency and calling codes, timezone.

Attributes

ASN data Available in all plans

The asn object provides detailed information about the Autonomous System of the IP address. This is usually the service provider or network responsible for connecting the IP address to the rest of the internet.

Attributes

Privacy & threat data Available in all plans

Privacy and threat data provides detailed information about privacy services associated with the IP address (such as proxies, VPNs, iCloud Private Relay), as well as threat and security information like abuse and spam reports.

This data is updated multiple times per day from a combination of public and proprietary data sources.

Attributes

Hosting data Available in all plans

Hosting data provides additional detailed information about the type of hosting service or datacenter the IP address belongs to. For example: AWS or Azure datacenter information.

{
  "hosting": {
    "provider": "Amazon AWS",
    "domain": "aws.amazon.com",
    "network": "3.5.140.0/22",
    "region": "ap-northeast-2",
    "service": "EC2"
  }
}

Attributes

Abuse contact data Available in all plans

Abuse contact data is contact information (usually of the network administrator) which can be used to report IP addresses that are engaged in fraudulent/malicious activites.

Attributes

Company data Available in all plans

Company data identifies the name of the organization behind the IP address, the type of business, and its domain name. We source this information from various publicly available datasets. The company type is classified by a machine learning model based on observed IP address usage patterns and company metadata.

Attributes

VPN data Private beta

VPN data provides additional detailed information about the type of VPN or proxy service the IP address belongs to.

VPN data will be populated for IP addresses where privacy.is_vpn is true, and where we have additional data.

Advanced usage

Look up your own IP address

If you don't provide an IP address, we'll provide the data for the IP address you're calling from. You could use this, for example, to fetch a client's IP address data directly from front-end code.

curl https://iplocate.io/api/lookup/?apikey=

With JSONP callback

curl https://iplocate.io/api/lookup/8.8.8.8/json?callback=my_javascript_function

With API key as header

curl --header "X-API-Key: " https://iplocate.io/api/lookup/8.8.8.8

Data corrections

We use a variety of public and proprietary data sources to provide the most accurate IP location data possible. However, if you find any inaccuracies, please submit a correction and we'll update our data as soon as possible.

We prefer a link to a hosted Geofeed, or a list of IP address data in Geofeed (RFC 8805) format.