https://github.com/bigdatacloudapi/js-client-info-client
A Javascript client for fetching information about a fronted user
https://github.com/bigdatacloudapi/js-client-info-client
api ip-geolocation ipinfo javascript
Last synced: 8 months ago
JSON representation
A Javascript client for fetching information about a fronted user
- Host: GitHub
- URL: https://github.com/bigdatacloudapi/js-client-info-client
- Owner: bigdatacloudapi
- License: mit
- Created: 2019-10-09T00:38:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T02:01:16.000Z (over 2 years ago)
- Last Synced: 2025-03-24T19:05:52.516Z (9 months ago)
- Topics: api, ip-geolocation, ipinfo, javascript
- Language: JavaScript
- Homepage: https://www.bigdatacloud.com
- Size: 5.86 KB
- Stars: 6
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BigDataCloud Free Client Info API Client
A Javascript client for fetching information about a fronted user [BigDataCloud](https://www.bigdatacloud.com)
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 information about your frontend users.
## Documentation
Documentation specific to this Free API Client is detailed below.
For more information about the API, please visit [FREE Client Info API](https://www.bigdatacloud.com/free-api/client-info-api).
## 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 `` before your code execution
3. Initiate the Client Info API Client as per the below example
## CDN Installation
1. Include the CDN script tag `` before your code execution
2. Initiate the API Client and make the required calls as necessary
## Example usage
```javascript
getBDCClientInfo(
/* provide a callback function for client info result */
function(result) {
console.log(result);
}
);
```
## Example output
```javascript
{
"ipString": "8.8.8.8",
"ipNumeric": 134744072,
"ipType": "IPv4",
"isBehindProxy": false,
"device": "Desktop",
"os": "Windows 10",
"userAgent": "Chrome 76.0.3809",
"family": "Chrome",
"versionMajor": "76",
"versionMinor": "0",
"versionPatch": "3809",
"isSpider": false,
"userAgentDisplay": "Windows 10 Desktop Chrome 76.0.3809",
"userAgentRaw": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.132 Safari/537.36",
"userLanguages": ["en-US", "en"]
}
```