README.md

BigDataCloud Free Public Client IP API Client

A Javascript client for fetching the public IP address of a fronted user BigDataCloud This client works without any Javascript dependencies and has no API key or account requirement... Simply load it up and you're ready to fetch the public IP address of your frontend users.

For more information about this API and how it works, please click here.

Documentation

Documentation specific to this Free API Client is detailed below. For more information on other available APIs, please visit our API area.

Authentication / Identification

There is no authentication or identification required to use this API or client. You may use this API and client for Free without an account.

Usage Limits

This client-side API is completely FREE for both commercial and non-commercial use, including unlimited usage with no throttling or limitations.

Manual Installation

1. Download the included javascript file and place it in a publically accessible location
2. Include the script tag <script src="bigdatacloud_client_ip.js" type="text/javascript"></script> before your code execution
3. Initiate the Client Info API Client as per the below example

CDN Installation

1. Include the CDN script tag <script src="https://cdn.jsdelivr/gh/bigdatacloudapi/js-client-ip-client@latest/bigdatacloud_client_ip.min.js" type="text/javascript"></script> before your code execution
2. Initiate the API Client and make the required calls as necessary

Example usage

<script src="https://cdn.jsdelivr.net/gh/bigdatacloudapi/js-client-ip-client@latest/bigdatacloud_client_ip.min.js" type="text/javascript"></script>
<script type="text/javascript">

    getBDCClientIp(
        /* provide a callback function for receiving the client ip */
        function(result) {
            console.log(result);
        }
    );

</script>

Example output

{
    "ipString": "8.8.8.8",
    "ipNumeric": 134744072,
    "ipType": "IPv4",
    "isBehindProxy": false,
}