{"id":18576553,"url":"https://github.com/bigdatacloudapi/js-client-ip-client","last_synced_at":"2025-04-10T08:31:19.978Z","repository":{"id":194440907,"uuid":"213784575","full_name":"bigdatacloudapi/js-client-ip-client","owner":"bigdatacloudapi","description":"A Javascript client for fetching the public IP address of a fronted user","archived":false,"fork":false,"pushed_at":"2023-01-10T00:09:45.000Z","size":5,"stargazers_count":3,"open_issues_count":0,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-09-13T10:26:35.361Z","etag":null,"topics":["api","ip-address-lookup","ip-geolocation","ip-lookup"],"latest_commit_sha":null,"homepage":"https://www.bigdatacloud.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigdatacloudapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-10-09T00:36:22.000Z","updated_at":"2023-09-13T10:26:36.965Z","dependencies_parsed_at":"2023-09-13T10:36:47.219Z","dependency_job_id":null,"html_url":"https://github.com/bigdatacloudapi/js-client-ip-client","commit_stats":null,"previous_names":["bigdatacloudapi/js-client-ip-client"],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-client-ip-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-client-ip-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-client-ip-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-client-ip-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigdatacloudapi","download_url":"https://codeload.github.com/bigdatacloudapi/js-client-ip-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223431833,"owners_count":17143953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","ip-address-lookup","ip-geolocation","ip-lookup"],"created_at":"2024-11-06T23:25:23.334Z","updated_at":"2024-11-06T23:25:24.006Z","avatar_url":"https://github.com/bigdatacloudapi.png","language":"JavaScript","readme":"# BigDataCloud Free Public Client IP API Client\n\n\nA Javascript client for fetching the public IP address of a fronted user [BigDataCloud](https://www.bigdatacloud.com)\nThis 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.\n\nFor more information about this API and how it works, [please click here.](https://www.bigdatacloud.com/docs/api/public-ip-address-api) \n\n## Documentation\n\nDocumentation specific to this Free API Client is detailed below.\nFor more information on other available APIs, please visit our [API area](https://www.bigdatacloud.com/docs).\n\n\n\n## Authentication / Identification\n\nThere is no authentication or identification required to use this API or client.\nYou may use this API and client for Free without an account.\n\n\n\n## Usage Limits\n\nThis client-side API is completely FREE for both commercial and non-commercial use, including unlimited usage with no throttling or limitations.\n\n\n\n## Manual Installation\n\n1. Download the included javascript file and place it in a publically accessible location\n2. Include the script tag `\u003cscript src=\"bigdatacloud_client_ip.js\" type=\"text/javascript\"\u003e\u003c/script\u003e` before your code execution\n3. Initiate the Client Info API Client as per the below example\n\n\n\n## CDN Installation\n\n1. Include the CDN script tag `\u003cscript src=\"https://cdn.jsdelivr/gh/bigdatacloudapi/js-client-ip-client@latest/bigdatacloud_client_ip.min.js\" type=\"text/javascript\"\u003e\u003c/script\u003e` before your code execution\n2. Initiate the API Client and make the required calls as necessary\n\n\n\n## Example usage\n\n```javascript\n\u003cscript src=\"https://cdn.jsdelivr.net/gh/bigdatacloudapi/js-client-ip-client@latest/bigdatacloud_client_ip.min.js\" type=\"text/javascript\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\"\u003e\n\n    getBDCClientIp(\n        /* provide a callback function for receiving the client ip */\n        function(result) {\n            console.log(result);\n        }\n    );\n\n\u003c/script\u003e\n```\n\n\n## Example output\n\n```javascript\n{\n    \"ipString\": \"8.8.8.8\",\n    \"ipNumeric\": 134744072,\n    \"ipType\": \"IPv4\",\n    \"isBehindProxy\": false,\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigdatacloudapi%2Fjs-client-ip-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigdatacloudapi%2Fjs-client-ip-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigdatacloudapi%2Fjs-client-ip-client/lists"}