Sign in

v1

latestSwagger 2.02026-07-132830204.5 KB
Security and Networking

IP Probe

Execute a realtime network probe against an IPv4 or IPv6 address

get/ip-probe

Query parameters

ipstring required

An IPv4 or IPv6 address. Accepts standard IP notation and also CIDR notation

Response

OK

validboolean required

True if this is a valid IPv4 or IPv6 address

countrystring required

Full country name

provider-typestring required

The detected provider type, possible values are: <br> <ul> <li>isp - IP belongs to an internet service provider. This includes both mobile, home and business internet providers</li> <li>hosting - IP belongs to a hosting company. This includes website hosting, cloud computing platforms and colocation facilities</li> <li>vpn - IP belongs to a VPN provider</li> <li>proxy - IP belongs to a proxy service. This includes HTTP/SOCKS proxies and browser based proxies</li> <li>university - IP belongs to a university/college/campus</li> <li>government - IP belongs to a government department. This includes military facilities</li> <li>commercial - IP belongs to a commercial entity such as a corporate headquarters or company office</li> <li>unknown - could not identify the provider type</li> </ul>

country-codestring required

ISO 2-letter country code

hostnamestring required

The IPs full hostname (PTR)

provider-domainstring required

The domain name of the provider

citystring required

Full city name (if detectable)

provider-websitestring required

The website URL for the provider

ipstring required

The IPv4 or IPv6 address returned

regionstring required

Full region name (if detectable)

provider-descriptionstring required

A description of the provider (usually extracted from the providers website)

continent-codestring required

ISO 2-letter continent code

is-hostingboolean required

True if this IP belongs to a hosting company. Note that this can still be true even if the provider type is VPN/proxy, this occurs in the case that the IP is detected as both types

is-ispboolean required

True if this IP belongs to an internet service provider. Note that this can still be true even if the provider type is VPN/proxy, this occurs in the case that the IP is detected as both types

country-code3string required

ISO 3-letter country code

currency-codestring required

ISO 4217 currency code associated with the country

is-vpnboolean required

True if this IP ia a VPN

is-proxyboolean required

True if this IP is a proxy

asnstring required

The autonomous system (AS) number

as-cidrstring required

The autonomous system (AS) CIDR range

as-country-codestring required

The autonomous system (AS) ISO 2-letter country code

as-country-code3string required

The autonomous system (AS) ISO 3-letter country code

as-domainsstring[] required

Array of all the domains associated with the autonomous system (AS)

as-descriptionstring required

The autonomous system (AS) description / company name

as-ageinteger required

The age of the autonomous system (AS) in number of years since registration

host-domainstring required

The IPs host domain

vpn-domainstring required

The domain of the VPN provider (may be empty if the VPN domain is not detectable)

is-v6boolean required

True if this is a IPv6 address. False if IPv4

is-v4-mappedboolean required

True if this is a <a href="https://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses">IPv4 mapped IPv6 address</a>

is-bogonboolean required

True if this is a bogon IP address such as a private network, local network or reserved address

region-codestring required

ISO 3166-2 region code (if detectable)

Example response

{
  "as-age": 35,
  "as-cidr": "194.233.98.0/24",
  "as-country-code": "GB",
  "as-country-code3": "GBR",
  "as-description": "CDNEXT, GB, Packethub S.A",
  "as-domains": [
    "sh.cz",
    "superhosting.cz",
    "datacamp.co.uk",
    "cdn77.com",
    "heficed.com",
    "packethub.tech"
  ],
  "asn": "212238",
  "city": "Atlanta",
  "continent-code": "NA",
  "country": "United States of America",
  "country-code": "US",
  "country-code3": "USA",
  "currency-code": "USD",
  "host-domain": "",
  "hostname": "",
  "ip": "194.233.98.38",
  "is-bogon": false,
  "is-hosting": true,
  "is-isp": false,
  "is-proxy": false,
  "is-v4-mapped": false,
  "is-v6": false,
  "is-vpn": true,
  "provider-description": "Dedikované servery, managed servery a server hosting: Řešení pro náročné zákazníky. Servery poskytujeme přes 18 let a pečujeme o více než třetinu českého internetu. Proto nám důvěřují nejnavštěvovanější weby",
  "provider-domain": "sh.cz",
  "provider-type": "vpn",
  "provider-website": "https://www.sh.cz/",
  "region": "Georgia",
  "region-code": "GA",
  "valid": true,
  "vpn-domain": ""
}