Option types
AddScriptTagOptions
| Field | Type |
|---|---|
content | NotRequired[str] |
id | NotRequired[str] |
path | NotRequired[str] |
type | NotRequired[str] |
url | NotRequired[str] |
AddStyleTagOptions
| Field | Type |
|---|---|
content | NotRequired[str] |
path | NotRequired[str] |
url | NotRequired[str] |
AuthenticateOptions
| Field | Type |
|---|---|
origin | NotRequired[str] |
CheckboxOptions
| Field | Type |
|---|---|
scroll | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
ClickOptions
| Field | Type |
|---|---|
scroll | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
ConnectOptions
| Field | Type |
|---|---|
browser_ws_endpoint | NotRequired[str] |
timeout | NotRequired[float] |
token | NotRequired[str] |
transport | NotRequired[object] |
EvaluateOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
url | NotRequired[str] |
FulfillOptions
| Field | Type |
|---|---|
base64_body | NotRequired[str] |
body | NotRequired[str] |
content_type | NotRequired[str] |
headers | NotRequired[list[HeaderInput]] |
method | NotRequired[list[Method]] |
operator | NotRequired[OperatorType] |
regex | NotRequired[list[str]] |
status | NotRequired[int] |
type | NotRequired[list[ResourceType]] |
url | NotRequired[list[str]] |
GotoOptions
| Field | Type |
|---|---|
referer | NotRequired[str] |
referrer_policy | NotRequired[str] |
remote_response_metadata | NotRequired[bool] |
timeout | NotRequired[float] |
wait_until | NotRequired[WaitUntilGoto] |
wait_until_all | NotRequired[list[WaitUntilGoto]] |
HTMLOptions
| Field | Type |
|---|---|
clean | NotRequired[CleanInput] |
rewrite | NotRequired[HTMLRewriteInput] |
selector | NotRequired[str] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
HoverOptions
| Field | Type |
|---|---|
scroll | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
x | NotRequired[float] |
y | NotRequired[float] |
JavaScriptEnabledOptions
| Field | Type |
|---|---|
enabled | NotRequired[bool] |
LiveURLOptions
| Field | Type |
|---|---|
compressed | NotRequired[bool] |
emulate_components | NotRequired[bool] |
interactable | NotRequired[bool] |
quality | NotRequired[int] |
resizable | NotRequired[bool] |
show_browser_interface | NotRequired[bool] |
timeout | NotRequired[float] |
type | NotRequired[LiveURLStreamType] |
LoadSecretOptions
| Field | Type |
|---|---|
selector | NotRequired[str] |
MapSelectorOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
wait | NotRequired[bool] |
MarkdownOptions
| Field | Type |
|---|---|
selector | NotRequired[str] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
NavigationOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
wait_until | NotRequired[WaitUntilHistory] |
PDFOptions
| Field | Type |
|---|---|
display_header_footer | NotRequired[bool] |
footer_template | NotRequired[str] |
format | NotRequired[PDFPageFormat] |
full_page | NotRequired[bool] |
generate_document_outline | NotRequired[bool] |
generate_tagged_pdf | NotRequired[bool] |
header_template | NotRequired[str] |
height | NotRequired[float | str] |
landscape | NotRequired[bool] |
margin_bottom | NotRequired[float | str] |
margin_left | NotRequired[float | str] |
margin_right | NotRequired[float | str] |
margin_top | NotRequired[float | str] |
omit_background | NotRequired[bool] |
page_ranges | NotRequired[str] |
path | NotRequired[str] |
prefer_css_page_size | NotRequired[bool] |
print_background | NotRequired[bool] |
scale | NotRequired[float] |
timeout | NotRequired[float] |
transfer_mode | NotRequired[str] |
wait_for_fonts | NotRequired[bool] |
wait_for_images | NotRequired[bool] |
width | NotRequired[float | str] |
PreferencesOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
ProxyOptions
| Field | Type |
|---|---|
city | NotRequired[str] |
country | NotRequired[CountryCode] |
method | NotRequired[list[Method]] |
network | NotRequired[ProxyNetwork] |
operator | NotRequired[OperatorType] |
preset | NotRequired[str] |
server | NotRequired[str] |
state | NotRequired[str] |
sticky | NotRequired[bool] |
type | NotRequired[list[ResourceType]] |
url | NotRequired[list[str]] |
QuerySelectorOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
visible | NotRequired[bool] |
ReconnectOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
RejectOptions
| Field | Type |
|---|---|
enabled | NotRequired[bool] |
method | NotRequired[list[Method]] |
operator | NotRequired[OperatorType] |
regex | NotRequired[list[str]] |
type | NotRequired[list[ResourceType]] |
url | NotRequired[list[str]] |
RequestFilterOptions
| Field | Type |
|---|---|
method | NotRequired[list[Method]] |
operator | NotRequired[OperatorType] |
timeout | NotRequired[float] |
type | NotRequired[list[ResourceType]] |
url | NotRequired[list[str]] |
wait | NotRequired[bool] |
ResponseFilterOptions
| Field | Type |
|---|---|
body_encoding | NotRequired[bool] |
method | NotRequired[list[Method]] |
operator | NotRequired[OperatorType] |
status | NotRequired[list[int]] |
timeout | NotRequired[float] |
type | NotRequired[list[ResourceType]] |
url | NotRequired[list[str]] |
wait | NotRequired[bool] |
ScreenshotOptions
| Field | Type |
|---|---|
capture_beyond_viewport | NotRequired[bool] |
clip | NotRequired[ScreenshotClip] |
from_surface | NotRequired[bool] |
full_page | NotRequired[bool] |
omit_background | NotRequired[bool] |
optimize_for_speed | NotRequired[bool] |
path | NotRequired[str] |
quality | NotRequired[float] |
selector | NotRequired[str] |
timeout | NotRequired[float] |
type | NotRequired[ScreenshotType] |
wait_for_images | NotRequired[bool] |
ScrollOptions
| Field | Type |
|---|---|
selector | NotRequired[str] |
through_page | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
x | NotRequired[float] |
y | NotRequired[float] |
SelectOptions
| Field | Type |
|---|---|
scroll | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
SendOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
variables | NotRequired[dict[str, object]] |
SetContentOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
wait_until | NotRequired[WaitUntilHistory] |
wait_until_all | NotRequired[list[WaitUntilHistory]] |
SetCookieOptions
| Field | Type |
|---|---|
cookies | NotRequired[list[CookieInput]] |
SetExtraHTTPHeadersOptions
| Field | Type |
|---|---|
headers | NotRequired[list[HeaderInput]] |
SolveImageCaptchaOptions
| Field | Type |
|---|---|
captcha_selector | Required[str] |
input_selector | Required[str] |
timeout | NotRequired[float] |
SolveOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
type | NotRequired[CaptchaType] |
wait | NotRequired[bool] |
SwitchToWindowOptions
| Field | Type |
|---|---|
newest | NotRequired[bool] |
timeout | NotRequired[float] |
title | NotRequired[str] |
url | NotRequired[str] |
wait_until | NotRequired[WaitUntilGoto] |
TextOptions
| Field | Type |
|---|---|
clean | NotRequired[CleanInput] |
selector | NotRequired[str] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
TypeOptions
| Field | Type |
|---|---|
delay | NotRequired[list[int]] |
interactable | NotRequired[bool] |
scroll | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |
wait | NotRequired[bool] |
ViewportOptions
| Field | Type |
|---|---|
device_scale_factor | NotRequired[float] |
has_touch | NotRequired[bool] |
height | Required[float] |
landscape | NotRequired[bool] |
mobile | NotRequired[bool] |
width | Required[float] |
WaitForEventOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
WaitForFunctionOptions
| Field | Type |
|---|---|
complete_on_promise_resolution | NotRequired[bool] |
polling | NotRequired[float] |
polling_type | NotRequired[WaitForFunctionPolling] |
timeout | NotRequired[float] |
WaitForNavigationOptions
| Field | Type |
|---|---|
timeout | NotRequired[float] |
wait_until | NotRequired[WaitUntilGoto] |
WaitForNetworkIdleOptions
| Field | Type |
|---|---|
concurrency | NotRequired[int] |
idle_time | NotRequired[float] |
timeout | NotRequired[float] |
WaitForRequestOptions
| Field | Type |
|---|---|
method | NotRequired[Method] |
operator | NotRequired[OperatorType] |
timeout | NotRequired[float] |
url | NotRequired[str] |
WaitForResponseOptions
| Field | Type |
|---|---|
codes | NotRequired[list[int]] |
operator | NotRequired[OperatorType] |
statuses | NotRequired[list[int]] |
timeout | NotRequired[float] |
url | NotRequired[str] |
WaitForSelectorOptions
| Field | Type |
|---|---|
hidden | NotRequired[bool] |
timeout | NotRequired[float] |
visible | NotRequired[bool] |