IP Intelligence API

It is very simple to use: you only need to submit your API key and an IP address, and the API will respond with the location of that IP and security details, including VPN detection, proxy status, TOR usage, abuse potential, hosting services, relay status, and mobile IP identification.

​

Getting started

​

REST

The IP Intelligence API, like all of Abstract’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URLs and to use HTTP status codes to indicate errors.

​

HTTPS

The IP Intelligence API requires all communications to be secured with TLS 1.2 or greater.

​

API Versions

All of Abstract’s APIs are versioned. The IP Intelligence API is currently on Version 1.

​

Your API Key

Your API key is your unique authentication key to be used to access Abstract’s IP Intelligence API. Note that each of Abstract’s APIs has a unique API key, so you will need different keys to access the IP Intelligence and Email Validation APIs, for example. To authenticate your requests, you will need to append your API key to the base URL.

​

Base URL

https://ip-intelligence.abstractapi.com/v1/

​

Validation endpoint

Abstract’s IP Intelligence API simply requires your unique API key and will automatically detect the IP address from the client where it is called. You can also append the “ip_address” parameter to specify the IP to analyze:

https://ip-intelligence.abstractapi.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& ip_address = 166.171.248.255 (optional)

{
	"ip_address": "185.197.192.65",
	"security": {
	    "is_vpn": false,
	    "is_proxy": true,
	    "is_tor": false,
		"is_hosting": false,
		"is_relay": false,
		"is_mobile": false,
		"is_abuse": false,
	},
	"asn": {
	    "asn": 136787,
	    "name": "PacketHub S.A.",
	    "domain": "packethub.tech",
	    "type": "isp",
    },
    "company": {
	    "name": "PacketHub S.A.",
	    "domain": "packethub.tech",
	    "type": "isp",
    },
    "domains": {
		"domains": []
	},
    "location": {
	    "city": "Miami",
	    "city_geoname_id": 4164138,
	    "region": "Florida",
	    "region_iso_code": "FL",
	    "region_geoname_id": 4155751,
	    "postal_code": "33197",
	    "country": "United States",
	    "country_code": "US",
	    "country_geoname_id": 6252001,
	    "is_country_eu": false,
	    "continent": "North America",
	    "continent_code": "NA",
	    "continent_geoname_id": 6255149,
	    "longitude": -80.1946,
	    "latitude": 25.7689,
    },
    "timezone": {
	    "name": "America/New_York",
	    "abbreviation": "EST",
	    "utc_offset": -5,
	    "local_time": "12:07:51",
	    "is_dst": false,
    },
    "flag": {
	    "flag": "🇺🇸",
	    "unicode": "U+1F1FA U+1F1F8",
	    "png": "https://static.abstractapi.com/country-flags/US_flag.png",
	    "svg": "https://static.abstractapi.com/country-flags/US_flag.svg",
	},
	"currency": {
	    "name": "US Dollar",
	    "iso_code": "USD",
	    "symbol": "$"
	}
}

​

Request parameters

This was a successful request, so the IP address and details associated with it are returned below:

​

Response parameters

The API response is returned in a universal and lightweight JSON format.

​

Limiting response fields

You can choose to only receive a few fields from the JSON response. To do so, you can include a fields value in the query parameters with a comma separated list of the top-level keys you want to be returned.

For example, a request to only get the country and city of an IP will look like this:

https://ip-intelligence.abstractapi.com/v1/
    ? api_key = YOUR_API_KEY
    & ip_address = 166.171.248.255
    & fields = country,city

The response would look like this:

{
  "country": "United States",
  "city": "Modesto"
}

​

Response and error codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

​

Country Codes

Below is a list of two-letter ISO 3166 Alpha 2 country codes that are used in the response. View this list in a CSV.

​

Code samples and libraries

Please see the top of this page for code samples for these languages and more. If we’re missing a code sample, or if you’d like to contribute a code sample or library in exchange for free credits, email us at: team@abstractapi.com

​

Other notes

A note on metered billing: Each individual IP you submit counts as a credit used. Credits are also counted per request, not per successful response. So if you submit a request for the (invalid) IP address “kasj8929hs”, that still counts as 1 credit.