ProxyOptions
Properties
| Property | Type | Description |
|---|---|---|
city? | string | The city you wish to proxy through. Any spaces should be removed and all casing lowercase. For instance, "New York City" should be "newyorkcity" |
country? | CountryCode | The country you wish to proxy through. Only allowed when using the browserless.io proxy and no server argument. |
method? | Method[] | The Method(s) of the request you'd like to proxy |
network? | ProxyNetwork | The Browserless proxy network to route matching requests through: residential or datacenter. Omit to retain the session's network, or use residential when activating a new proxy. Only valid for the browserless.io proxy network (not with server). |
operator? | OperatorType | Whether to "or" conditions together, meaning any condition that matches will be proxied, or "and" them together meaning every condition must match to proxy the request. Default or |
preset? | string | A preset code for website-specific proxy configurations. Use this with known presets like "px_gov01" for government websites. Only applies to the residential network; the datacenter pool ignores it |
server? | string | An external proxy to use for these requests matching the specified patterns set in the other arguments. When this is set then country, city, state and sticky options will throw errors as these are only valid for the browserless.io proxy network |
state? | string | The state or provence you wish to proxy through. Any spaces should be removed and all casing lowercase. For instance, "Rhode Island" would be "rhodeisland" and "New Brunswick" would be "newbrunswick" |
sticky? | boolean | Whether the same exit IP is held for subsequent requests matching the pattern. Sticky is ON by default for stealth and BQL sessions (Akamai and DataDome tie their sensor/cookie to the egress IP, so a mid-session IP change re-triggers the block); pass sticky: false to use a rotating exit IP instead. |
type? | ResourceType[] | The content-type of the request you'd like to proxy requests to |
url? | string[] | A glob-style URL pattern to match requests, and if matched, are proxied through |
Was this page helpful?