Developer API

API Documentation

Endpoints to manage your Eclipse account!

API Endpoints

JSON

Response Format

REST

API Standard

POST/api/user-api/auth

Get / Reset API Key

Post your email and password to receive a fresh API token. This action INVALIDATES your previous token.

Request Example

curl -X POST https://www.eclipseproxy.com/api/user-api/auth \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your-password"
  }'

Response Example

{
  "status": "success",
  "message": "API token generated and previous token (if any) invalidated",
  "data": {
    "apiToken": "NEW_API_TOKEN"
  }
}

Important:

• Calling this endpoint resets your API token.
• Update any services that use the old token immediately.
• Store tokens securely and never share them publicly.
• Rate Limited: Maximum 1 request per 5 minutes per account and per IP address.

GET/api/user-api/bandwidth

Get Residential Bandwidth

Retrieve your remaining residential bandwidth.

Request Example

curl -X GET https://www.eclipseproxy.com/api/user-api/bandwidth \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response Example

{
  "status": "success",
  "message": "Bandwidth data retrieved successfully",
  "data": {
    "coreResidential": {
      "remaining": 5321.4,
      "unit": "MB",
      "asOf": "2025-10-08T00:00:00Z"
    },
    "residential": {
      "remaining": 100.3,
      "unit": "MB",
      "asOf": "2025-10-08T00:00:00Z"
    }
  }
}

Important:

• data.coreResidential is for all users.
• data.residential is for users who still have bandwidth on our legacy residential proxies system.

Quick Start

Get a new API key, then query your bandwidth.

Get / Reset API Key

POST your credentials to receive a fresh token.

POST /api/user-api/auth

Use the Token

Include it in the Authorization header.

Authorization: Bearer <YOUR_API_TOKEN>

Fetch Bandwidth

Call the bandwidth endpoint and parse data.coreResidential.

GET /api/user-api/bandwidth