Use code GEN30 for 30% OFF your first order.

API Reference

A simple REST API to list, manage, and buy your proxies programmatically. Authenticate with an API key from your dashboard.

Get your API key

Authentication

Every request must include your API key in the x-api-key header. Create and revoke keys from Dashboard → API. Base URL:

https://proxygen.io/api/v1

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  https://proxygen.io/api/v1/proxies

Proxies

GET/proxies

List your proxy packages.

GET/proxies/{id}

Connection details (host, port, username, password).

GET/proxies/{id}/string

Ready-to-use connection string. Query: country, session=rotating|sticky, sessionId, sessionMins.

POST/proxies/{id}/rotate-password

Rotate the proxy password (username stays the same).

Account & usage

GET/account

Wallet balance & account status.

GET/usage

Per-package total / remaining / used GB.

GET/locations?type=residential

Supported countries for a proxy type.

Billing

GET/catalog

Available package sizes & prices.

POST/proxies

Buy a new package from wallet balance. Body: { type, gb, label? }.

POST/proxies/{id}/topup

Add GB to an existing package. Body: { gb }.

Example: list proxies

GET https://proxygen.io/api/v1/proxies

[
  {
    "id": "da9e2ddd-d3c0-4d69-a621-227734b3cccb",
    "code": "PKG-DA9E2DDD",
    "label": "Mobile 9 GB",
    "type": "mobile",
    "status": "active",
    "gbTotal": 9,
    "gbRemaining": 8.89,
    "createdAt": "2026-05-18T19:50:09.544Z"
  }
]

Errors & rate limits

Errors return a JSON body { "error": { "code", "message" } } with the matching HTTP status (401 invalid key, 402 insufficient balance, 403 email not verified, 404 not found, 429 rate limited). The API is rate limited per key; keep request volume reasonable and cache where possible.