BiDirectional API (W3C compliant) Examples of working with Chrome DevTools Protocol in Selenium. CDP support is temporary until WebDriver BiDi has been implemented.
The following list of APIs will be growing as the WebDriver BiDirectional Protocol grows
and browser vendors implement the same.
Additionally, Selenium will try to support real-world use cases that internally use a combination of W3C BiDi protocol APIs.
If there is additional functionality you’d like to see, please raise a
feature request .
1 - Browsing Context Commands This section contains the APIs related to browsing context commands.
Open a new window Creates a new browsing context in a new window.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Open a new tab Creates a new browsing context in a new tab.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Use existing window handle Creates a browsing context for the existing tab/window to run commands.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Open a window with a reference browsing context A reference browsing context is a top-level browsing context .
The API allows to pass the reference browsing context, which is used to create a new window. The implementation is operating system specific.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Open a tab with a reference browsing context A reference browsing context is a top-level browsing context .
The API allows to pass the reference browsing context, which is used to create a new tab. The implementation is operating system specific.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Navigate to a URL
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Navigate to a URL with readiness state
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Get browsing context tree Provides a tree of all browsing contexts descending from the parent browsing context, including the parent browsing context.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Get browsing context tree with depth Provides a tree of all browsing contexts descending from the parent browsing context, including the parent browsing context upto the depth value passed.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Get All Top level browsing contexts
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.20.0
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Close a tab/window
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.8
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Activate a browsing context
Java
Ruby
JavaScript
Kotlin Selenium v4.14.1
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Reload a browsing context
Java
Ruby
JavaScript
Kotlin Selenium v4.13.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Handle user prompt
Java
Ruby
JavaScript
Kotlin Selenium v4.13.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Capture Screenshot
Java
Ruby
JavaScript
Kotlin Selenium v4.13.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Capture Viewport Screenshot
Java
Ruby
JavaScript
Kotlin Selenium v4.14.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Capture Element Screenshot
Java
Ruby
JavaScript
Kotlin Selenium v4.14.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Set Viewport
Java
Ruby
JavaScript
Kotlin Selenium v4.14.1
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.15
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Print page
Java
Ruby
JavaScript
Kotlin Selenium v4.14.1
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.10
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Navigate back
Java
Ruby
JavaScript
Kotlin Selenium v4.16.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.17
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Navigate forward
Java
Ruby
JavaScript
Kotlin Selenium v4.16.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.17
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Traverse history
Java
Ruby
JavaScript
Kotlin Selenium v4.16.0
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextTest.java
Copy
Close
Selenium v4.17
/examples/javascript/test/bidirectional/browsingContext.spec.js
Copy
Close
Events This section contains the APIs related to browsing context events.
Browsing Context Created Event
Java
Ruby
JavaScript
Kotlin Selenium v4.10
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Selenium v4.9.2
/examples/javascript/test/bidirectional/browsingContextInspector.spec.js
Copy
Close
Dom Content loaded Event
Java
Ruby
JavaScript
Kotlin Selenium v4.10
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Selenium v4.9.2
/examples/javascript/test/bidirectional/browsingContextInspector.spec.js
Copy
Close
Browsing Context Loaded Event
Java
Ruby
JavaScript
Kotlin Selenium v4.10
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Selenium v4.9.2
/examples/javascript/test/bidirectional/browsingContextInspector.spec.js
Copy
Close
Navigated Started Event
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Fragment Navigated Event
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Selenium v4.15.0
/examples/javascript/test/bidirectional/browsingContextInspector.spec.js
Copy
Close
User Prompt Opened Event
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
User Prompt Closed Event
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Browsing Context Destroyed Event
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/BrowsingContextInspectorTest.java
Copy
Close
Selenium v4.18.0
/examples/javascript/test/bidirectional/browsingContextInspector.spec.js
Copy
Close
2 - Input This section contains the APIs related to input commands.
Java
Ruby
JavaScript
Kotlin Selenium v4.17
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ActionsTest.java
Copy
Close
Selenium v4.17
/examples/javascript/test/bidirectional/input.spec.js
Copy
Close
Release Actions
Java
Ruby
JavaScript
Kotlin Selenium v4.17
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ActionsTest.java
Copy
Close
Selenium v4.17
/examples/javascript/test/bidirectional/input.spec.js
Copy
Close
3 - Log This section contains the APIs related to logging.
Console logs Listen to the console.log events and register callbacks to process the event.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/LogTest.java
Copy
Close
/examples/javascript/test/bidirectional/logInspector.spec.js
Copy
Close
JavaScript exceptions Listen to the JS Exceptions
and register callbacks to process the exception details.
Java
Ruby
JavaScript
Kotlin /examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/LogTest.java
Copy
Close
/examples/javascript/test/bidirectional/logInspector.spec.js
Copy
Close
Listen to JS Logs Listen to all JS logs at all levels and register callbacks to process the log.
Java
Ruby
JavaScript
Kotlin Selenium v4.8
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/LogTest.java
Copy
Close
4 - Network Commands This section contains the APIs related to network commands.
Add network intercept
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_commands.spec.js
Copy
Close
Remove network intercept
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_commands.spec.js
Copy
Close
Continue request blocked at authRequired phase with credentials
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_commands.spec.js
Copy
Close
Continue request blocked at authRequired phase without credentials
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_commands.spec.js
Copy
Close
Cancel request blocked at authRequired phase
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_commands.spec.js
Copy
Close
Fail request
Java
Ruby
JavaScript
Kotlin Selenium v4.18
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkCommandsTest.java
Copy
Close
Events This section contains the APIs related to network events.
Before Request Sent
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkEventsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_events.spec.js
Copy
Close
Response Started
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkEventsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_events.spec.js
Copy
Close
Response Completed
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkEventsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/network_events.spec.js
Copy
Close
Auth Required
Java
Ruby
JavaScript
Kotlin Selenium v4.17
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/NetworkEventsTest.java
Copy
Close
5 - Script Commands This section contains the APIs related to script commands.
Call function in a browsing context
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Call function in a sandbox
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Call function in a realm
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Evaluate script in a browsing context
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Evaluate script in a sandbox
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Evaluate script in a realm
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Disown handles in a browsing context
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Disown handles in a realm
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Get all realms
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Get realm by type
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Get browsing context realms
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Get browsing context realms by type
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.9
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Preload a script
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.10
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Remove a preloaded script
Java
Ruby
JavaScript
Kotlin Selenium v4.15
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptTest.java
Copy
Close
Selenium v4.10
/examples/javascript/test/bidirectional/script_commands.spec.js
Copy
Close
Events This section contains the APIs related to script events.
Message
Java
Ruby
JavaScript
Kotlin Selenium v4.16
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptEventsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/script_events.spec.js
Copy
Close
Realm Created
Java
Ruby
JavaScript
Kotlin Selenium v4.16
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptEventsTest.java
Copy
Close
Selenium v4.18
/examples/javascript/test/bidirectional/script_events.spec.js
Copy
Close
Realm Destroyed
Java
Ruby
JavaScript
Kotlin Selenium v4.16
/examples/java/src/test/java/dev/selenium/bidirectional/webdriver_bidi/ScriptEventsTest.java
Copy
Close
Selenium v4.19
/examples/javascript/test/bidirectional/script_events.spec.js
Copy
Close
