CrawlRelay proxy docs: quick start

How do I send my first request?

Copy the username and password from your dashboard, then run one of these. Each prints the IP address the website sees, which usually changes from one run to the next.

curl -x http://USERNAME-country-us:[email protected]:7777 https://api.ipify.org

import requests

proxy = "http://USERNAME-country-us:[email protected]:7777"
r = requests.get("https://api.ipify.org", proxies={"http": proxy, "https": proxy}, timeout=(10, 30))
print(r.text)

import { ProxyAgent, fetch } from "undici";

const dispatcher = new ProxyAgent("http://USERNAME-country-us:[email protected]:7777");
const res = await fetch("https://api.ipify.org", { dispatcher });
console.log(await res.text());

How do I build the username?

Start from the username in your dashboard and append parameters with hyphens, in the order of the format above. Every parameter is optional. Values are lowercase, and city names use underscores (new_york, sao_paulo). City availability varies.

How do rotating and sticky sessions behave?

A username without session- gets an IP from the pool on each new TCP connection, usually a different one. A username with session-<id>-ttl-<minutes> keeps the same exit IP for that ID until the TTL ends or the residential device goes offline.

• Rotation happens per connection, not per request: keep-alive reuses the same exit.
• Use a fresh session ID per job, per browser context or per account flow.
• Two scrapers that send the same session ID share one exit IP.

The sessions guide covers connection reuse in each library.

What are the limits?

• Blocked destinations: Banking, government and payment-portal sites, plus SMTP (email-sending) ports 25, 465 and 587. Requests to them are refused.
• Use: public data only, under the Acceptable Use Policy. No account takeover, fraud, spam or attempts to defeat a site's deliberate blocks.
• Traffic: billed per GB. Usage counts all data sent and received through the proxy (upload and download, headers included). 1 GB = 1,000,000,000 bytes. Connection attempts that fail before reaching the target are not counted. Requests stop when a plan's traffic runs out.
• Sessions: up to 30 minutes; the IP can change earlier, for example if its residential device goes offline.
• Protocols: HTTP, HTTPS (CONNECT) and SOCKS5.
• Concurrency: not billed. Your limit is what each target accepts; see the concurrency guide.

How do I manage credentials and usage?

In the dashboard, or through the REST API at https://crawlrelay.com/api/v1 with an API key. API keys you can revoke at any time. The main tasks:

• Sub-users: one set of credentials per scraper or client project, with an optional traffic cap. See residential API.
• IP allowlist: up to 10 IPs that can connect without a password.
• Usage: daily traffic per subscription, to alert before a crawl runs dry.
• Catalog: the countries, cities, states and ASNs you can target, so your code can validate a username before using it.
• Orders: buy more traffic from your balance without opening the dashboard. See orders API.