WebScrapingAPI Docs
Proxy & InfrastructureResidential Proxies

Proxies options

Reference for Residential Proxies endpoint generator options.

Residential Proxies are configured through the proxy endpoint you give to your HTTP client. The endpoint generator builds that endpoint from the proxy options below.

Authentication

Choose how your client authenticates with the proxy network.

Username and password

Use this when you need portable credentials for servers, workers, crawlers, CI jobs, or local testing.

Endpoint format
https://username=<YOUR_PROXY_USERNAME>+country=us:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777

Whitelisted IP

Use this when requests always come from an allowlisted source IP and you do not want to send proxy credentials.

Endpoint format
us-pr.webscrapingapi.com:30001

Country

The country option controls the residential proxy location. Use it when the target website serves different content, pricing, availability, language, or access rules by country.

ValueDescription
randomUse any available country from the pool.
usUnited States
gbUnited Kingdom
deGermany
frFrance
caCanada
auAustralia
nlNetherlands

For username and password authentication, the country is added to the proxy username:

username=<YOUR_PROXY_USERNAME>+country=us

For whitelisted IP authentication, the country is added to the host:

us-pr.webscrapingapi.com:30001

Session mode

Session mode controls whether requests can receive different IPs or keep the same IP for a short workflow.

OptionDescription
RotatingOmit session and rotation. Each request can receive a different residential IP.
StickyAdd session and rotation. Requests with the same session id can keep the same residential IP for the selected rotation window.

Use rotating sessions for independent requests. Use sticky sessions for flows where the target expects continuity, such as pagination, cart flows, or session-aware pages.

Session id

session is a label that groups sticky requests together.

username=<YOUR_PROXY_USERNAME>+country=us+session=checkout-flow+rotation=600

Use a stable session id for requests that should share the same IP. Use a different session id when a workflow should start with a separate residential IP.

Rotation time

rotation controls how long a sticky session can keep the same IP. The endpoint generator currently supports these values:

ValueDescription
1803 minutes
3005 minutes
60010 minutes

The maximum sticky session duration is 10 minutes. For rotating requests, leave session and rotation out of the username.

Output format

Output format controls how the generated endpoint is copied.

OptionOutput
Host:portusername=<YOUR_PROXY_USERNAME>:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777
HTTPhttp://username=<YOUR_PROXY_USERNAME>:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777
HTTPShttps://username=<YOUR_PROXY_USERNAME>:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777
SOCKS5socks5://username=<YOUR_PROXY_USERNAME>:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777

Choose the format your HTTP client expects. Most HTTP clients accept http:// or https://. Some browser and crawler tools support socks5://.

Hosts and ports

AuthenticationHostPort
Username and passwordpr.webscrapingapi.com7777
Whitelisted IP{country}-pr.webscrapingapi.com30001

When country is set to random, the country prefix is omitted.

Generated endpoint

The generated endpoint is the final proxy value to copy into your HTTP client. It combines authentication, country, session behavior, and output format.

Example sticky HTTPS endpoint:

https://username=<YOUR_PROXY_USERNAME>+country=us+session=checkout-flow+rotation=600:<YOUR_PROXY_PASSWORD>@pr.webscrapingapi.com:7777

Example whitelisted IP endpoint:

us-pr.webscrapingapi.com:30001

For copyable examples in cURL, NodeJS, Python, PHP, Golang, Java, .NET, and Ruby, use the Endpoint generator.

On this page