User API overview
Three endpoints available to any account: a Bearer token, remaining Residential bandwidth, and bulk proxy generation
The User API covers the handful of things you'd otherwise do in the dashboard. It's available to every account — no reseller tier required.
For managing subusers and allocations, you want the Reseller API instead. It's a separate API with a separate credential.
Base URL
Authentication
Most endpoints authenticate with a Bearer token:
Get one by POSTing your account email and password to Get / reset API token. The token is invalidated each time you call that endpoint, so store it and reuse it.
Two endpoints are exceptions:
| Endpoint | Auth |
|---|---|
POST /api/user-api/auth | None — you send email and password to get a token |
GET /api/genProxy | None — pure formatter, nothing account-specific |
Response format
auth and bandwidth return JSON in a shared envelope:
status:"success"or"error"message: human-readable summarydata: the payload, ornull
genProxy is the exception — it returns plain text, one proxy per line.
Endpoints
Get / reset API token
POST /api/user-api/auth: exchange credentials for a Bearer token
Check remaining bandwidth
GET /api/user-api/bandwidth: remaining Residential MB
Generate proxies
GET /api/genProxy: expand a template into a formatted list
What isn't exposed
This is a small surface — most product management still happens in the dashboard:
- Buying bandwidth or plans (dashboard)
- IP whitelist management for your own account (dashboard)
- Resetting your proxy password (dashboard)
- ISP IP renewals (dashboard)
- Refund / replacement requests (website chat)
There are no official SDKs; direct REST calls work in any language, and the surface is small enough that a thin wrapper in your own codebase is usually the right move. If there's something specific you'd like exposed, message support.

