Documentation

Integration preview

Connect to Helix Residential Proxies.

A single gateway, structured credentials, predictable behavior. Final endpoint and credentials will be shown inside the authenticated Helix dashboard after provisioning.

Authentication

Every request authenticates with a username and password issued to your account. Credentials appear inside the Helix dashboard once your plan is provisioned.

Note: proxy credentials and the Helix management API are separate concepts. Do not refer to the proxy connection itself as an "API key."

Proxy format

Helix uses a single residential gateway. All routing options are encoded inside the password portion of the credential string.

text
text
HOST:PORT:USERNAME:PASSWORD
Basic password
text
PASSWORD
Country-targeted password
text
PASSWORD_country-us
Sticky US session
text
PASSWORD_country-us_session-a1b2c3d4_lifetime-30m

The residential routing configuration belongs in the password portion of the credential string, not the username.

Location targeting

Append _country-XX to your password, using an ISO 3166-1 alpha-2 country code. State and city targeting may be available depending on your account configuration.

  • _country-us targets the United States.
  • Available controls depend on your account and verification status.

Rotating sessions

Without a session parameter, requests can rotate through available residential IPs on each connection. This is the default behavior and is a good fit for high-volume public-data collection.

text
text
PASSWORD_country-us

Sticky sessions

To hold a residential identity across multiple requests, add a session identifier and an optional lifetime to the password.

text
text
PASSWORD_country-us_session-a1b2c3d4_lifetime-30m
  • _session-a1b2c3d4 creates or resolves a sticky session.
  • Session identifiers must contain exactly eight alphanumeric characters.
  • _lifetime-30m requests a 30-minute sticky lifetime.
  • Supported sticky lifetimes range from one second up to seven days.
  • Leaving out session parameters uses rotating behavior.
  • Exit-node availability can affect how long an individual residential IP remains online.

HTTP(S)

Helix residential proxies support HTTP and HTTPS over supported TCP connections. Point any HTTP-aware client at the gateway and authenticate with your Helix credentials.

SOCKS5

SOCKS5 is supported for clients that need protocol-level flexibility beyond HTTP. Use the same credential format as HTTP(S).

IP whitelisting

You can authorize trusted source IPs from the Helix dashboard. Whitelisted sources can connect without sending a password on each request.

Code examples

Generic examples using backend-configured placeholders. Replace HOST, PORT, USERNAME, and PASSWORD with the values shown in your dashboard.

cURL
bash
curl -x http://USERNAME:PASSWORD@HOST:PORT https://api.ipify.org
Node.js
ts
import fetch from "node-fetch";
import { HttpsProxyAgent } from "https-proxy-agent";

const agent = new HttpsProxyAgent(
  "http://USERNAME:PASSWORD@HOST:PORT"
);

const res = await fetch("https://api.ipify.org", { agent });
console.log(await res.text());
Python
py
import requests

proxies = {
  "http":  "http://USERNAME:PASSWORD@HOST:PORT",
  "https": "http://USERNAME:PASSWORD@HOST:PORT",
}
print(requests.get("https://api.ipify.org", proxies=proxies).text)

Domain restrictions

Certain sensitive domains may require additional verification or may not be available. Review the current Helix domain and usage restrictions before starting a new workflow.

View domain and usage restrictions →