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

  Edit this Doc Get Orientation

Get the current device/browser orientation

Example Usage

ScreenOrientation orientation = driver.getOrientation();

orientation = self.driver.orientation

// example
let orientation = driver.getOrientation();

// wd example
let orientation = await driver.getOrientation();

# ruby_lib example

# ruby_lib_core example

ScreenOrientation orientation = driver.Orientation;


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


GET /session/:session_id/orientation

URL Parameters

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

JSON Parameters



The current browser orientation {LANDSCAPE|PORTRAIT} (string)

See Also