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

  Edit this Doc Set Geolocation

Set the current geo location

Example Usage

driver.setLocation(new Location(49, 123, 10)); // Must be a driver that implements LocationContext

self.driver.set_location(49, 123, 10)

// example
driver.setGeoLocation({latitude: "121.21", longitude: "11.56", altitude: "94.23"});

// wd example
await driver.setGeoLocation(121.21, 11.56, 10);

# ruby_lib example
set_location(121.21, 11.56, 94.23)

# ruby_lib_core example
@driver.set_location(121.21, 11.56, 94.23)

driver.Location.Altitude = 94.23;
driver.Location.Latitude = 121.21;
driver.Location.Longitude = 11.56;


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
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


POST /session/:session_id/location

URL Parameters

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

JSON Parameters

name type description
latitude number The desired geolocation latitude
longitude number The desired geolocation longitude
altitude number The desired geolocation altitude (optional. altitude works on real Android devices only)



See Also