Geolocation.getCurrentPosition()

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The Geolocation.getCurrentPosition() method is used to get the current position of the device.

Syntax

navigator.geolocation.getCurrentPosition(success[, error[, [options]])

Parameters

success
A callback function that takes a GeolocationPosition object as its sole input parameter.
error Optional
An optional callback function that takes a GeolocationPositionError object as its sole input parameter.
options Optional
An optional PositionOptions object.
Options includes:
  • maximumAge: integer (milliseconds) | infinity - maximum cached position age.
  • timeout: integer (milliseconds) - amount of time before the error callback is invoked, if 0 it will never invoke.
  • enableHighAccuracy: false | true

Examples

var options = {
  enableHighAccuracy: true,
  timeout: 5000,
  maximumAge: 0
};

function success(pos) {
  var crd = pos.coords;

  console.log('Your current position is:');
  console.log(`Latitude : ${crd.latitude}`);
  console.log(`Longitude: ${crd.longitude}`);
  console.log(`More or less ${crd.accuracy} meters.`);
}

function error(err) {
  console.warn(`ERROR(${err.code}): ${err.message}`);
}

navigator.geolocation.getCurrentPosition(success, error, options);

Specifications

Specification Status Comment
Geolocation API Recommendation Initial specification.

Browser compatibility

BCD tables only load in the browser

See also