Quick start

This guide keeps every value deployment-neutral. Replace the host, ports, package username, and password with the credentials issued for your environment.

Before you start

You need four values from the dashboard or onboarding record:

Value	Purpose
Proxy host	Gateway hostname assigned to the deployment
HTTP and SOCKS5 ports	Connection ports can differ by protocol
Package username	Base username for an active order or package
Proxy password	Secret used by the gateway, not your dashboard password

Do not expose the password

Run proxy requests from a backend, worker, automation host, or local development machine. Never ship the password in browser JavaScript, a mobile bundle, or a public repository.

Make a request

HTTP / HTTPS

curl --proxy \
  http://package-elite-country-us:[email protected]:8000 \
  https://api.ipify.org?format=json

An HTTP proxy also carries HTTPS targets through the CONNECT method. The target URL stays https://; the proxy URL stays http://.

SOCKS5h

curl --proxy \
  socks5h://package-elite-country-us:[email protected]:1080 \
  https://api.ipify.org?format=json

Prefer socks5h:// when the destination hostname must be resolved through the proxy path instead of the client network.

SAFE SANDBOX

Compose a proxy request

PLACEHOLDERS ONLY

Package usernameCountryRegionCityASNISPSession IDTTL, seconds

cURLCopy command

curl --proxy http://package-elite-country-us:[email protected]:8000 https://api.ipify.org?format=json

Keep credentials server-side.Never embed a proxy password in frontend code or a public repository.

Read the credential from left to right

1. Start with the package username, for example package-elite.
2. Append a country token such as country-us.
3. Add narrower targeting only when the use case requires it.
4. Add sid-{value} when several requests must try to reuse one exit session.
5. Add ttl-{seconds} only together with a session ID.

The complete pattern is:

{package}-country-{cc}-region-{region}-city-{city}-asn-{asn}-isp-{isp}-sid-{session}-ttl-{seconds}

Omit every token you do not use. A broader request usually has more eligible exits than a narrowly targeted request.

Verify the result

The test target should return a public exit IP. Run the same command twice and check:

• the request succeeds without a 407 Proxy Authentication Required response;
• the returned IP differs from the client machine;
• the country or network matches the requested targeting when inventory is available;
• a repeated sticky-session request behaves consistently enough for the application.

A session is a routing preference

A sticky token asks the gateway to reuse a compatible exit. Upstream availability, TTL expiry, or a targeting change can still require a new IP.

Continue the integration

• Learn the full targeting grammar.
• Choose between HTTP and SOCKS5.
• Understand sticky-session boundaries.
• For control-plane automation, start with API fundamentals.