Skip to main content
The EclipseProxy API is a small REST API for the operations you’d otherwise do in the dashboard, plus a dedicated Reseller API for managing sub-accounts.

​
Base URL

https://www.eclipseproxy.com

​
What you can do

Account endpoints (standard accounts):
  • Get / reset your API token: POST /api/user-api/auth
  • Check remaining Residential bandwidth: GET /api/user-api/bandwidth
  • Generate proxies in any format: GET /api/genProxy
Reseller API (reseller accounts):
  • Manage your bandwidth pool, create subusers, allocate bandwidth, and control per-subuser IP whitelists. See the Reseller overview.

​
Authentication

Most standard account endpoints require a Bearer token: 
Authorization: Bearer YOUR_API_TOKEN
Two exceptions: /api/user-api/auth (you send your credentials there to get a token) and /api/genProxy (a pure formatter — unauthenticated). The bandwidth endpoint requires the token. Get a token by POSTing your email and password to /api/user-api/auth. See Authentication. The Reseller API uses a separate reseller API key. See Reseller authentication.

​
Quick start

1

Get an API token

POST your credentials to /api/user-api/auth to receive a token.
2

Store the token

Save it as an environment variable. Calling the auth endpoint again invalidates the old token.
3

Call endpoints with the token

Include Authorization: Bearer YOUR_TOKEN on every other request.

​
Endpoint reference

Authentication

POST /api/user-api/auth: get or reset your API token

Bandwidth

GET /api/user-api/bandwidth: check remaining Residential GB

Generate proxies

GET /api/genProxy: generate proxies in a custom format

Reseller API

Manage bandwidth pools, subusers, and allocations

​
Important notes

  • /api/user-api/auth: get a token and reuse it. Calling this endpoint on every request invalidates your previous token unnecessarily.

​
What’s not exposed via API

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)
We may add more endpoints over time. If there’s something specific you’d like exposed, message support.

​
SDKs

No official SDKs currently: direct REST calls work in any language. The API is small enough that a thin wrapper in your own codebase is usually the right move.