API Documentation

API Basic Information

To start using the IPHunter API you must subscribe to a Plan

In the API response, we have a field called block, which identifies the risk level of the analyzed IP. When block is equal to 1 we advise that the access of the analyzed user be blocked to avoid problems to the rest of the users that make a correct use of their website or application.

block: 0 Residential / unclassified IP (secure IP)

block: 1 Non-residential IP (Hosting, Proxy, VPN ...)

block: 2 Non-residential and residential IP (warning, can alert innocent people)

Every day we know more than 3,000 new IPS that are used to hide the real identity of the users (among other reasons).

For more information, do not hesitate to consult our documentation.

Documentation

Additional Information

In addition to the type of connection with security level (block), we send the name of the country in English, the country code, the city and the ISP of the IP.

Before blocking an IP on your site, we recommend analyzing if the user is trying to perform any fraudulent action on your Application. We fight against fraud on the Internet, and in 90% of cases they use Hosting, VPN or Proxy to hide the identification of users.

API sample response

Endpoint

curl https://www.iphunter.info:8082/v1/ip/148.56.53.217 -H "X-Key: PRIVATEAPIKEY"

Correct answer

{
    "status": "success",
    "data": {
        "ip": "148.56.53.217",
        "ip_num": 2486711769,
        "country_code": "ES",
        "country_name": "Spain",
        "city": "Madrid",
        "isp": "Vodafone Espana S.A.U.",
        "block": 0
    }
}

Error Response

{
    "status": "error",
    "code": "Bad Ip Range"
}

The API responds in JSON format. cURL is a command line program to recover data from the web using a console.

If you reach the limit of requests (per second, or per day), an HTTP status code of 429 will be returned.