IP Location API JQuery SDK

Overview

IP Geolocation API provides country, city, region, local currency, latitude and longitude, company detail, ISP lookup, country calling code, timezone, country neighbours, country flag, country capital and much more from any IPv4 and IPv6 address in Newline, JSON and XML format over HTTPS. This document provides important information to help you get up to speed with IP Location API using IP Geolocation API JQuery SDK.

Quick Start Guide

You can call the API by sending HTTP GET requests to http://ipwho.is/{IP}

{IP} can be an IPv4 or IPv6 address, or none to use the current IP address.

Note: Complete documentation to use this API is also available at IP Geolocation API Documentation.

System Requirements

Internet connection is required to run this component.

Basic Usage

Call method request_ipwhois($ip, $lang, $apiKey) passing IP address or none to use the current IP address as parameters (rest of the parameters are optional) and it will return the Geolocation for the passed IP address. To customize the geolocation response, you can pass the other parameters to request_ipwhois() method as described below:

  • $lang

    Pass the language parameter to get the geolocation information in a language other than English. By default, it is set to English language.
    ipwhois provides response in the following languages:
    • en - English (default)
    • de - Deutsch (German)
    • es - Español (Spanish)
    • pt-BR - Español - Argentina (Spanish)
    • fr - Français (French)
    • ja - 日本語 (Japanese)
    • zh-CN - ** (Chinese)
    • ru - Русский (Russian)

Installation

CDN Link

Add the following script in your HTML page:

<script src="https://cdn.ipwhois.io/js/ipwho.is.js"></script>

Example

Here is a sample code to use IP Geolocation API using JQuery SDK:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script src="https://cdn.ipwhois.io/js/ipwhois.js"></script>

<script>    
    $(document).ready(function() {
        var ipaddress = "";
	var apiKey = ""; // Leave blank for free endpoint
        var ipwhois = request_ipwhois(ipaddress,'en',apiKey);
	alert("Country: " + ipwhois.country);
        alert("City: " + ipwhois.city);
        alert("Region: " + ipwhois.region);
    });
</script>