Documentation / Proxy Support

Proxy Support

WebPeel supports HTTP, HTTPS, and SOCKS5 proxies for accessing geo-restricted or IP-blocked content. Route requests through any standard proxy — including authenticated proxies and automatic rotation with failover.

🌍 Already built-in. Proxy support is available now in the CLI and API — no extra setup required. Pass --proxy or --proxies and WebPeel handles the rest.

CLI Usage

HTTP Proxy

webpeel "https://example.com" --proxy http://proxy.example.com:8080

Authenticated Proxy

webpeel "https://example.com" --proxy http://user:pass@proxy.example.com:8080

SOCKS5 Proxy

webpeel "https://example.com" --proxy socks5://user:pass@proxy.example.com:1080

Proxy Rotation (Automatic Failover)

Pass multiple proxies as a comma-separated list. WebPeel tries them in order and automatically fails over to the next proxy if one fails.

webpeel "https://example.com" \
  --proxies "http://proxy1:8080,http://proxy2:8080,socks5://proxy3:1080"

API Usage

Pass a proxy parameter in the request body to route that specific fetch through a proxy.

POST https://api.webpeel.dev/v1/fetch
Authorization: Bearer wp_live_xxxx
Content-Type: application/json

{
  "url": "https://example.com",
  "proxy": "http://proxy.example.com:8080"
}

curl Example

curl -X POST "https://api.webpeel.dev/v1/fetch" \
  -H "Authorization: Bearer wp_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://geo-restricted-site.com",
    "proxy": "http://user:pass@proxy.example.com:8080",
    "render": true
  }'

Environment Variables

Set a default proxy for all requests using standard environment variables:

# HTTP proxy (used for http:// URLs)
export HTTP_PROXY=http://proxy.example.com:8080

# HTTPS proxy (used for https:// URLs — most common)
export HTTPS_PROXY=http://proxy.example.com:8080

# No proxy for specific domains
export NO_PROXY=localhost,127.0.0.1,internal.example.com

When set, these variables apply to all WebPeel requests automatically. An explicit --proxy flag overrides the environment variable.

CLI Parameters Reference

FlagDescription
--proxy <url>Single proxy URL. Supports http://, https://, and socks5:// schemes.
--proxies <urls>Comma-separated list of proxies. Tried in order; automatically fails over to the next on error.

Supported Proxy Formats

FormatExample
HTTP proxyhttp://proxy.example.com:8080
HTTPS proxyhttps://proxy.example.com:8080
SOCKS5 proxysocks5://proxy.example.com:1080
Authenticated HTTPhttp://user:pass@proxy.example.com:8080
Authenticated SOCKS5socks5://user:pass@proxy.example.com:1080

Supported Proxy Providers

WebPeel works with any standard proxy. Popular options:

Related