Giter VIP home page Giter VIP logo

js-reverse-geocode-client's Introduction

BigDataCloud Free Reverse Geocoding Javascript API Client

A frontend Javascript client for using the Free Reverse Geocoding API provided by BigDataCloud This 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.

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. This 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. If you wish to utilise this Reverse Geocoding API in your backend applications, please visit our server-side variation of this API for pricing details.

Manual Installation

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

CDN Installation

  1. Include the CDN script tag <script src="https://cdn.jsdelivr.net/gh/bigdatacloudapi/js-reverse-geocode-client@latest/bigdatacloud_reverse_geocode.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-reverse-geocode-client@latest/bigdatacloud_reverse_geocode.min.js" type="text/javascript"></script>
<script type="text/javascript">

    /* Initialise Reverse Geocode API Client */
    var reverseGeocoder=new BDCReverseGeocode();
    
    /* Get the current user's location information, based on the coordinates provided by their browser */
    /* Fetching coordinates requires the user to be accessing your page over HTTPS and to allow the location prompt. */
    reverseGeocoder.getClientLocation(function(result) {
        console.log(result);
    });

    /* Get the administrative location information using a set of known coordinates */
    reverseGeocoder.getClientLocation({
        latitude: -33.8688,
        longitude: 151.2093,
    },function(result) {
        console.log(result);
    });

    /* You can also set the locality language as needed */
    reverseGeocoder.localityLanguage='es';

    /* Request the current user's coordinates (requires HTTPS and acceptance of prompt) */
    reverseGeocoder.getClientCoordinates(function(result) {
        console.log(result);
    });

</script>

Example output

{
    "latitude": "-33.8688",
    "longitude": "151.2093",
    "localityLanguageRequested": "en",
    "countryName": "Australia",
    "principalSubdivision": "New South Wales",
    "locality": "Sydney",
    "localityInfo": {
        "administrative": [{
            "order": 1,
            "adminLevel": 2,
            "name": "Australia",
            "description": "country in Oceania",
            "isoName": "Australia",
            "isoCode": "AU",
            "wikidataId": "Q408"
        }, {
            "order": 2,
            "adminLevel": 4,
            "name": "New South Wales",
            "description": "state of Australia",
            "isoName": "New South Wales",
            "isoCode": "AU-NSW",
            "wikidataId": "Q3224"
        }, {
            "order": 3,
            "adminLevel": 7,
            "name": "Sydney",
            "description": "capital city of New South Wales, Australia",
            "wikidataId": "Q3130"
        }, {
            "order": 4,
            "adminLevel": 6,
            "name": "Council of the City of Sydney",
            "description": "municipality"
        }, {
            "order": 5,
            "adminLevel": 10,
            "name": "Sydney",
            "description": "central business district of Sydney, New South Wales, Australia",
            "wikidataId": "Q1852577"
        }]
    }
}

js-reverse-geocode-client's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.