Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.driver.dev/llms.txt

Use this file to discover all available pages before exploring further.

Route your browser session traffic through a custom SOCKS5 proxy.

​
Using a Proxy

Pass a SOCKS5 proxy URL when creating a session: 
const session = await client.browser.session.create({
  proxyUrl: "socks5://user:[email protected]:1080",
});

​
Proxy URL Format

socks5://username:password@host:port
ComponentRequiredDescription
socks5://YesProtocol (only SOCKS5 supported)
username:password@NoAuthentication credentials
hostYesProxy server hostname or IP
portYesProxy server port

​
Examples

// Without authentication
proxyUrl: "socks5://proxy.example.com:1080";

// With authentication
proxyUrl: "socks5://myuser:[email protected]:1080";

// With IP address
proxyUrl: "socks5://user:[email protected]:1080";

​
Notes

  • Only SOCKS5 proxies are supported
  • HTTP/HTTPS proxies are not supported
  • UDP enabled proxies are greatly encouraged
  • Proxy must be accessible from Driver infrastructure
  • Proxy errors will cause the session to fail
Ensure your proxy server allows connections from Driver.