Skip to content

API Reference

This section documents the public classes you work with directly. The guides teach how to use them; this reference specifies what each one exposes. Every page links back to the guide that covers it.

Browser

Class What it does Guide
Chrome Launch and control a Chrome browser Getting started
Edge Launch and control a Microsoft Edge browser Getting started
ChromiumOptions Configure the browser before launch Browser options
Tab Drive a tab: navigate, find, input, events, network Core concepts
Request Make HTTP requests inside the browser session HTTP requests

Elements

Class What it does Guide
WebElement Interact with a located element Element finding
ShadowRoot Query inside a shadow root DOM traversal

Extraction and connection

Class What it does Guide
ExtractionModel, Field Map the DOM into typed, validated objects Structured extraction
ConnectionHandler Manage the CDP WebSocket connection Remote connections

Core

Reference What it holds Guide
Constants Enums like By, Key, and PermissionType Selectors
Exceptions Errors Pydoll raises, like ElementNotFound Element finding

Every Pydoll operation is fully typed and comes in two forms: import from pydoll.sync to block on each call, or from the modules below to await it. The reference documents the async form; the sync classes have the same names, methods, arguments, and defaults. See Async Python for the async/await basics.