Documentation
This IP address API returns useful meta-information for IP addresses. For example, the API response includes the organization of the IP address, ASN information and geolocation intelligence and WHOIS data.
Furthermore, the API response allows to derive security information for each IP address, for example whether an IP address belongs to a hosting provider (is_datacenter
), is a TOR exit node (is_tor
), if an IP address is a proxy (is_proxy
) or VPN (is_vpn
) or belongs to an abuser (is_abuser
).
This API strongly emphasizes datacenter/hosting detection. A complicated hosting detection algorithm was developed to achieve a high detection rate. Thousands of different hosting providers are tracked. Whois records, public hosting IP ranges from hosting providers and a proprietary hosting discovery algorithm are used to decide whether an IP address belongs to a datacenter or not.
The API furthermore includes accurate and rich ASN meta data. For instance, the API includes raw whois data for each active ASN. Fields such as the ASN type
are derived by analyzing the company that owns the autonomous system.
Quickstart
Lookup any IP address: https://ipapi.is/json/?q=3.5.140.2
Lookup your own IP address: https://ipapi.is/json/
Usage with JavaScript:
fetch('https://ipapi.is/json/?q=23.236.48.55')
.then(res => res.json())
.then(res => console.log(res));
Usage with curl
:
curl 'https://ipapi.is/json/?q=32.5.140.2'
Introduction
The IP address API makes use of the following data sources:
- Public whois records from regional Internet address registries such as RIPE NCC, APNIC, ARIN and so on
- Public BGP routing table data for ASN lookups
- Public blocklists such as firehol/blocklist-ipset
- The API uses a proprietary datacenter/hosting detection algorithm
- Other open source projects that try to find hosting IP addresses such as github.com/client9/ipcat, github.com/Umkus/ip-index or https://github.com/X4BNet/lists_vpn are also considered
- The API uses IP threat data from various honeypots
- IP geolocation information from several different geolocation providers is used. By using more than one geolocation source, a more accurate location can be interpolated.
- A proprietary geolocation database is built from scratch. Gelocation data is sourced from whois data. For example, some Regional Internet Registries such as APNIC support the
geofeed
andgeoloc
property in whois records.
API Features
- Ready for production: This API can be used in production and is stable
- Many datacenters supported: Thousands of different hosting providers and counting - From Huawei Cloud Service to ServerMania Inc. Find out whether the IP address is hosted by looking at the
is_datacenter
property! - Always updated: The API database is automatically updated several times per week.
- ASN support: The API provides autonomous system information for each looked up IP address
- Company Support: The API provides organizational information for each network of each looked up IP address
- Bulk IP Lookups: You can lookup up to 100 IP addresses per API call
ASN Database
For offline ASN data access, the ASN Database is provided. The ASN database includes all assigned and allocated AS numbers by IANA and respective meta information. The database is updated several times per week. For active ASN's (at least one route/prefix assigned to the AS), the database includes rich meta information. For example, the provided information for the ASN 50673
would be:
"50673": {
"asn": "50673",
"org": "Serverius Holding B.V.",
"domain": "serverius.net",
"abuse": "abuse@serverius.net",
"type": "hosting",
"created": "2010-09-07",
"updated": "2022-11-15",
"rir": "ripe",
"descr": "SERVERIUS-AS, NL",
"country": "NL",
"active": true,
"prefixes": [
"2.59.183.0/24",
"5.56.133.0/24",
// many more IPv4 prefixes ...
],
"prefixesIPv6": [
"2001:67c:b0::/48",
"2a00:1ca8::/32",
// many more IPv6 prefixes ...
]
},
The database is in JSON format. The key is the ASN as int
and the value is an object with AS meta information such as the one above.
Click here to download the ASN Database
How to download & parse the ASN database?
Download and unzip the ASN database:
cd /tmp
curl -O https://ipapi.is/data/fullASN.json.zip
unzip fullASN.json.zip
And parse with nodejs:
let asnDatabase = require('./fullASN.json');
for (let asn in asnDatabase) {
console.log(asn, asnDatabase[asn]);
}
Hosting IP Ranges Database
Furthermore, the Hosting IP ranges Database is provided for offline and scalable access. This database contains all known datacenter IP ranges in the Internet. A proprietary algorithm was developed to determine if a network belongs to a hosting provider.
The file format of the database is tab separated text file (.tsv), where each line of the file contains the company
, network
and domain
of the hosting provider.
Example excerpt of the database:
Linode, LLC 178.79.160.0 - 178.79.167.255 www.linode.com
OVH Sp. z o. o. 178.32.191.0 - 178.32.191.127 www.ovh.com
myLoc managed IT AG 46.245.176.0 - 46.245.183.255 www.myloc.de
Click here to download the Hosting IP Ranges Database
How to download & parse the Datacenter database?
Download and unzip the Hosting Ranges database:
cd /tmp
curl -O https://ipapi.is/data/hostingRanges.tsv.zip
unzip hostingRanges.tsv.zip
And parse with nodejs:
const fs = require('fs');
let hostingRanges = fs.readFileSync('hostingRanges.tsv').toString().split('\n');
for (let line of hostingRanges) {
let [company, network, domain] = line.split('\t');
console.log(company, network, domain);
}
API Response Format
The API output format is explained by walking through an example. Most of the returned information is self-explanatory.
This is how a typical API response looks like. The IP 107.174.138.172
was queried with the API call https://ipapi.is/json/?q=107.174.138.172:
{
"ip": "107.174.138.172",
"rir": "ARIN",
"is_bogon": false,
"is_datacenter": true,
"is_tor": true,
"is_proxy": false,
"is_vpn": false,
"is_abuser": true,
"company": {
"name": "ColoCrossing",
"domain": "colocrossing.com",
"network": "107.172.0.0 - 107.175.255.255",
"whois": "https://ipapi.is/json/?whois=107.172.0.0"
},
"datacenter": {
"datacenter": "ColoCrossing",
"domain": "www.colocrossing.com",
"network": "107.172.0.0 - 107.175.255.255"
},
"asn": {
"asn": 36352,
"route": "107.174.138.0/24",
"descr": "AS-COLOCROSSING, US",
"country": "us",
"active": true,
"org": "ColoCrossing",
"domain": "www.colocrossing.com",
"abuse": "abuse@colocrossing.com",
"type": "hosting",
"created": "2005-12-12",
"updated": "2013-01-08",
"rir": "arin",
"whois": "https://ipapi.is/json/?whois=AS36352"
},
"location": {
"country": "United States of America",
"country_code": "US",
"state": "New York",
"city": "Buffalo",
"latitude": 42.8825,
"longitude": -78.8788,
"zip": "14202",
"timezone": "America/New_York",
"local_time": "2023-04-02T14:03:27-04:00",
"local_time_unix": 1680458607,
"is_dst": true
},
"elapsed_ms": 4.14
}
In the following section, the different parts of the API response are explained in-depth.
Response Format: Top Level API Output
The top level API output looks as follows:
{
"ip": "107.174.138.172",
"rir": "ARIN",
"is_bogon": false,
"is_datacenter": true,
"is_tor": true,
"is_proxy": false,
"is_vpn": false,
"is_abuser": true,
"elapsed_ms": 4.14
}
The explanation for the top level API fields is as follows:
Field ip
The field ip
has datatype string
.
It is the IP address that was looked up, in the example above it is 107.174.138.172
.
If no IP address was specified (Example: https://ipapi.is/json/), the client's own IP address is looked up.
Field rir
The field rir
has datatype string
.
It specifies to which Regional Internet Registry the IP address belongs. Here it belongs to ARIN
, which is the RIR responsible for North America.
Field is_bogon
The field is_bogon
has datatype boolean
.
It determines if the IP address is bogon. Bogon IP Addresses is the set of IP Addresses not assigned/allocated to IANA and any RIR (Regional Internet Registry). For example, the loopback IP 127.0.0.1
is a special/bogon IP address. The IP address 107.174.138.172
is not bogon, hence it is set to false
here.
Field is_datacenter
The field is_datacenter
has datatype boolean
.
It specifies whether the IP address belongs to a datacenter or not. Here, we have the value true
, since 107.174.138.172
belongs to the hosting provider ColoCrossing
.
Field is_tor
The field is_tor
has datatype boolean
.
If the field is_tor
is true, the IP address belongs to the TOR network. This is the case here. Tor detection is accurate, so you can rely on the value of is_tor
. The API detects most TOR exit nodes reliably.
Field is_proxy
The field is_proxy
has datatype boolean
.
The field determines whether the IP address is a proxy. This is not the case here. In general, the flag is_proxy
only covers a subset of all proxies in the Internet.
Field is_vpn
The field is_vpn
has datatype boolean
.
The field determines if the IP address is a VPN. This is not the case with the IP 107.174.138.172
. In general, the flag is_vpn
only covers a subset of all VPN's in the Internet. It is not possible to detect all VPN exit nodes passively.
Field is_abuser
The field is_abuser
has datatype boolean
.
The field is_abuser
is true if the IP address committed abusive actions, which was the case with 107.174.138.172
. Various IP blocklists and threat intelligence feeds are used to populate the is_abuser
flag.
Open source and proprietary block lists are used in the API to populate the is_abuser
flag.
Field elapsed_ms
The field elapsed_ms
has datatype float
.
The field stores how much internal processing time was spent in milliseconds (ms). This lookup only took 4.14ms
, which is quite fast.
Response Format: The datacenter
object
"datacenter": {
"datacenter": "ColoCrossing",
"domain": "www.colocrossing.com",
"network": "107.172.0.0 - 107.175.255.255"
},
If the IP address belongs to a datacenter/hosting provider, the API response will include a datacenter
object with the following attributes:
datacenter
-string
- to which datacenter the IP address belongs. For a full list of datacenters, check the ipapi.is/json/info endpoint. In this case, the datacenter's name isColoCrossing
.domain
-string
- The domain name of the companynetwork
-string
- the network this IP address belongs to (In the above case:107.172.0.0 - 107.175.255.255
)
Most IP's don't belong to a hosting provider. In those cases, the datacenter
object will not be present in the API output.
For a couple of large cloud providers, such as Google Cloud, Amazon AWS, DigitalOcean or Microsoft Azure (and some others), the datacenter
object is more detailed.
Amazon AWS example:
{
"ip": "3.5.140.2",
"datacenter": {
"datacenter": "Amazon AWS",
"network": "3.5.140.0/22",
"region": "ap-northeast-2",
"service": "EC2",
"network_border_group": "ap-northeast-2"
}
}
DigitalOcean example:
{
"ip": "167.99.241.130",
"datacenter": {
"datacenter": "DigitalOcean",
"code": "60341",
"city": "Frankfurt",
"state": "DE-HE",
"country": "DE",
"network": "167.99.240.0/20"
},
}
Linode example:
{
"ip": "72.14.182.54",
"datacenter": {
"datacenter": "Linode",
"name": "US-TX",
"city": "Richardson",
"country": "US",
"network": "72.14.182.0/24"
},
}
Response Format: The company
object
"company": {
"name": "ColoCrossing",
"domain": "colocrossing.com",
"network": "107.172.0.0 - 107.175.255.255",
"whois": "https://ipapi.is/json/?whois=107.172.0.0"
},
Most IP addresses can be associated with an organization or company. The API uses whois database information to infer which organization is the owner of a certain IP address. Most API lookups will have an company
object with the following attributes:
name
-string
- The name of the companydomain
-string
- The domain name of the companynetwork
-string
- The network for which the company has ownershipwhois
-string
- An url to the whois information for the network of this IP address
Response Format: The asn
object
"asn": {
"asn": 36352,
"route": "107.174.138.0/24",
"descr": "AS-COLOCROSSING, US",
"country": "us",
"active": true,
"org": "ColoCrossing",
"domain": "www.colocrossing.com",
"abuse": "abuse@colocrossing.com",
"type": "hosting",
"created": "2005-12-12",
"updated": "2013-01-08",
"rir": "arin",
"whois": "https://ipapi.is/json/?whois=AS36352"
},
Most IP addresses can be associated with an Autonomous System (AS). The asn
object provides the following attributes:
asn
-int
- The AS numberroute
-string
- The IP route as CIDR in this ASdescr
-string
- An informational description of the AScountry
-string
- The country where the AS is situated in (administratively)active
-string
- Whether the AS is active (active = at least one route administered by the AS)org
-string
- The organization responsible for this ASdomain
-string
- The domain of the organization to which this AS belongsabuse
-string
- The email address to which abuse complaints for this organization should be senttype
-string
- The type for this ASN, this is eitherhosting
,education
,government
,banking
,business
orisp
created
-string
- When the ASN was establishedupdated
-string
- The last time the ASN was updatedrir
-string
- To which Regional Internet Registry the ASN belongswhois
-string
- An url to the whois information for this ASN
For inactive autonomous systems, most of the above information is not available.
Response Format: The location
object
"location": {
"country": "United States of America",
"country_code": "US",
"state": "New York",
"city": "Buffalo",
"latitude": 42.8825,
"longitude": -78.8788,
"zip": "14202",
"timezone": "America/New_York",
"local_time": "2023-04-02T14:03:27-04:00",
"local_time_unix": 1680458607,
"is_dst": true
},
The API provides geolocation information for the looked up IP address. The location
object includes the following attributes:
country
-string
- The full name of the countrycountry_code
-string
- The ISO 3166-1 alpha-2 country code to which the IP address belongs. This is the country specific geolocation of the IP address.state
-string
- The state / administrative areacity
-string
- The city to which the IP address belongslatitude
-float
- The latitude for the IP addresslongitude
-float
- The longitude for the IP addresszip
-string
- The zip code for this IPtimezone
-string
- The timezone for this IPlocal_time
-string
- The local time for this IP in human readable formatlocal_time_unix
-int
- The local time for this IP as unix timestamp (int
)is_dst
-boolean
- Whether Daylight saving time (DST) is active in the region of this IP addressother
-array
- (Optional) - If there are multiple possible geographical locations, the attributeother
is included in the API response. It contains an array of ISO 3166-1 alpha-2 country codes which represent the possible other geolocation countries.
Country level geolocation accuracy is quite good, since the API provides information from several different geolocation service providers.
Furthermore, a proprietary geolocation database was built from scratch in order to source the location
object.
API Endpoints
The IP API currently has two endpoints.
GET Endpoint - Lookup a single IP Address or ASN
This GET endpoint allows to lookup a single IPv4 or IPv6 IP address by specifying the query parameter q
. Example: q=142.250.186.110
. You can also lookup ASN numbers by specifying the query q=AS209103
- Endpoint - https://ipapi.is/json/
- Method -
GET
- Parameter -
q
- The IP address or ASN to lookup - Example - https://ipapi.is/json/?q=3.5.140.2
- ASN Example - https://ipapi.is/json/?q=AS42831
POST Endpoint - Query up to 100 IP Addresses in one API call
You can also make a bulk API lookup with up to 100 IP addresses (Either IPv4 or IPv6) in one single request.
- Endpoint - https://ipapi.is/json/
- Method -
POST
- Content-Type -
Content-Type: application/json
- Parameter -
ips
- An array of IPv4 and IPv6 addresses to lookup
For example, in order to lookup the IP addresses
162.158.0.0
2406:dafe:e0ff:ffff:ffff:ffff:dead:beef
162.88.0.0
20.41.193.225
you can use the following POST API request with curl
:
curl --header "Content-Type: application/json" \
--request POST \
--data '{"ips": ["162.158.0.0", "2406:dafe:e0ff:ffff:ffff:ffff:dead:beef", "162.88.0.0", "20.41.193.225"]}' \
https://ipapi.is/json/