name: Appium
description: Appium is an open-source test automation framework governed by the OpenJS Foundation, designed
  to facilitate UI automation of many app platforms including mobile (iOS, Android), browser (Chrome,
  Firefox, Safari), desktop (macOS, Windows), and TV (Roku, tvOS, Android TV). It implements the W3C WebDriver
  protocol and provides an extensible ecosystem of drivers, clients, and plugins.
deliveryModel:
  model: self-hosted
  license: Apache-2.0
  open_source: true
  commercial: false
  callable_host: false
  label: Self-hosted open source · you run it yourself
  confidence: high
  source:
  - license
  - openapi
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: free
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Free
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
image: https://appium.io/docs/en/latest/assets/images/appium-logo.png
created: '2024-01-15'
modified: '2026-09-16'
specificationVersion: '0.23'
url: https://appium.io/apis.json
apis:
- name: Appium Inspector
  description: Standalone GUI inspector for mobile apps that communicates with an Appium server, enabling
    visual element inspection and XPath generation for test authoring.
  humanURL: https://github.com/appium/appium-inspector
  baseURL: https://github.com/appium/appium-inspector/releases
  tags:
  - Debugging
  - GUI
  - Inspector
  - Mobile Testing
  properties:
  - type: GitHubRepository
    url: https://github.com/appium/appium-inspector
  - type: SDKs
    url: https://github.com/appium/appium-inspector/releases
    title: Desktop App Downloads
- name: Appium UiAutomator2 Driver
  description: The primary Appium driver for Android automation, backed by Google's UiAutomator2 framework.
    Supports Android 5.0+ devices and emulators.
  humanURL: https://github.com/appium/appium-uiautomator2-driver
  baseURL: http://localhost:4723
  tags:
  - Android
  - Automation
  - Driver
  - Mobile Testing
  properties:
  - type: GitHubRepository
    url: https://github.com/appium/appium-uiautomator2-driver
  - type: Documentation
    url: https://github.com/appium/appium-uiautomator2-driver#readme
- name: Appium XCUITest Driver
  description: The primary Appium driver for iOS and tvOS automation, backed by Apple's XCTest framework.
    Supports iOS 12+ and macOS Sequoia.
  humanURL: https://github.com/appium/appium-xcuitest-driver
  baseURL: http://localhost:4723
  tags:
  - Automation
  - Driver
  - iOS
  - Mobile Testing
  - tvOS
  properties:
  - type: GitHubRepository
    url: https://github.com/appium/appium-xcuitest-driver
  - type: Documentation
    url: https://github.com/appium/appium-xcuitest-driver#readme
- aid: appium:appium-actions-api
  name: Appium Actions API
  description: W3C Actions API for complex input sequences
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Actions
  properties:
  - type: OpenAPI
    url: openapi/appium-actions-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-alerts-api
  name: Appium Alerts API
  description: Dialog and alert handling
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Alerts
  properties:
  - type: OpenAPI
    url: openapi/appium-alerts-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-appium-device-api
  name: Appium Device API
  description: Appium-specific device commands (app management, files, keyboard)
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Appium Device
  properties:
  - type: OpenAPI
    url: openapi/appium-appium-device-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-appium-session-api
  name: Appium Session API
  description: Appium session settings and capabilities
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Appium Session
  properties:
  - type: OpenAPI
    url: openapi/appium-appium-session-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-cookies-api
  name: Appium Cookies API
  description: Cookie management
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Cookies
  properties:
  - type: OpenAPI
    url: openapi/appium-cookies-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-elements-api
  name: Appium Elements API
  description: Element discovery and interaction
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Elements
  properties:
  - type: OpenAPI
    url: openapi/appium-elements-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-navigation-api
  name: Appium Navigation API
  description: Browser and app navigation commands
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Navigation
  properties:
  - type: OpenAPI
    url: openapi/appium-navigation-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-screenshots-api
  name: Appium Screenshots API
  description: Screenshot capture
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Screenshots
  properties:
  - type: OpenAPI
    url: openapi/appium-screenshots-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-server-api
  name: Appium Server API
  description: Server status and session listing
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Servers
  tags_raw:
  - Server
  properties:
  - type: OpenAPI
    url: openapi/appium-server-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
- aid: appium:appium-sessions-api
  name: Appium Sessions API
  description: WebDriver session lifecycle management
  humanURL: https://appium.io/
  baseURL: http://localhost:4723
  tags:
  - Sessions
  properties:
  - type: OpenAPI
    url: openapi/appium-sessions-api-openapi.yml
  - type: Documentation
    url: https://appium.io/docs/en/latest/
  - type: GitHubRepository
    url: https://github.com/appium/appium
  - type: APIReference
    url: https://appium.io/docs/en/latest/reference/
  - type: JSONSchema
    url: json-schema/appium-server-session-info-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-find-element-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-app-id-request-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-action-sequence-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-cookie-schema.json
  - type: JSONSchema
    url: json-schema/appium-server-error-response-schema.json
maintainers:
- FN: Appium Contributors
  email: appium@googlegroups.com
  url: https://github.com/appium/appium/graphs/contributors
tags:
- Appium
- Android
- Cross-Platform
- iOS
- Mobile Testing
- Open Source
- OpenJS Foundation
- Test Automation
- WebDriver
- Testing
tags_raw:
- Appium
- Android
- Cross-Platform
- iOS
- Mobile Testing
- Open Source
- OpenJS Foundation
- Test Automation
- WebDriver
- Open-Source
- Testing
common:
- type: Plans
  url: plans/appium-plans-pricing.yml
- type: RateLimits
  url: rate-limits/appium-rate-limits.yml
- type: FinOps
  url: finops/appium-finops.yml
- type: Website
  url: https://appium.io
- type: IssueTracker
  url: https://github.com/appium/appium-inspector/issues
- type: CodeOfConduct
  url: https://github.com/appium/.github/blob/master/CODE_OF_CONDUCT.md
- type: ContributionGuide
  url: https://github.com/appium/appium-inspector/blob/main/docs/contributing.md
- type: License
  name: Apache-2.0
  url: https://github.com/appium/appium-inspector/blob/main/LICENSE
- type: AgenticAccess
  url: agentic-access/appium-agentic-access.yml
- type: DomainSecurity
  url: security/appium-domain-security.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/appium
- type: GettingStarted
  url: https://appium.io/docs/en/latest/quickstart/
- type: GitHubOrganization
  url: https://github.com/appium
- type: Documentation
  url: https://appium.io/docs/en/latest/
- type: Support
  url: https://discuss.appium.io/
- type: Slack
  url: http://appium.slack.com
- type: StackOverflow
  url: https://stackoverflow.com/questions/tagged/appium
- type: YouTube
  url: https://www.youtube.com/c/AppiumConf
- type: ChangeLog
  url: https://github.com/appium/appium/blob/master/CHANGELOG.md
- type: SDKs
  url: https://github.com/appium/python-client
  title: Python Client
- type: SDKs
  url: https://github.com/appium/java-client
  title: Java Client
- type: SDKs
  url: https://github.com/appium/ruby_lib_core
  title: Ruby Client
- type: SDKs
  url: https://github.com/appium/dotnet-client
  title: .NET Client
- type: Tools
  url: https://github.com/appium/appium-mcp
  title: MCP Server
- type: SpectralRules
  url: rules/appium-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/appium-vocabulary.yaml
- type: Features
  data:
  - name: Multi-Platform Support
    description: Automate iOS, Android, Windows, macOS, web browsers, and TV platforms from a single framework
  - name: WebDriver Protocol
    description: Implements the W3C WebDriver protocol for standard, cross-platform automation
  - name: Extensible Driver Architecture
    description: Plugin-based driver system supports any platform through community and official drivers
  - name: Multiple Language Clients
    description: Official client libraries for Python, Java, JavaScript, Ruby, .NET, and more
  - name: WebDriver BiDi Support
    description: Supports the next-generation WebDriver BiDi bidirectional protocol
  - name: MCP Server
    description: Model Context Protocol server for AI-assisted test automation
  - name: Inspector GUI
    description: Visual app inspector for element discovery and XPath/accessibility ID generation
- type: UseCases
  data:
  - name: Mobile App Testing
    description: Automated functional and regression testing of iOS and Android native apps
  - name: Cross-Platform Test Suites
    description: Single test codebase targeting multiple platforms and devices
  - name: CI/CD Integration
    description: Running automated mobile tests in continuous integration pipelines
  - name: Web Automation
    description: Browser automation on mobile and desktop via WebDriver
  - name: AI-Assisted Testing
    description: Using the MCP server to enable AI agents to drive test execution
- type: Integrations
  data:
  - name: BrowserStack
    description: Cloud device farm integration for running Appium tests on real devices
  - name: Sauce Labs
    description: Cloud testing platform with Appium support for real and virtual devices
  - name: LambdaTest
    description: Cloud test execution platform with Appium integration
  - name: TestNG
    description: Java testing framework commonly used with Appium Java client
  - name: pytest
    description: Python testing framework used with the Appium Python client
  - name: WebdriverIO
    description: JavaScript test automation framework with built-in Appium support
  - name: Selenium Grid
    description: Distributed test execution grid compatible with Appium sessions
- name: MCP Server
  url: https://github.com/appium/appium-mcp
  type: MCPServer
- name: Agent Skills
  url: https://github.com/appium/skills
  type: AgentSkills