This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Get Geolocation

Get the current geo location

Example Usage

Location location = driver.location(); // Must be a driver that implements LocationContext


location = self.driver.location()


// webdriver.io example
let location = driver.getGeoLocation();

// wd example
let location = await driver.getGeoLocation();


# ruby_lib example
location

# ruby_lib_core example
@driver.location


Location location = driver.Location;

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All seleniumhq.github.io
Python All selenium-python.readthedocs.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
C# All github.com

HTTP API Specifications

Endpoint

GET /session/:session_id/location

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

None

Response

name type description
latitude number The current geolocation latitude
longitude number The current geolocation longitude
altitude number The current geolocation altitude

See Also