Documentation

Connection strings, client libraries, browser automation, the API, and how billing works underneath it. Everything past the dashboard's endpoint builder.

API

API reference

Authentication, conventions, errors, and every endpoint with examples in curl, Python, and Node.js.

Open reference

Getting started

Quickstart: making your first proxied request

Create a proxy credential, build the connection string, and send a request over HTTP or SOCKS5.

Read guide

Location targeting

Restrict a credential's exits to one US location with the _loc_<CODE> suffix, and the list of location codes.

Read guide

Rotating vs sticky sessions

How exit IPs are assigned per connection, when they change, and how the _sticky suffix keeps one for about 5 minutes.

Read guide

Integrations

Python

Proxy setup for requests and httpx over HTTP and SOCKS5.

Read guide

Node.js

Proxy setup for fetch with undici and for axios, over HTTP and SOCKS5.

Read guide

Browser automation

Proxy setup for Playwright and Puppeteer.

Read guide

Account & billing

Billing and data usage

How the data allowance is granted, metered, and reset, and how to add data, set caps, and get alerts.

Read guide

Organizations, users, and credentials

What a user account, an organization, a proxy credential, and an API key each control.

Read guide

Advanced

HTTP/3 and UDP

Send UDP traffic through HTTP/3 with the same credential.

Read guide