{"id":18576560,"url":"https://github.com/bigdatacloudapi/js-reverse-geocode-client","last_synced_at":"2025-04-10T09:30:34.037Z","repository":{"id":194439945,"uuid":"213285802","full_name":"bigdatacloudapi/js-reverse-geocode-client","owner":"bigdatacloudapi","description":"A frontend Javascript (JS) client for using the Free Reverse Geocoding API provided by BigDataCloud","archived":false,"fork":false,"pushed_at":"2023-12-18T20:43:47.000Z","size":12,"stargazers_count":20,"open_issues_count":1,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T19:06:04.738Z","etag":null,"topics":["geocoding","geolocation","javascript","location","reverse-geocoding"],"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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-07T03:16:28.000Z","updated_at":"2024-06-26T13:17:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"177a382c-ec16-4bf4-9ec3-3fac912c86da","html_url":"https://github.com/bigdatacloudapi/js-reverse-geocode-client","commit_stats":null,"previous_names":["bigdatacloudapi/js-reverse-geocode-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-reverse-geocode-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-reverse-geocode-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-reverse-geocode-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigdatacloudapi%2Fjs-reverse-geocode-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigdatacloudapi","download_url":"https://codeload.github.com/bigdatacloudapi/js-reverse-geocode-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248191593,"owners_count":21062531,"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":["geocoding","geolocation","javascript","location","reverse-geocoding"],"created_at":"2024-11-06T23:25:26.523Z","updated_at":"2025-04-10T09:30:34.029Z","avatar_url":"https://github.com/bigdatacloudapi.png","language":"JavaScript","readme":"# BigDataCloud Free Reverse Geocoding Javascript API Client\n\n\nA frontend Javascript client for using the Free Reverse Geocoding API provided by [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 start Reverse Geocoding your customer's locations.\n\n\n## Recent Changes\n\n### 2021-05-06 \nThis client now supports graceful fallback when a user denies accessing their device location.\nYou can now get high quality location information on your users even when they do not provide their latitude/longitude.\nThis feature is only available in client-side use (see Usage limits below for more information)\n[To find out how this works, view this blog post](https://www.bigdatacloud.com/blog/new-feature-update-free-client-side-reverse-geocoding-api-with-ip-geolocation-fallback).\n\n\n## Documentation\n\nDocumentation specific to this Free API Client is detailed below.\nFor more information about the API, please visit [FREE Client-side Reverse Geocoding to City API](https://www.bigdatacloud.com/free-api/free-reverse-geocode-to-city-api).\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.\nThis particular API is for client-side use only. Any user found abusing this service by implementing it server-side will be blacklisted from all of our free Api Services.\nIf you wish to utilise this Reverse Geocoding API in your backend applications, please visit our [server-side variation of this API](https://www.bigdatacloud.com/reverse-geocoding) for pricing details.\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_reverse_geocode.js\" type=\"text/javascript\"\u003e\u003c/script\u003e` before your code execution\n3. Initiate the Reverse geocode 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.net/gh/bigdatacloudapi/js-reverse-geocode-client@latest/bigdatacloud_reverse_geocode.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-reverse-geocode-client@latest/bigdatacloud_reverse_geocode.min.js\" type=\"text/javascript\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\"\u003e\n\n    /* Initialise Reverse Geocode API Client */\n    var reverseGeocoder=new BDCReverseGeocode();\n    \n    /* Get the current user's location information, based on the coordinates provided by their browser */\n    /* Fetching coordinates requires the user to be accessing your page over HTTPS and to allow the location prompt. */\n    reverseGeocoder.getClientLocation(function(result) {\n        console.log(result);\n    });\n\n    /* Get the administrative location information using a set of known coordinates */\n    reverseGeocoder.getClientLocation({\n        latitude: -33.8688,\n        longitude: 151.2093,\n    },function(result) {\n        console.log(result);\n    });\n\n    /* You can also set the locality language as needed */\n    reverseGeocoder.localityLanguage='es';\n\n    /* Request the current user's coordinates (requires HTTPS and acceptance of prompt) */\n    reverseGeocoder.getClientCoordinates(function(result) {\n        console.log(result);\n    });\n\n\u003c/script\u003e\n```\n\n\n## Example output\n\n```javascript\n{\n    \"latitude\": \"-33.8688\",\n    \"longitude\": \"151.2093\",\n    \"localityLanguageRequested\": \"en\",\n    \"countryName\": \"Australia\",\n    \"principalSubdivision\": \"New South Wales\",\n    \"locality\": \"Sydney\",\n    \"localityInfo\": {\n        \"administrative\": [{\n            \"order\": 1,\n            \"adminLevel\": 2,\n            \"name\": \"Australia\",\n            \"description\": \"country in Oceania\",\n            \"isoName\": \"Australia\",\n            \"isoCode\": \"AU\",\n            \"wikidataId\": \"Q408\"\n        }, {\n            \"order\": 2,\n            \"adminLevel\": 4,\n            \"name\": \"New South Wales\",\n            \"description\": \"state of Australia\",\n            \"isoName\": \"New South Wales\",\n            \"isoCode\": \"AU-NSW\",\n            \"wikidataId\": \"Q3224\"\n        }, {\n            \"order\": 3,\n            \"adminLevel\": 7,\n            \"name\": \"Sydney\",\n            \"description\": \"capital city of New South Wales, Australia\",\n            \"wikidataId\": \"Q3130\"\n        }, {\n            \"order\": 4,\n            \"adminLevel\": 6,\n            \"name\": \"Council of the City of Sydney\",\n            \"description\": \"municipality\"\n        }, {\n            \"order\": 5,\n            \"adminLevel\": 10,\n            \"name\": \"Sydney\",\n            \"description\": \"central business district of Sydney, New South Wales, Australia\",\n            \"wikidataId\": \"Q1852577\"\n        }]\n    }\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigdatacloudapi%2Fjs-reverse-geocode-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigdatacloudapi%2Fjs-reverse-geocode-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigdatacloudapi%2Fjs-reverse-geocode-client/lists"}