Get Window Handles

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

The Get Window Handles command of the WebDriver API returns a list of all WebWindows. Each tab or window, depending on whether you are using a tabbed browser, is associated by a window handle that is used as a reference when switching to the window.

In order to determine whether or not a particular interaction with the browser opens a new window, one can obtain the set of window handles before the interaction is performed and compare it with the set after the action is performed.

Syntax

Method	URI template
`GET`	`/session/{session id}/window/handles`

URL parameters

session id: Identifier of the session.

Errors

Invalid session ID: Session does not exist.

Example

C#:

using System.Collections.ObjectModel;
using OpenQA.Selenium.Firefox;

namespace MDNWebDriverExamples
{
    class Example
    {
        public static void Main(string[] args)
        {
            FirefoxDriver session = new FirefoxDriver();

            session.ExecuteScript("window.open()");

            ReadOnlyCollection<string> currentWindowHandles = session.WindowHandles;
        }
    }
}

Specifications

Specification
WebDriver # get-window-handles

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`GetWindowHandles`	Chrome – Full support Chrome 65 (Release date: 2018-03-06) footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	Firefox – Full support Firefox 55 (Release date: 2017-08-08) footnote Full support	Opera – No support Opera footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	Safari – No support Safari footnote footnote The vendor-supported implementation for Safari is non spec-conforming and incompatible.	Chrome Android – No support Chrome Android footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – No support Opera Android footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	Safari on iOS – No support Safari on iOS footnote footnote The vendor-supported implementation for Safari on iOS is non spec-conforming and incompatible.	Samsung Internet – No support Samsung Internet footnote footnote The vendor-supported implementation for Samsung Internet is non-spec-conforming and incompatible.	WebView Android – No support WebView Android footnote footnote To enable Chromium support, include `{"goog:chromeOptions": {"w3c": true}}` in the capabilities.	WebView on iOS – No support WebView on iOS footnote footnote The vendor-supported implementation for WebView on iOS is non spec-conforming and incompatible.

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: See implementation notes.