Response ip object

The IP object provides details of the person's IP address including the ISP, the business that owns it, country/location, and risk flags.

It's available in the result whenever an ip is provided in the input data, or where the IP can be derived from the device.

If the lookup is unsuccessful, success will be false.

Examples

Unsuccessful:

{
    ...
    "ip": {
        "success": false
    },
    ...
}

Valid:

{
    ...
    "ip": {
        "success": true,
        "in_country": true,
        "ip": "204.158.96.40",
        "ip_network": "204.158.96",
        "isp": "Comcast Cable Communications LLC",
        "organization": "Comcast Cable Communications LLC",
        "carrier": "Verizon",
        "type": "business",
        "city": "Minneapolis",
        "state": "Minnesota",
        "country_name": "United States",
        "country_code": "US",
        "postal_code": "55400",
        "timezone": "America/Chicago",
        "latitude": 40.9255,
        "longitude": -89.3034,
        "vpn": true,
        "relay": false,
        "proxy": false,
        "tor": false,
        "hosting": false,
        "threat": false,
        "bogon": false,
        "seen_hour": 1,
        "seen_day": 1,
        "seen_month": 1,
        "seen_quarter": 1
    },
    ...
}

Properties

Property	Description	Type
success	Set to true only if the lookup is successful.	boolean
ip	The IP address.	string
ip_network	The network level partial IP address. e.g. "204.158.96".	string
isp	The name of the owner of the ASN.	string or null
organization	The name of the end-user the IP address has been assigned to.	string or null
carrier	The name of the mobile carrier that owns the IP address.	string or null
type	The type of usage associated with the IP address. See below for the possible values.	string or null
city	Location city.	string or null
state	Location state.	string or null
country_name	Full name of the location country.	string or null
country_code	Two-letter (ISO 3166-1 alpha-2) country code.	string or null
postal_code	Location postal code.	string or null
timezone	The timezone in the tz database format, in the form "Area/Location", e.g. "America/New_York".	string or null
latitude	Location latitude to 4 decimal places.	decimal or null
longitude	Location longitude to 4 decimal places.	decimal or null
vpn	Set to true if the IP address is known to be (or likely to be) a VPN.	boolean
relay	Set to true if the IP address is known to be a relay service (i.e. iCloud Relay).	boolean
proxy	Set to true if the IP address is known to be (or likely to be) a proxy.	boolean
tor	Set to true if the IP address is known to be a node on the Tor network.	boolean
hosting	Set to true if the IP address is known to be a hosting or datacenter provider.	boolean
threat	Set to true if the IP address is known to be (or likely to be) an abuse threat. That is, spam, bot, malware, crawler, etc.	boolean
bogon	Set to true for a BOGON (reserved, but not yet allocated IP address). Traffic should not be routed with this IP.	boolean
seen_hour	Number of times events have been seen with this IP network since the start of the previous hour.	integer
seen_day	Number of times events have been seen with this IP network since yesterday.	integer
seen_month	Number of times events have been seen with this IP network since the start of last month.	integer
seen_quarter	Number of times events have been seen with this IP network since the start of the last calendar quarter.	integer

Network types

Type	Description
hosting	Datacenter or hosting IP address
isp	Internet Service Provider (ISP) address
cdn	Content delivery network
edu	Educational use
gov	Government use
mil	Military use
business	Business/private use, i.e. assigned to an end-user