Find Element

Search for an element on the page

Example Usage

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

# Python
el = self.driver.find_element_by_accessibility_id('SomeAccessibilityID')

// Javascript
// webdriver.io example
driver.element("~SomeAccessibilityId");



[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml)
// wd example
let elementOne = await driver.elementByAccessibilityId("SomeAccessibilityID");
let elementTwo = await driver.element("id", "SomeID");

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


[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml)
# ruby_lib_core example
@driver.find_element(:accessibility_id, 'SomeAccessibilityID')

# PHP
$el = $this->byAccessibilityId('SomeAccessibilityID');

// C#
// TODO C# sample

Description

Get the first element that matches a locator strategy

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 /wd/hub/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

Response

A JSON object for the located element (object)

See Also