Welcome

Hello and welcome to the API documentation for all IPIntel services. Should you experience any issues in consumption our APIs or you encounter any unexpected behaviour please get in touch with us.

https://api.ipintel.co/

Authentication

To authenticate your request please pass your API key to the API end point in a similar fashion to the example provided to the right. Your request is now authenticated and logged in your API call log.

https://api.ipintel.co/?key=YOUR_KEY_HERE

Response codes

The IPIntel API uses standard HTTP response codes to communicate the result of an API call. We have endeavoured to match the original meaning of the HTTP response code to our adopted meaning, however the meaning may not always be clear. In such an eventuality please use the below table to understand the API response codes you receive.

Codes
  • 200 Processed

    The command was processed successfully.

  • 422 Unprocessable

    Well formatted request however some technical issue is preventing the serving of the request, e.g. an unresponsive WHOIS server

  • 400 Command unknown

    The end-point you have sent the request to is not valid (for example, the end point should be /whois or /screenshot)

  • 405 Command invalid

    The HTTP request method used is not compatible with the selected end-point. This can occur when using POST rather than GET for example.

  • 409 Command malformed

    The request has been incorrectly constructed. This can occur when omitting required parameters or providing them in the wrong type.

  • 401 Unauthorized

    The request was not authorised. This can occur when using an incorrect key, if the server IP is not on the account whitelist, or if the account is banned.

  • 402 Billing

    The request was refused due to a billing issue with the associated account.

  • 500 Internal Server Error

    The client did everything correctly, but we've had an internal issue.

IP address Whois lookup

This end-point accepts an IP address as the argument and performs a live lookup.

Parameter Description
ip_address The domain name to lookup.
curl 'https://api.ipintel.co/whois/ip?key=YOUR_KEY_HERE&ip_address=54.234.65.78'

                            

{  
   "result":{  
      "name":"8.8.8.8",
      "created":"2014-03-14 00:00:00",
      "changed":"2014-03-14 00:00:00",
      "status":"Reallocated",
      "contacts":{  
         "owner":[  
            {  
               "handle":"GOGL",
               "type":null,
               "name":null,
               "organization":"Google Inc.",
               "email":null,
               "address":"1600 Amphitheatre Parkway",
               "zipcode":"94043",
               "city":"Mountain View",
               "state":"CA",
               "country":"US",
               "phone":null,
               "fax":null,
               "created":"2000-03-30 00:00:00",
               "changed":"2017-01-28 00:00:00"
            }
         ],
         "tech":[  
            {  
               "handle":"ZG39-ARIN",
               "type":null,
               "name":"Google Inc",
               "organization":null,
               "email":"arin-contact@google.com",
               "address":null,
               "zipcode":null,
               "city":null,
               "state":null,
               "country":null,
               "phone":"+1-650-253-0000",
               "fax":null,
               "created":null,
               "changed":null
            }
         ],
         "abuse":[  
            {  
               "handle":"ABUSE5250-ARIN",
               "type":null,
               "name":"Abuse",
               "organization":null,
               "email":"network-abuse@google.com",
               "address":null,
               "zipcode":null,
               "city":null,
               "state":null,
               "country":null,
               "phone":"+1-650-253-0000",
               "fax":null,
               "created":null,
               "changed":null
            }
         ]
      },
      "network":{  
         "inetnum":"8.8.8.0 - 8.8.8.255",
         "name":"LVLT-GOGL-8-8-8",
         "handle":"NET-8-8-8-0-1"
      }
   }
}
                              

IP Geolocation

This end-point accepts an IP address and returns geolocation and contextual data about the address's location.

Parameter Description
ip_address The IP address to geolocate.
curl 'https://api.ipintel.co/geo?key=YOUR_KEY_HERE&ip_address=54.234.65.78'

                            

{  
   "country_code":"GB",
   "country_name":"United Kingdom",
   "city":"Dunfermline",
   "postal_code":"KY11",
   "location_long":-3.4987,
   "location_latitude":56.0367,
   "location_accuracy_radius":20,
   "name":{  
      "common":"United Kingdom",
      "name_official":"United Kingdom of Great Britain and Northern Ireland"
   },
   "cctld":[  
      ".uk"
   ],
   "currency_codes":[  
      "GBP"
   ],
   "calling_codes":[  
      "44"
   ],
   "capital_city":"London",
   "region":"Europe",
   "subregion":"Northern Europe",
   "languages":{  
      "eng":"English"
   },
   "latlng":[  
      54,
      -2
   ],
   "demonym":"British",
   "landlocked":false,
   "borders":[  
      "IRL"
   ],
   "area":242900
}