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

  Edit this Doc Find Element

Search for an element on the page

Example Usage

MobileElement elementOne = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
MobileElement elementTwo = (MobileElement) driver.findElementByClassName("SomeClassName");

el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value="SomeAccessibilityID")

// example

// wd example
let elementOne = await driver.elementByAccessibilityId("SomeAccessibilityID");
let elementTwo = await driver.element("id", "SomeID");

# ruby_lib example
find_element(:accessibility_id, 'SomeAccessibilityID')

# ruby_lib_core example
@driver.find_element(:accessibility_id, 'SomeAccessibilityID')

AndroidElement elementOne = driver.FindElementByAccessibilityID("Some ID");
AndroidElement elementTwo = driver.FindElementByClassName("Some class");


Get the first element that matches a locator strategy


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/element

URL Parameters

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

JSON Parameters

name type description
using string The locator strategy to use
value string The search target


A JSON object for the located element (object)

See Also