How to use proxies with OkHttp

Which proxy to use

For most scraping, Residential Lite is the cheapest way to get home IP addresses in the right country. Use Residential when you need a particular state or city, and Unlimited Datacenter for targets in the United States that do not block data centre addresses.

• Residentialfrom $2.64 per GB
• Residential Litefrom $0.69 per GB
• Unlimited Datacenterfrom $0.24 per hour

What to enter

A PiratProxies plan gives you four things: a host, a port, a username and a password. These are the values for Residential; the username and password are on your plan page.

The country and the session are chosen in the username, not in a separate setting. The generator on your plan page writes the username for you, and Targeting and sessions explains each part.

Steps

1. Create a Proxy with the host and port.
2. Add a proxyAuthenticator that answers with the username and password.

Example

Java

Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("resi.piratproxies.com", 8080));
Authenticator proxyAuth = (route, response) -> response.request().newBuilder()
        .header("Proxy-Authorization", Credentials.basic("USERNAME", "PASSWORD"))
        .build();

OkHttpClient client = new OkHttpClient.Builder().proxy(proxy).proxyAuthenticator(proxyAuth).build();
try (Response res = client.newCall(new Request.Builder().url("https://api.ipify.org").build()).execute()) {
    System.out.println(res.body().string());
}

Replace USERNAME and PASSWORD with the login from your plan page. The example asks an IP-check address, so the output is the address your request left from.

Rotating or sticky

For crawling many pages with OkHttp, leave the username without a session so every request leaves from a new IP address. For anything with steps that belong together, such as a login, a cart or a paginated search that sets cookies, add a session to the username so those requests share one address.

A sticky username looks like this:

USERNAME-country-us-time-600-session-a1b2c3d4

If it does not work

• Use proxyAuthenticator, not authenticator. The second one answers the website, not the proxy.
• A 407 error means the username or password was not accepted. Copy both again from your plan page, and check that nothing added a space or cut the username short.
• If the IP address is in the wrong country, look at the username: the country code is part of it. More fixes.

Questions

OkHttp is a product of its own makers. PiratProxies is not affiliated with it; the name is used here only to say what this guide is about. Use it within the rules of the sites you work with and our acceptable use policy.