Set Geolocation

Set the current geo location

Example Usage

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

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

// Javascript
// webdriver.io example
driver.location({latitude: 121.21, longitude: 11.56, altitude: 94.23});



[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml)
// wd example
await driver.setGeoLocation(121.21, 11.56, 10);

# Ruby
# ruby_lib example
set_location(121.21, 11.56, 94.23)


[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml)
# ruby_lib_core example
@driver.set_location(121.21, 11.56, 94.23)

# PHP
// TODO PHP sample

// C#
driver.Location.Altitude = 94.23;
driver.Location.Latitude = 121.21;
driver.Location.Longitude = 11.56;

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.2+ 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
PHP All github.com
C# All github.com

HTTP API Specifications

Endpoint

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)

Response

null

See Also