For AI agents: a documentation index is available at /llms.txt
Skip to main content

Option types

AddScriptTagOptions

FieldType
contentNotRequired[str]
idNotRequired[str]
pathNotRequired[str]
typeNotRequired[str]
urlNotRequired[str]

AddStyleTagOptions

FieldType
contentNotRequired[str]
pathNotRequired[str]
urlNotRequired[str]

AuthenticateOptions

FieldType
originNotRequired[str]

CheckboxOptions

FieldType
scrollNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]

ClickOptions

FieldType
scrollNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]

ConnectOptions

FieldType
browser_ws_endpointNotRequired[str]
timeoutNotRequired[float]
tokenNotRequired[str]
transportNotRequired[object]

EvaluateOptions

FieldType
timeoutNotRequired[float]
urlNotRequired[str]

FulfillOptions

FieldType
base64_bodyNotRequired[str]
bodyNotRequired[str]
content_typeNotRequired[str]
headersNotRequired[list[HeaderInput]]
methodNotRequired[list[Method]]
operatorNotRequired[OperatorType]
regexNotRequired[list[str]]
statusNotRequired[int]
typeNotRequired[list[ResourceType]]
urlNotRequired[list[str]]

GotoOptions

FieldType
refererNotRequired[str]
referrer_policyNotRequired[str]
remote_response_metadataNotRequired[bool]
timeoutNotRequired[float]
wait_untilNotRequired[WaitUntilGoto]
wait_until_allNotRequired[list[WaitUntilGoto]]

HTMLOptions

FieldType
cleanNotRequired[CleanInput]
rewriteNotRequired[HTMLRewriteInput]
selectorNotRequired[str]
timeoutNotRequired[float]
visibleNotRequired[bool]

HoverOptions

FieldType
scrollNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]
xNotRequired[float]
yNotRequired[float]

JavaScriptEnabledOptions

FieldType
enabledNotRequired[bool]

LiveURLOptions

FieldType
compressedNotRequired[bool]
emulate_componentsNotRequired[bool]
interactableNotRequired[bool]
qualityNotRequired[int]
resizableNotRequired[bool]
show_browser_interfaceNotRequired[bool]
timeoutNotRequired[float]
typeNotRequired[LiveURLStreamType]

LoadSecretOptions

FieldType
selectorNotRequired[str]

MapSelectorOptions

FieldType
timeoutNotRequired[float]
waitNotRequired[bool]

MarkdownOptions

FieldType
selectorNotRequired[str]
timeoutNotRequired[float]
visibleNotRequired[bool]
FieldType
timeoutNotRequired[float]
wait_untilNotRequired[WaitUntilHistory]

PDFOptions

FieldType
display_header_footerNotRequired[bool]
footer_templateNotRequired[str]
formatNotRequired[PDFPageFormat]
full_pageNotRequired[bool]
generate_document_outlineNotRequired[bool]
generate_tagged_pdfNotRequired[bool]
header_templateNotRequired[str]
heightNotRequired[float | str]
landscapeNotRequired[bool]
margin_bottomNotRequired[float | str]
margin_leftNotRequired[float | str]
margin_rightNotRequired[float | str]
margin_topNotRequired[float | str]
omit_backgroundNotRequired[bool]
page_rangesNotRequired[str]
pathNotRequired[str]
prefer_css_page_sizeNotRequired[bool]
print_backgroundNotRequired[bool]
scaleNotRequired[float]
timeoutNotRequired[float]
transfer_modeNotRequired[str]
wait_for_fontsNotRequired[bool]
wait_for_imagesNotRequired[bool]
widthNotRequired[float | str]

PreferencesOptions

FieldType
timeoutNotRequired[float]

ProxyOptions

FieldType
cityNotRequired[str]
countryNotRequired[CountryCode]
methodNotRequired[list[Method]]
networkNotRequired[ProxyNetwork]
operatorNotRequired[OperatorType]
presetNotRequired[str]
serverNotRequired[str]
stateNotRequired[str]
stickyNotRequired[bool]
typeNotRequired[list[ResourceType]]
urlNotRequired[list[str]]

QuerySelectorOptions

FieldType
timeoutNotRequired[float]
visibleNotRequired[bool]

ReconnectOptions

FieldType
timeoutNotRequired[float]

RejectOptions

FieldType
enabledNotRequired[bool]
methodNotRequired[list[Method]]
operatorNotRequired[OperatorType]
regexNotRequired[list[str]]
typeNotRequired[list[ResourceType]]
urlNotRequired[list[str]]

RequestFilterOptions

FieldType
methodNotRequired[list[Method]]
operatorNotRequired[OperatorType]
timeoutNotRequired[float]
typeNotRequired[list[ResourceType]]
urlNotRequired[list[str]]
waitNotRequired[bool]

ResponseFilterOptions

FieldType
body_encodingNotRequired[bool]
methodNotRequired[list[Method]]
operatorNotRequired[OperatorType]
statusNotRequired[list[int]]
timeoutNotRequired[float]
typeNotRequired[list[ResourceType]]
urlNotRequired[list[str]]
waitNotRequired[bool]

ScreenshotOptions

FieldType
capture_beyond_viewportNotRequired[bool]
clipNotRequired[ScreenshotClip]
from_surfaceNotRequired[bool]
full_pageNotRequired[bool]
omit_backgroundNotRequired[bool]
optimize_for_speedNotRequired[bool]
pathNotRequired[str]
qualityNotRequired[float]
selectorNotRequired[str]
timeoutNotRequired[float]
typeNotRequired[ScreenshotType]
wait_for_imagesNotRequired[bool]

ScrollOptions

FieldType
selectorNotRequired[str]
through_pageNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]
xNotRequired[float]
yNotRequired[float]

SelectOptions

FieldType
scrollNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]

SendOptions

FieldType
timeoutNotRequired[float]
variablesNotRequired[dict[str, object]]

SetContentOptions

FieldType
timeoutNotRequired[float]
wait_untilNotRequired[WaitUntilHistory]
wait_until_allNotRequired[list[WaitUntilHistory]]

SetCookieOptions

FieldType
cookiesNotRequired[list[CookieInput]]

SetExtraHTTPHeadersOptions

FieldType
headersNotRequired[list[HeaderInput]]

SolveImageCaptchaOptions

FieldType
captcha_selectorRequired[str]
input_selectorRequired[str]
timeoutNotRequired[float]

SolveOptions

FieldType
timeoutNotRequired[float]
typeNotRequired[CaptchaType]
waitNotRequired[bool]

SwitchToWindowOptions

FieldType
newestNotRequired[bool]
timeoutNotRequired[float]
titleNotRequired[str]
urlNotRequired[str]
wait_untilNotRequired[WaitUntilGoto]

TextOptions

FieldType
cleanNotRequired[CleanInput]
selectorNotRequired[str]
timeoutNotRequired[float]
visibleNotRequired[bool]

TypeOptions

FieldType
delayNotRequired[list[int]]
interactableNotRequired[bool]
scrollNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]
waitNotRequired[bool]

ViewportOptions

FieldType
device_scale_factorNotRequired[float]
has_touchNotRequired[bool]
heightRequired[float]
landscapeNotRequired[bool]
mobileNotRequired[bool]
widthRequired[float]

WaitForEventOptions

FieldType
timeoutNotRequired[float]

WaitForFunctionOptions

FieldType
complete_on_promise_resolutionNotRequired[bool]
pollingNotRequired[float]
polling_typeNotRequired[WaitForFunctionPolling]
timeoutNotRequired[float]

WaitForNavigationOptions

FieldType
timeoutNotRequired[float]
wait_untilNotRequired[WaitUntilGoto]

WaitForNetworkIdleOptions

FieldType
concurrencyNotRequired[int]
idle_timeNotRequired[float]
timeoutNotRequired[float]

WaitForRequestOptions

FieldType
methodNotRequired[Method]
operatorNotRequired[OperatorType]
timeoutNotRequired[float]
urlNotRequired[str]

WaitForResponseOptions

FieldType
codesNotRequired[list[int]]
operatorNotRequired[OperatorType]
statusesNotRequired[list[int]]
timeoutNotRequired[float]
urlNotRequired[str]

WaitForSelectorOptions

FieldType
hiddenNotRequired[bool]
timeoutNotRequired[float]
visibleNotRequired[bool]