Developers

Proxy reference

Gateway specification

Proxy parameters

The Crawlhub v1 gateway names, authentication format, targeting selectors and product rules.

Gateway and protocol

Protocol to the proxyPlanned endpointUse
HTTPproxy.crawlhub.ai:8000HTTP destinations and HTTPS CONNECT tunnels.
HTTPSproxy.crawlhub.ai:8443TLS connection to the proxy itself; the client must support it.
SOCKS5proxy.crawlhub.ai:1080SOCKS5 clients supported by the activated product. Chromium extensions do not support SOCKS5 password authentication.

Scroll horizontally to view all columns.

Username and password

The base login is ch-ACCOUNT_ID. Use the proxy account ID assigned at activation and its separate proxy password. The account token is case-sensitive and contains 1–64 letters, digits or underscores.

Username format
ch-ACCOUNT_ID-network-NETWORK[-PARAMETER-VALUE...]

Each option is a key/value pair separated by hyphens. Values cannot contain hyphens; multiword location values use underscores. Unknown keys, duplicate keys and unsupported combinations are rejected. The complete username is limited to 255 ASCII bytes so it fits SOCKS5 authentication as well as HTTP proxy login.

Parameter reference

ParameterScopeAccepted valueRule
networkRequiredresidential / isp / datacenterSelect the network; no billing-type default is inferred.
countryOptionalTwo lowercase letters, for example usSelect an available country. Inventory is validated by the activated service.
stateResidentialLowercase underscore slug, for example californiaRequires country.
cityResidentialLowercase underscore slug, for example los_angelesRequires country. Use the gateway location catalog when available.
zipResidentialLowercase letters, digits and underscoresRequires country. Preserve leading zeroes; use underscores for spaces or hyphens.
asnResidentialInteger 1–4294967295, without ASFilter available exits by autonomous system number.
sessionResidential1–64 letters, digits or underscoresUse the same ID for related connections. Omit for rotating selection.
ttlResidential60–3600 seconds; default 600Requires session. This is a maximum requested session lifetime.
ipISP / DatacenterAssigned allocation ID, for example ip_01Select an IP assignment owned by this proxy account. Not an arbitrary destination address.

Scroll horizontally to view all columns.

Parameters by network

NetworkAvailable v1 selectorsSession behavior
Residentialcountry, state, city, zip, asn, session, ttlWithout session: select an exit for each new upstream connection or CONNECT tunnel.
ISPcountry, ipUse a fixed assigned IP; residential session selectors are not accepted.
Datacentercountry, ipUse a fixed assigned IP; residential session selectors are not accepted.

Scroll horizontally to view all columns.

When both country and ip are supplied, the activated gateway must verify that the owned allocation matches that country. A syntactically valid selector does not guarantee available inventory.

Configuration examples

Residential city and sticky session
ch-ACCOUNT_ID-network-residential-country-us-city-los_angeles-session-job01-ttl-600
ISP allocation
ch-ACCOUNT_ID-network-isp-country-de-ip-ip_01
Datacenter allocation
ch-ACCOUNT_ID-network-datacenter-ip-ip_02

These names show the v1 contract. Replace the proxy account ID and assignment values with activated account details.

Validate or generate a username

Download the username formatter and parser · Read the JSON Schema

Generate a v1 username
import { formatProxyUsername } from './proxy_username.mjs';

console.log(formatProxyUsername({
  account: 'ACCOUNT_ID',
  network: 'residential',
  country: 'us',
  city: 'los_angeles',
  session: 'job01',
  ttl: 600,
}));

The formatter validates syntax and option combinations. It does not authenticate the account, activate an endpoint, check ownership or validate inventory.

Use the values in your client

Keep raw username and password values in separate client fields. URL-encode credentials only when constructing a proxy URL. Do not pre-encode a password for an ordinary password input. An HTTPS destination does not require an HTTPS proxy transport.

Choose a client integration · Read location and session rules

Search documentation

Search guides, products and reference pages.